1. 接口描述
接口请求域名： trocket.tencentcloudapi.com 。
获取实例列表，Filters参数使用说明如下：
- InstanceName, 名称模糊查询
- InstanceId，实例ID查询
- InstanceType, 实例类型查询，支持多选
- InstanceStatus，实例状态查询，支持多选
当使用TagFilters查询时，Filters参数失效。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMQTTInstanceList。 |
| Version | 是 | String | 公共参数，本接口取值：2023-03-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 查询条件列表 |
| Offset | 否 | Integer | 查询起始位置 示例值：0 |
| Limit | 否 | Integer | 查询结果限制数量 示例值：10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 查询总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| Data | Array of MQTTInstanceItem | 实例列表 示例值：[ { "ClientNumLimit": 1, "CreateTime": 1705565760, "InstanceId": "mqtt-wjgxr8jg", "InstanceName": "su-0118-no-pub", "InstanceStatus": "CREATE_FAILURE", "InstanceType": "BASIC", "Remark": "", "SkuCode": "mqtt_1k", "SubscriptionNumLimit": 1, "TopicNum": 0, "TopicNumLimit": 1, "TpsLimit": 1, "Version": "1" }, { "ClientNumLimit": 1000, "CreateTime": 1705391046, "InstanceId": "mqtt-47ka4rdr", "InstanceName": "sun-0116", "InstanceStatus": "RUNNING", "InstanceType": "BASIC", "Remark": "", "SkuCode": "basic_1k", "SubscriptionNumLimit": 1000, "TopicNum": 25, "TopicNumLimit": 25, "TpsLimit": 1000, "Version": "1" } ] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMQTTInstanceList
<公共请求参数>
{
"Offset": 0,
"Limit": 10
}输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"Data": [
{
"ClientNumLimit": 1,
"CreateTime": 1705565760,
"InstanceId": "mqtt-wjgxr8jg",
"InstanceName": "su-0118-no-pub",
"InstanceStatus": "CREATE_FAILURE",
"InstanceType": "BASIC",
"Remark": "",
"SkuCode": "mqtt_1k",
"SubscriptionNumLimit": 1,
"TopicNum": 0,
"TopicNumLimit": 1,
"TpsLimit": 1,
"Version": "1"
},
{
"ClientNumLimit": 1000,
"CreateTime": 1705391046,
"InstanceId": "mqtt-47ka4rdr",
"InstanceName": "sun-0116",
"InstanceStatus": "RUNNING",
"InstanceType": "BASIC",
"Remark": "",
"SkuCode": "basic_1k",
"SubscriptionNumLimit": 1000,
"TopicNum": 25,
"TopicNumLimit": 25,
"TpsLimit": 1000,
"Version": "1"
}
],
"RequestId": "9424369d-904f-4fa2-b407-0bd5e536e989",
"TotalCount": 10
}
}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 | 操作失败。 |