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过滤 示例值：instance-will-s |
| SearchWord | 否 | String | （过滤条件）按照实例名,实例Id,可用区,私有网络id,子网id 过滤，支持模糊查询 示例值：tre |
| Status.N | 否 | Array of Integer | （过滤条件）实例的状态。0：创建中，1：运行中，2：删除中，不填默认返回全部 示例值：["0\r\n","1\r\n","2\r\n"] |
| 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个值. |
| InstanceIds | 否 | String | 已经废弃， 使用InstanceIdList 示例值：[instance-will-s] |
| InstanceIdList.N | 否 | Array of String | 按照实例ID过滤 示例值：[instance-will-s] |
| TagList.N | 否 | Array of Tag | 根据标签列表过滤实例（取交集） |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | InstanceDetailResponse | 返回的实例详情结果对象 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取实例列表详情
输入示例
https://ckafka.tencentcloudapi.com/?Action=DescribeInstancesDetail
&InstanceId=instance-will-s
&SearchWord=tre
&Offset=0
&Limit=10
&Status.0=0
&Status.1=1
&Status.2=2
&<公共请求参数>输出示例
{
"Response": {
"Result": {
"TotalCount": 0,
"InstanceList": [
{
"InstanceId": "abc",
"InstanceName": "abc",
"Vip": "abc",
"Vport": "abc",
"VipList": [
{
"Vip": "abc",
"Vport": "abc"
}
],
"Status": 0,
"Bandwidth": 0,
"DiskSize": 0,
"ZoneId": 0,
"VpcId": "abc",
"SubnetId": "abc",
"RenewFlag": 0,
"Healthy": 0,
"HealthyMessage": "abc",
"CreateTime": 0,
"ExpireTime": 0,
"IsInternal": 0,
"TopicNum": 0,
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"Version": "abc",
"ZoneIds": [
0
],
"Cvm": 0,
"InstanceType": "abc",
"DiskType": "abc",
"MaxTopicNumber": 0,
"MaxPartitionNumber": 0,
"RebalanceTime": "abc",
"PartitionNumber": 1,
"PublicNetworkChargeType": "abc",
"PublicNetwork": 0,
"ClusterType": "abc",
"Features": [
"abc"
]
}
]
},
"RequestId": "abc"
}
}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拒绝该操作。 |
