Domain name for API request: mqtt.intl.tencentcloudapi.com.
This API is used to query instance information.
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: DescribeInstance. |
| 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. |
| InstanceId | Yes | String | Tencent Cloud MQTT instance ID can be obtained from the api or the console. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceType | String | Instance type |
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| TopicNum | Integer | Number of topics |
| TopicNumLimit | Integer | Maximum number of topics per instance |
| TpsLimit | Integer | TPS throttle value |
| CreatedTime | Integer | createTime, in seconds |
| Remark | String | Remarks |
| InstanceStatus | String | Instance status, RUNNING, running MAINTAINING, maintaining ABNORMAL, abnormal OVERDUE, arrears DESTROYED, deleted CREATING, creating MODIFYING, modifying CREATE_FAILURE, creation failure MODIFY_FAILURE, configuration change failed DELETING, deleting |
| SkuCode | String | Instance specification |
| MaxSubscriptionPerClient | Integer | Maximum number of subscriptions for a single client |
| AuthorizationPolicyLimit | Integer | Number of authorization rule entries |
| ClientNumLimit | Integer | Number of clients cap |
| DeviceCertificateProvisionType | String | Client certificate registration method: |
| AutomaticActivation | Boolean | Whether to automatically activate when automatically registering a device certificate |
| RenewFlag | Integer | Whether it is automatically renewed. Only applicable to monthly subscription clusters. 1: Automatic renewal 0: Non-automatic renewal |
| PayMode | String | Billing mode, POSTPAID, pay-as-you-go PREPAID, annual/monthly subscription |
| ExpiryTime | Integer | Expiry time, millisecond-level timestamp |
| DestroyTime | Integer | Predestruction time, millisecond-level timestamp |
| X509Mode | String | TLS, one-way authentication mTLS, mutual authentication BYOC; one certificate per device |
| MaxCaNum | Integer | Maximum Ca quota |
| RegistrationCode | String | FPS Cert Registration Code |
| MaxSubscription | Integer | Maximum number of subscriptions for a cluster |
| AuthorizationPolicy | Boolean | Authorization policy switch |
| SharedSubscriptionGroupLimit | Integer | Maximum limit of shared subscription groups |
| AutoSubscriptionPolicyLimit | Integer | Limit on number of auto subscription rules |
| MaxTopicFilterPerAutoSubscriptionPolicy | Integer | Number limit of TopicFilter in a single auto subscription rule |
| UseDefaultServerCert | Boolean | Whether to use the default server certificate |
| TrustedCaLimit | Integer | Maximum number of server CAs |
| ServerCertLimit | Integer | Maximum number of server certificates |
| TopicPrefixSlashLimit | Integer | Max level of topic prefix |
| MessageRate | Integer | Single client send message rate limiting, unit messages/second |
| TransportLayerSecurity | String | Server-side tls supported protocols, separated by ",". Example: TLSv1.3,TLSv1.2,TLSv1.1,TLSv1 |
| MessageEnrichmentRuleLimit | Integer | Message property enhancement rule quota |
| BlockRuleLimit | Integer | Maximum allowed number of blocking rules |
| 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. |
POST / HTTP/1.1
Host: mqtt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstance
<Common request parameters>
{
"InstanceId": "mqtt-3ja5wo5b"
}
{
"Response": {
"AuthorizationPolicy": true,
"AuthorizationPolicyLimit": 10,
"AutoSubscriptionPolicyLimit": 10,
"AutomaticActivation": false,
"BlockRuleLimit": 5,
"ClientNumLimit": 2000,
"CreatedTime": 1772163943,
"DestroyTime": 0,
"DeviceCertificateProvisionType": "API",
"ExpiryTime": 0,
"InstanceId": "mqtt-3ja5wo5b",
"InstanceName": "mqtt-shared-test3",
"InstanceStatus": "RUNNING",
"InstanceType": "BASIC",
"MaxCaNum": 20,
"MaxSubscription": 60000,
"MaxSubscriptionPerClient": 30,
"MaxTopicFilterPerAutoSubscriptionPolicy": 5,
"MaxTopicFilterPerSharedSubscriptionGroup": 10,
"MessageEnrichmentRuleLimit": 10,
"MessageRate": -1,
"PayMode": "POSTPAID",
"RegistrationCode": "",
"Remark": "",
"RenewFlag": 1,
"ServerCertLimit": 3,
"SharedSubscriptionGroupLimit": 20,
"SkuCode": "basic_2k",
"TopicNum": 0,
"TopicNumLimit": 20,
"TopicPrefixSlashLimit": 2,
"TpsLimit": 2000,
"TransportLayerSecurity": "TLSv1.3,TLSv1.2,TLSv1.1,TLSv1",
"TrustedCaLimit": 3,
"UseDefaultServerCert": true,
"X509Mode": "TLS",
"RequestId": "2202b107-4def-4fa4-a487-0499c77620db"
}
}
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 |
|---|---|
| ResourceNotFound.Instance | ResourceNotFound.Instance |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan