1. 接口描述
接口请求域名： cdwpg.tencentcloudapi.com 。
根据实例ID查询某个实例的具体信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群实例ID 示例值：cdwpg-12345678 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceInfo | InstanceInfo | 实例描述信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 描述实例信息
根据实例ID查询某个实例的具体信息
输入示例
POST / HTTP/1.1
Host: cdwpg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstance
<公共请求参数>
{
"InstanceId": "cdwpg-xdx"
}输出示例
{
"Response": {
"InstanceInfo": {
"ID": 20230915001,
"InstanceType": "cdwpg-cn",
"InstanceName": "analytics-prod-01",
"Status": "Serving",
"StatusDesc": "服务中",
"InstanceStateInfo": {
"InstanceState": "Serving",
"FlowCreateTime": "2023-09-15 09:30:00",
"FlowName": "ClusterScaleOut",
"FlowProgress": 75,
"InstanceStateDesc": "集群扩容中",
"FlowMsg": "正在添加3个计算节点",
"ProcessName": "资源扩容中",
"BackupStatus": 0,
"RequestId": "req-5f82b735",
"BackupOpenStatus": 1
},
"InstanceID": "inst-9d7e2f4a",
"CreateTime": "2023-01-15 14:20:00",
"Region": "ap-shanghai",
"Zone": "ap-shanghai-2",
"RegionDesc": "上海地域",
"ZoneDesc": "上海二区",
"Tags": [
{
"TagKey": "Environment",
"TagValue": "Production"
},
{
"TagKey": "Department",
"TagValue": "DataAnalytics"
}
],
"Version": "v3.2.1",
"Charset": "UTF-8",
"CNNodes": [
{
"SpecName": "CN8x32",
"DataDisk": {
"DiskCount": 2,
"MaxDiskSize": 2048,
"MinDiskSize": 512,
"DiskType": "Cloud_SSD",
"DiskDesc": "高性能云盘",
"CvmClass": "S5.MEDIUM8"
},
"CvmCount": 3
}
],
"DNNodes": [
{
"SpecName": "DN4x64",
"DataDisk": {
"DiskCount": 4,
"MaxDiskSize": 4096,
"MinDiskSize": 1024,
"DiskType": "Cloud_Premium",
"DiskDesc": "企业级云盘",
"CvmClass": "S5.LARGE16"
},
"CvmCount": 2
}
],
"RegionId": 21,
"ZoneId": 210002,
"VpcId": "vpc-89f2d1e3",
"SubnetId": "subnet-45c9b2f1",
"ExpireTime": "2025-12-31 23:59:59",
"PayMode": "PrePaid",
"RenewFlag": true,
"InstanceId": "cluster-9a8b7c6d",
"AccessDetails": [
{
"Address": "10.16.32.45:3306",
"Protocol": "MySQL"
}
]
},
"RequestId": "xdsx"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
