Domain name for API request: mqtt.intl.tencentcloudapi.com.
Get instance list. Description of the Filters parameter use is as follows:
When using the TagFilters parameter for search, the filters parameter is invalid.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeInstanceList. |
| Version | Yes | String | Common Params. The value used for this API: 2024-05-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Filters.N | No | Array of Filter | Query criteria list, support the following fields InstanceName: Fuzzy search for cluster name InstanceId: Cluster id for exact search InstanceStatus: Cluster status search (RUNNING - running, CREATING - creating, MODIFYING - modifying, DELETING - deleting) Note: The query condition is not effective when TagFilters is configured. |
| Offset | No | Integer | Query start position, default 0 |
| Limit | No | Integer | Query result limit count. Default 20. Maximum 100. |
| TagFilters.N | No | Array of TagFilter | Tag filter |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total query count |
| Data | Array of MQTTInstanceItem | Instance list |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Example
POST / HTTP/1.1
Host: mqtt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMQTTInstanceList
<Common request parameters>
{
"Offset": 0,
"Limit": 10
}
{
"RequestId": null,
"Response": {
"RequestId": "33a9cba9-f885-47aa-8235-8bdcbd9c90bf",
"TotalCount": 2,
"Data": [
{
"InstanceId": "mqtt-zxjwkr98",
"InstanceName": "mqtt-instance",
"Version": "1",
"InstanceType": "PRO",
"InstanceStatus": "RUNNING",
"PayMode": "POSTPAID",
"ExpiryTime": 0,
"Remark": "",
"TopicNum": 1,
"SkuCode": "pro_6k_1",
"TpsLimit": 6000,
"CreateTime": 1741832627,
"MaxSubscriptionPerClient": 30,
"MaxSubscription": 180000,
"AuthorizationPolicyLimit": 20,
"ClientNumLimit": 6000,
"MaxCaNum": 20,
"RenewFlag": 1,
"DestroyTime": 0,
"TopicNumLimit": 300
},
{
"InstanceId": "mqtt-w45zn79z",
"InstanceName": "mqtt-1226",
"Version": "1",
"InstanceType": "PRO",
"InstanceStatus": "RUNNING",
"PayMode": "PREPAID",
"ExpiryTime": 1742972038844,
"Remark": "",
"TopicNum": 2,
"SkuCode": "pro_10k_1",
"TpsLimit": 10000,
"CreateTime": 1735196039,
"MaxSubscriptionPerClient": 30,
"MaxSubscription": 300000,
"AuthorizationPolicyLimit": 20,
"ClientNumLimit": 10000,
"MaxCaNum": 20,
"RenewFlag": 1,
"DestroyTime": 0,
"TopicNumLimit": 300
}
]
},
"Error": null
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários