1. 接口描述
接口请求域名： cdwch.tencentcloudapi.com 。
根据实例ID查询某个实例的具体信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2020-09-15。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群实例ID 示例值：cdwch-12345678 |
| IsOpenApi | 否 | Boolean | 是否是open api查询 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceInfo | InstanceInfo | 实例描述信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 描述实例信息
根据实例ID查询某个实例的具体信息
输入示例
https://cdwch.tencentcloudapi.com/?Action=DescribeInstance
&InstanceId=cdwch-12345678
&<公共请求参数>输出示例
{
"Response": {
"InstanceInfo": {
"InstanceId": "cdwch-xxxxxxxx",
"InstanceName": "测试集群",
"Status": "Serving",
"Version": "23.8.9.1",
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-1",
"VpcId": "vpc-xxxxxxxx",
"SubnetId": "subnet-xxxxxxxx",
"PayMode": "PREPAID",
"CreateTime": "2025-02-28 11:34:45",
"ExpireTime": "2025-03-28 11:34:46",
"MasterSummary": {
"Spec": "H_32_128",
"NodeSize": 1,
"Core": 32,
"Memory": 128,
"Disk": 7140,
"DiskType": "LOCAL_BASIC",
"DiskDesc": "本地盘",
"AttachCBSSpec": {
"DiskType": "",
"DiskSize": 0,
"DiskCount": 0,
"DiskDesc": ""
},
"SubProductType": "HIGHIO",
"SpecCore": 32,
"SpecMemory": 128,
"DiskCount": 2,
"MaxDiskSize": 7140,
"Encrypt": 0
},
"CommonSummary": {
"Spec": "S_2_4_P",
"NodeSize": 3,
"Core": 2,
"Memory": 4,
"Disk": 100,
"DiskType": "CLOUD_PREMIUM",
"DiskDesc": "高性能云盘",
"AttachCBSSpec": {
"DiskType": "",
"DiskSize": 0,
"DiskCount": 0,
"DiskDesc": ""
},
"SubProductType": "STANDARD",
"SpecCore": 2,
"SpecMemory": 4,
"DiskCount": 1,
"MaxDiskSize": 32000,
"Encrypt": 0
},
"HA": "false",
"AccessInfo": "[{\"address\":\"10.x.x.xx:9000\",\"protocol\":\"tcp\",\"address_public\":\"\"},{\"address\":\"10.x.x.xx:8123\",\"protocol\":\"http\",\"address_public\":\"\"},{\"address\":\"10.x.x.xx:9004\",\"protocol\":\"mysql_tcp\",\"address_public\":\"\"}]",
"Id": 3857,
"RegionId": 1,
"ZoneDesc": "广州一区",
"FlowMsg": "",
"StatusDesc": "运行中",
"RenewFlag": true,
"Tags": [
{
"TagKey": "产品名称",
"TagValue": "cdwch"
}
],
"Monitor": "",
"HasClsTopic": false,
"ClsTopicId": "",
"ClsLogSetId": "",
"EnableXMLConfig": 0,
"RegionDesc": "广州",
"Eip": "",
"CosMoveFactor": 0,
"Kind": "external",
"IsElastic": true,
"InstanceStateInfo": {
"InstanceState": "",
"FlowCreateTime": "",
"FlowName": "",
"FlowProgress": 0,
"InstanceStateDesc": "",
"FlowMsg": "",
"ProcessName": "",
"RequestId": ""
},
"HAZk": true,
"MountDiskType": 0,
"CHProxyVip": "",
"CosBucketName": "",
"CanAttachCbs": true,
"CanAttachCbsLvm": true,
"CanAttachCos": true,
"Components": [],
"UpgradeVersions": ""
},
"RequestId": "asdfaes-xad12x-123axafg"
}
}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: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
