消息队列 CKafka 版获取实例列表信息-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： ckafka.tencentcloudapi.com 。

本接口（DescribeInstance）用于在用户账户下获取消息队列 CKafka 实例列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstances。
Version	是	String	公共参数，本接口取值：2019-08-19。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	否	String	（查询条件）按照ckafka集群实例Id过滤示例值：ckafka-test
SearchWord	否	String	搜索词 ex:（查询条件）按照实例名称过滤，支持模糊查询示例值：search-test
Status.N	否	Array of Integer	（查询条件）实例的状态 0：创建中，1：运行中，2：删除中，5: 隔离中, 7:升级中不填默认返回全部示例值：[1,7]
Offset	否	Integer	偏移量，不填默认为0 示例值：0
Limit	否	Integer	返回数量，不填则默认10，最大值100 示例值：10
TagKey	否	String	已废弃。匹配标签key值。示例值：tagkey-test
VpcId	否	String	（查询条件）私有网络Id 示例值：vpc-test

3. 输出参数

参数名称	类型	描述
Result	InstanceResponse	返回的结果示例值：{"InstanceList":[{"IfCommunity":true,"InstanceId":"ckafka-test","InstanceName":"ckafka测试","Status":1}],"TotalCount":1}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实例列表

输入示例

https://ckafka.tencentcloudapi.com/?Action=DescribeInstances
&InstanceId=instance-will-s
&SearchWord=tre
&Offset=0
&Limit=10
&Status.0=0
&Status.1=1
&Status.2=2
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "InstanceList": [
                {
                    "InstanceId": "instance-will-s",
                    "InstanceName": "treTest",
                    "IfCommunity": true,
                    "Status": 1
                }
            ]
        },
        "RequestId": "31740399-5d06-404b-a4b5-3652e21c8a1d"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.InstanceNotExist	实例不存在。
InvalidParameterValue.RepetitionValue	已存在相同参数。
InvalidParameterValue.WrongAction	Action参数取值错误。
ResourceUnavailable	资源不可用。
UnauthorizedOperation	未授权操作。
UnsupportedOperation	操作不支持。
UnsupportedOperation.BatchDelInstanceLimit	批量删除实例限制。
UnsupportedOperation.OssReject	Oss拒绝该操作。

获取实例列表信息

本页目录：