1. 接口描述
接口请求域名： ckafka.api3.fincloud.tencent.com。
本接口（DescribeInstance）用于在用户账户下获取消息队列 CKafka 实例列表
默认接口请求频率限制：20次/秒。
接口更新时间：2019-12-19 11:23:20。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-08-19 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 否 | 否 | String | （过滤条件）按照实例ID过滤 示例值： ckafka-test |
| SearchWord | 否 | 否 | String | （过滤条件）按照实例名称过滤，支持模糊查询 示例值： search-test |
| Status | 否 | 否 | Array of Int64 | （过滤条件）实例的状态。0：创建中，1：运行中，2：删除中，不填默认返回全部 示例值： [1,7] |
| Offset | 否 | 否 | Int64 | 偏移量，不填默认为0 示例值： 0 |
| Limit | 否 | 否 | Int64 | 返回数量，不填则默认10，最大值20 示例值： 10 |
| TagKey | 否 | 否 | String | 匹配标签key值。 示例值： tagkey-test |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | InstanceResponse | 返回的结果 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
| InvalidParameterValue.WrongAction | Action参数取值错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation.OssReject | Oss拒绝该操作 |
| UnsupportedOperation.BatchDelInstanceLimit | 批量删除实例限制 |
| InternalError | 内部错误。 |
| ResourceUnavailable | 资源不可用。 |