1. 接口描述
接口请求域名： cdwpg.tencentcloudapi.com 。
获取云原生实例列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SearchInstanceId | 否 | String | 用集群id搜索 示例值：cdwpg-xxxx |
| SearchInstanceName | 否 | String | 用集群名字搜索 示例值：cdwpg_test |
| Offset | 否 | Integer | 分页参数，第一页为0，第二页为10 示例值：0 |
| Limit | 否 | Integer | 分页参数，分页步长，默认为10 示例值：20 |
| SearchTags.N | 否 | Array of SearchTags | 搜索标签列表 示例值：[{"TagKey":"k1","TagValue":"v1","AllValue":1}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 实例总数 示例值：2 |
| InstancesList | Array of InstanceInfo | 实例数组 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"InstanceId":"cdwpg-rzshdeh1","InstanceName":"hugogao_test",..."ZoneId":190001},{"InstanceId":"cdwpg-rzshdfds","InstanceName":"hugogao_test1",..."ZoneId":190001}] |
| ErrorMsg | String | 错误信息 示例值：Error:... |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询云原生实例列表
输入示例
POST / HTTP/1.1
Host: cdwpg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>
{}输出示例
{
"Response": {
"ErrorMsg": "",
"InstancesList": [
{
"AccessDetails": [
{
"Address": "10.0.16.19:9000",
"Protocol": "tcp"
}
],
"CNNodes": [
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 1,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 32000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_H_CN"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 1,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 32000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_H_CN"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 1,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 32000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_H_CN"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 1,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 32000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_H_CN"
}
],
"Charset": "UTF8",
"CreateTime": "2025-03-19 16:37:38",
"DNNodes": [
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 10,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_H"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 10,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_H"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 10,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_H"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 10,
"DiskDesc": "增强型SSD云硬盘",
"DiskType": "CLOUD_HSSD",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_H"
}
],
"ExpireTime": "0000.00.00 00:00:00",
"ID": 1094,
"InstanceId": "cdwpg-rzshdeh1",
"InstanceName": "hugogao_test",
"InstanceStateInfo": {
"BackupOpenStatus": 0,
"BackupStatus": 0,
"FlowCreateTime": "",
"FlowMsg": "",
"FlowName": "",
"FlowProgress": 0,
"InstanceState": "Serving",
"InstanceStateDesc": "运行中",
"ProcessName": "",
"RequestId": ""
},
"InstanceType": "TbaseV3",
"PayMode": "POSTPAID_BY_HOUR",
"Region": "ap-chongqing",
"RegionDesc": "重庆",
"RegionId": 19,
"RenewFlag": false,
"Status": "Serving",
"StatusDesc": "运行中",
"SubnetId": "subnet-rdlodajk",
"Tags": [],
"Version": "3.16.9.4",
"VpcId": "vpc-1asw4o73",
"Zone": "ap-chongqing-1",
"ZoneDesc": "重庆一区",
"ZoneId": 190001
},
{
"AccessDetails": [
{
"Address": "10.0.16.27:9000",
"Protocol": "tcp"
}
],
"CNNodes": [
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 1,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 32000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_P_CN"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 1,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 32000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_P_CN"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 1,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 32000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_P_CN"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 1,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 32000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_P_CN"
}
],
"Charset": "UTF8",
"CreateTime": "2025-02-20 11:37:11",
"DNNodes": [
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 10,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_P"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 10,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_P"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 10,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_P"
},
{
"CvmCount": 2,
"DataDisk": {
"CvmClass": "STANDARD",
"DiskCount": 10,
"DiskDesc": "高性能云硬盘",
"DiskType": "CLOUD_PREMIUM",
"MaxDiskSize": 320000,
"MinDiskSize": 200
},
"SpecName": "S_4_16_P"
}
],
"ExpireTime": "0000.00.00 00:00:00",
"ID": 1089,
"InstanceId": "cdwpg-9jcyk7yp",
"InstanceName": "demo_tim",
"InstanceStateInfo": {
"BackupOpenStatus": 1,
"BackupStatus": 0,
"FlowCreateTime": "",
"FlowMsg": "",
"FlowName": "",
"FlowProgress": 0,
"InstanceState": "Serving",
"InstanceStateDesc": "运行中",
"ProcessName": "",
"RequestId": ""
},
"InstanceType": "TbaseV3",
"PayMode": "POSTPAID_BY_HOUR",
"Region": "ap-chongqing",
"RegionDesc": "重庆",
"RegionId": 19,
"RenewFlag": false,
"Status": "Serving",
"StatusDesc": "运行中",
"SubnetId": "subnet-rdlodajk",
"Tags": [],
"Version": "3.16.9.4",
"VpcId": "vpc-1asw4o73",
"Zone": "ap-chongqing-1",
"ZoneDesc": "重庆一区",
"ZoneId": 190001
}
],
"RequestId": "4ce96c66-e75b-4ec2-aa3c-06594ea15916",
"TotalCount": 2
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
