添加链接
link之家
链接快照平台
  • 输入网页链接,自动生成快照
  • 标签化管理网页链接

4. 示例

示例1 查询ES集群实例

输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "InstanceList": [
                "InstanceId": "es-7sy7efoi",
                "InstanceName": "_some_name_",
                "InstanceType": 2,
                "Region": "ap-guangzhou",
                "Zone": "ap-guangzhou-3",
                "AppId": 130000000,
                "Uin": "100000000",
                "VpcUid": "vpc-xxxxxx",
                "SubnetUid": "subnet-xxxxxx",
                "Status": 1,
                "ChargeType": "POSTPAID_BY_HOUR",
                "ChargePeriod": 0,
                "RenewFlag": "",
                "NodeInfoList": [
                        "Type": "hotData",
                        "NodeNum": 3,
                        "NodeType": "ES.SA2.MEDIUM4",
                        "DiskType": "CLOUD_SSD",
                        "DiskSize": 20,
                        "DiskEncrypt": 0,
                        "DiskCount": 1,
                        "LocalDiskInfo": null
                "NodeType": "ES.SA2.MEDIUM4",
                "NodeNum": 3,
                "CpuNum": 2,
                "MemSize": 4,
                "DiskType": "CLOUD_SSD",
                "AutoIndexEnabled": true,
                "DiskSize": 20,
                "EnableHotWarmMode": false,
                "WarmNodeType": "",
                "WarmNodeNum": 0,
                "WarmCpuNum": 0,
                "WarmMemSize": 0,
                "WarmDiskType": "",
                "WarmDiskSize": 0,
                "ColdNodeType": "",
                "ColdNodeNum": 0,
                "ColdCpuNum": 0,
                "ColdMemSize": 0,
                "ColdDiskType": "",
                "ColdDiskSize": 0,
                "FrozenNodeType": "",
                "FrozenNodeNum": 0,
                "FrozenCpuNum": 0,
                "FrozenMemSize": 0,
                "FrozenDiskType": "",
                "FrozenDiskSize": 0,
                "MasterNodeInfo": {
                    "EnableDedicatedMaster": false,
                    "MasterNodeType": "",
                    "MasterNodeNum": 0,
                    "MasterNodeCpuNum": 0,
                    "MasterNodeMemSize": 0,
                    "MasterNodeDiskType": "",
                    "MasterNodeDiskSize": 0
                "KibanaNodeInfo": {
                    "KibanaNodeType": "ES.SA2.SMALL2",
                    "KibanaNodeNum": 1,
                    "KibanaNodeCpuNum": 1,
                    "KibanaNodeMemSize": 2,
                    "KibanaNodeDiskType": "CLOUD_PREMIUM",
                    "KibanaNodeDiskSize": 50
                "EsDomain": "es-7sy7efoi.myelasticsearch.com",
                "EsPrivateDomain": "es-7sy7efoi-esinternal.kibana.myelasticsearch.com",
                "EsVip": "{vip}",
                "EsPort": 9200,
                "KibanaUrl": "https://es-7sy7efoi.kibana.myelasticsearch.com:5601",
                "KibanaPrivateUrl": "",
                "PublicAccess": "CLOSE",
                "KibanaPublicAccess": "OPEN",
                "KibanaPrivateAccess": "CLOSE",
                "KibanaAlteringPublicAccess": "CLOSE",
                "Protocol": "",
                "SecurityGroups": [],
                "EsPublicUrl": "",
                "EsPrivateUrl": "https://es-7sy7efoi-esinternal.kibana.myelasticsearch.com:9200",
                "EsVersion": "7.14.2",
                "EsConfig": "{}",
                "EsConfigSets": [],
                "KibanaConfig": "",
                "EsAcl": {
                    "WhiteIpList": [
                        "127.0.0.1"
                    "BlackIpList": []
                "EsPublicAcl": {
                    "WhiteIpList": [],
                    "BlackIpList": []
                "IkConfig": {
                    "UpdateType": "",
                    "MainDict": [],
                    "Stopwords": [],
                    "Synonym": [],
                    "QQDict": []
                "AllowCosBackup": true,
                "CosBackup": {
                    "IsAutoBackup": false,
                    "BackupTime": ""
                "DeployMode": 0,
                "MultiZoneInfo": [
                        "Zone": "ap-guangzhou-3",
                        "SubnetId": "subnet-q29llw8g"
                "TagList": [],
                "HealthStatus": 0,
                "SecurityType": 2,
                "LicenseType": "platinum",
                "SceneType": 1,
                "Jdk": "kona",
                "WebNodeTypeInfo": {
                    "NodeNum": 1,
                    "NodeType": "ES.SA2.SMALL2"
                "CreateTime": "2022-07-06 20:52:48",
                "UpdateTime": "2022-07-07 17:35:29",
                "Deadline": "2017-12-04 00:00:00",
                "OperationDuration": null,
                "OptionalWebServiceInfos": [
                        "Status": 0,
                        "PrivateAccess": "xx",
                        "PublicAccess": "xx",
                        "PrivateUrl": "xx",
                        "Version": "xx",
                        "Type": "xx",
                        "PublicUrl": "xx"
                "ProcessPercent": 0.5,
                "EnableHybridStorage": true
        "RequestId": "xxxx"

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

  • Tencent Cloud SDK 3.0 for Python
  • Tencent Cloud SDK 3.0 for Java
  • Tencent Cloud SDK 3.0 for PHP
  • Tencent Cloud SDK 3.0 for Go
  • Tencent Cloud SDK 3.0 for NodeJS
  • Tencent Cloud SDK 3.0 for .NET
  • Tencent Cloud SDK 3.0 for C++
  • Tencent Cloud SDK 3.0 for Ruby
  • 命令行工具

    • Tencent Cloud CLI 3.0
    • 6. 错误码

      以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

      AuthFailure.UnAuthorizedOperation 操作未授权。 InternalError 内部错误。 InvalidParameter 参数错误。 UnsupportedOperation 操作不支持。