1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
用户账户下获取实例列表详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstancesDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 否 | String | （过滤条件）按照实例ID过滤 示例值：ckafka-test |
| SearchWord | 否 | String | （过滤条件）按照实例名,实例Id,可用区,私有网络id,子网id 过滤，支持模糊查询 示例值：search-test |
| Status.N | 否 | Array of Integer | （过滤条件）实例的状态。0：创建中，1：运行中，2：删除中，不填默认返回全部 示例值：[1,5] |
| Offset | 否 | Integer | 偏移量，不填默认为0。 示例值：0 |
| Limit | 否 | Integer | 返回数量，不填则默认10，最大值20。 示例值：10 |
| TagKey | 否 | String | 匹配标签key值。 示例值：1 |
| Filters.N | 否 | Array of Filter | 过滤器。filter.Name 支持('Ip', 'VpcId', 'SubNetId', 'InstanceType','InstanceId') ,filter.Values最多传递10个值. 示例值：[{"Name":"filtername-test","TagValue":["filtervalue-test"]}] |
| InstanceIds | 否 | String | 已经废弃， 使用InstanceIdList 示例值：["ckafka-test"] |
| InstanceIdList.N | 否 | Array of String | 按照实例ID过滤 示例值：["ckafka-test"] |
| TagList.N | 否 | Array of Tag | 根据标签列表过滤实例（取交集） 示例值：[{"TagKey":"tagkey-test","TagValue":"tagvalue-test"}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | InstanceDetailResponse | 返回的实例详情结果对象 示例值：{"TotalCount":1,"InstanceList":[{"InstanceId":"ckafka-test","InstanceName":"ckafka-test","Vip":"10.0.0.5","Vport":"9092","VipList":[{"Vip":"10.0.0.5","Vport":"9092"}],"Status":1,"Bandwidth":320,"DiskSize":500,"ZoneId":100004,"VpcId":"vpc-test","SubnetId":"subnet-test","RenewFlag":1,"Healthy":0,"HealthyMessage":"healthymessage-test","CreateTime":1566144000,"ExpireTime":1566144000,"IsInternal":0,"TopicNum":2,"Tags":[{"TagKey":"tagkey-test","TagValue":"tagvalue-test"}],"Version":"1.1.1","ZoneIds":[100004],"Cvm":0,"InstanceType":"profession","DiskType":"CLOUD_SSD","MaxTopicNumber":250,"MaxPartitionNumber":500,"RebalanceTime":"1566144000","PartitionNumber":1,"PublicNetworkChargeType":"BANDWIDTH_PREPAID","PublicNetwork":0,"ClusterType":"CLOUD_CVM","Features":["features-test"],"RebalanceDeadLineTimeStamp":"1566144000","AllowDowngrade":true,"StorageBillingType":"BILL_BY_QUANTITY","FreePartitionNumber":0}]} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取实例列表详情
输入示例
https://ckafka.tencentcloudapi.com/?Action=DescribeInstancesDetail
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "84b84177-c5aa-4fa9-aae0-14618af7d251",
"Result": {
"InstanceList": [
{
"Bandwidth": 800,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1732245392,
"Cvm": 1,
"DiskSize": 1000,
"DiskType": "CLOUD_SSD",
"ExpireTime": 1734837392,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-wdvgwwx2",
"InstanceName": "test-public-network",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 1200,
"MaxTopicNumber": 600,
"PartitionNumber": 60,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_PREPAID",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 6,
"Version": "2.8.1",
"Vip": "10.0.1.17",
"VipList": [
{
"Vip": "10.0.1.17",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": [
100006,
100007
]
},
{
"Bandwidth": 19200,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1732086196,
"Cvm": 1,
"DiskSize": -1,
"DiskType": "CLOUD_SSD",
"ExpireTime": 0,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-vv7wpp93",
"InstanceName": "wenbingshen-测试",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 5000,
"MaxTopicNumber": 2500,
"PartitionNumber": 46,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 3,
"Version": "2.8.1",
"Vip": "10.0.1.31",
"VipList": [
{
"Vip": "10.0.1.31",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": [
100006,
100007
]
},
{
"Bandwidth": 160,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1731479434,
"Cvm": 1,
"DiskSize": 200,
"DiskType": "CLOUD_SSD",
"ExpireTime": 1734071434,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-bzmjpp4z",
"InstanceName": "Reserved_hdq_0.6_2.8",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 400,
"MaxTopicNumber": 200,
"PartitionNumber": 18,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_PREPAID",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 3,
"Version": "2.8.1",
"Vip": "10.0.1.3",
"VipList": [
{
"Vip": "10.0.1.3",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": []
},
{
"Bandwidth": 160,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1724071025,
"Cvm": 1,
"DiskSize": 200,
"DiskType": "CLOUD_SSD",
"ExpireTime": 1734611825,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-mon24787",
"InstanceName": "carwyn-测试 勿删",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 400,
"MaxTopicNumber": 200,
"PartitionNumber": 26,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_PREPAID",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 1,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 5,
"Version": "1.1.1",
"Vip": "10.0.1.29",
"VipList": [
{
"Vip": "10.0.1.29",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": [
100006,
100007
]
},
{
"Bandwidth": 1600,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1722481364,
"Cvm": 1,
"DiskSize": 1000,
"DiskType": "CLOUD_SSD",
"ExpireTime": 0,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "",
"InstanceId": "ckafka-5k7va2bv",
"InstanceName": "shilinlu-test-勿动",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 1400,
"MaxTopicNumber": 700,
"PartitionNumber": 72,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 5,
"Version": "2.8.1",
"Vip": "10.0.1.40",
"VipList": [
{
"Vip": "10.0.1.40",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": [
100006,
100007
]
},
{
"Bandwidth": 3200,
"ClusterType": "CLOUD_CVM",
"CreateTime": 1716451701,
"Cvm": 1,
"DiskSize": 3000,
"DiskType": "CLOUD_SSD",
"ExpireTime": 0,
"Features": [
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "healthy",
"InstanceId": "ckafka-na37x9qa",
"InstanceName": "shilinlu-exporter 测试",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 2000,
"MaxTopicNumber": 1000,
"PartitionNumber": 22,
"PublicNetwork": 3,
"PublicNetworkChargeType": "BANDWIDTH_POSTPAID_BY_HOUR",
"RebalanceTime": "0000-00-00 00:00:00",
"RenewFlag": 0,
"Status": 1,
"SubnetId": "subnet-5rhipsse",
"Tags": [],
"TopicNum": 2,
"Version": "2.4.1",
"Vip": "10.0.1.25",
"VipList": [
{
"Vip": "10.0.1.25",
"Vport": "9092"
}
],
"VpcId": "vpc-ks7w9y0b",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": []
},
{
"Bandwidth": 1200,
"ClusterType": "CLOUD_EKS_TSE",
"CreateTime": 1667461825,
"Cvm": 1,
"DiskSize": 1000,
"DiskType": "CLOUD_BASIC",
"ExpireTime": 1735890625,
"Features": [
"CLOUD_EKS_TSE",
"CLOUD_EKS_CROS_ZONE",
"FEATURE_SASL_SCRAM"
],
"Healthy": 1,
"HealthyMessage": "healthy",
"InstanceId": "ckafka-pkwxedpq",
"InstanceName": "【勿删-不要再新建公网域名了，会产生安全工单】spock-test",
"InstanceType": "profession",
"IsInternal": 0,
"MaxPartitionNumber": 1200,
"MaxTopicNumber": 600,
"PartitionNumber": 1026,
"PublicNetwork": 6,
"PublicNetworkChargeType": "BANDWIDTH_PREPAID",
"RebalanceTime": "2023-07-04 10:30:58",
"RenewFlag": 1,
"Status": 1,
"SubnetId": "subnet-kg07707y",
"Tags": [
{
"TagKey": "Application",
"TagValue": "underlay-domain"
},
{
"TagKey": "tagkey",
"TagValue": "555555"
}
],
"TopicNum": 61,
"Version": "2.4.1",
"Vip": "172.16.0.17",
"VipList": [
{
"Vip": "172.16.0.17",
"Vport": "9092"
}
],
"VpcId": "vpc-apwrtw01",
"Vport": "9092",
"ZoneId": 100006,
"ZoneIds": [
100006,
100007
]
}
],
"TotalCount": 7
}
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
| InvalidParameterValue.SubnetIdInvalid | 无效的子网id。 |
| InvalidParameterValue.SubnetNotBelongToZone | 子网不属于zone。 |
| InvalidParameterValue.VpcIdInvalid | 无效的 Vpc Id。 |
| InvalidParameterValue.WrongAction | Action参数取值错误。 |
| InvalidParameterValue.ZoneNotSupport | zone不支持。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BatchDelInstanceLimit | 批量删除实例限制。 |
| UnsupportedOperation.OssReject | Oss拒绝该操作。 |
