DescribeInstance

Download PDF

Last updated:2026-01-13 21:49:33

DescribeInstance

Last updated: 2026-01-13 21:49:33

Download PDF

1. API Description

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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, obtained from the DescribeInstanceList api or console.

3. Output Parameters

Parameter Name	Type	Description
InstanceType	String	Instance type BASIC: basic edition. PRO edition. PLATINUM edition.
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	Creation time, in seconds
Remark	String	Remarks
InstanceStatus	String	Instance status. RUNNING: running; MAINTAINING: maintaining; ABNORMAL: abnormal; OVERDUE: in arrears; DESTROYED: deleted; CREATING: creating; MODIFYING: adjusting the configuration; CREATE_FAILURE: creation failed; MODIFY_FAILURE: configuration adjustment failed; DELETING: deleting.
SkuCode	String	Specifies the instance specification.
MaxSubscriptionPerClient	Integer	Maximum number of subscriptions for a single client.
AuthorizationPolicyLimit	Integer	Number of authorization rules.
ClientNumLimit	Integer	Maximum number of clients.
DeviceCertificateProvisionType	String	Specifies the registration method for the client certificate. JITP: automatically register. API: register manually through api.
AutomaticActivation	Boolean	Specifies whether to automatically activate the device certificate during automatic registration.
RenewFlag	Integer	Whether the instance is automatically renewed. this parameter is valid only for monthly subscription clusters. valid values: 1 (auto-renewal), 0 (non-automatic renewal).
PayMode	String	Billing mode. POSTPAID: pay-as-you-go billing. PREPAID: monthly subscription.
ExpiryTime	Integer	Expiry time. millisecond-level timestamp.
DestroyTime	Integer	Scheduled destruction time. millisecond-level timestamp.
X509Mode	String	TLS, one-way authentication. mTLS, mutual authentication. BYOC, one certificate per device.
MaxCaNum	Integer	Specifies the 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.
MaxTopicFilterPerSharedSubscriptionGroup	Integer	Specifies the topic filter number limit for each shared subscription group.
AutoSubscriptionPolicyLimit	Integer	Specifies the limit on number of auto-subscription rules.
MaxTopicFilterPerAutoSubscriptionPolicy	Integer	Specifies the number limit of TopicFilter in a single auto-subscription rule.
UseDefaultServerCert	Boolean	Specifies whether to use the default server certificate.
TrustedCaLimit	Integer	Maximum allowed number of server cas.
ServerCertLimit	Integer	Specifies the maximum allowed number of server certificates.
TopicPrefixSlashLimit	Integer	Specifies the max level of the topic prefix.
MessageRate	Integer	Specifies the speed limit for sending messages by a single client in messages per second.
TransportLayerSecurity	String	Specifies the protocols supported by the server tls, separated by ",". example: TLSv1.3,TLSv1.2,TLSv1.1,TLSv1.
MessageEnrichmentRuleLimit	Integer	Specifies the message property enrichment rule quota.
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.

4. Example

Example1 Example

Input Example

POST / HTTP/1.1
Host: mqtt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstance
<Common request parameters>

{
    "InstanceId": "mqtt-7peanr83"
}

Output Example

{
    "Response": {
        "AuthorizationPolicy": false,
        "AuthorizationPolicyLimit": 20,
        "AutoSubscriptionPolicyLimit": 10,
        "AutomaticActivation": true,
        "ClientNumLimit": 4000,
        "CreatedTime": 1756879989,
        "DestroyTime": 0,
        "DeviceCertificateProvisionType": "API",
        "ExpiryTime": 1759471988911,
        "InstanceId": "mqtt-7peanr83",
        "InstanceName": "instance-1",
        "InstanceStatus": "RUNNING",
        "InstanceType": "PRO",
        "MaxCaNum": 20,
        "MaxSubscription": 120000,
        "MaxSubscriptionPerClient": 30,
        "MaxTopicFilterPerAutoSubscriptionPolicy": 20,
        "MaxTopicFilterPerSharedSubscriptionGroup": 10,
        "MessageRate": -1,
        "PayMode": "PREPAID",
        "RegistrationCode": "client-test",
        "Remark": "",
        "RenewFlag": 1,
        "ServerCertLimit": 3,
        "SharedSubscriptionGroupLimit": 20,
        "SkuCode": "pro_2k_2",
        "TopicNum": 0,
        "TopicNumLimit": 300,
        "TopicPrefixSlashLimit": 2,
        "TpsLimit": 2000,
        "TransportLayerSecurity": "TLSv1.3,TLSv1.2,TLSv1.1,TLSv1",
        "TrustedCaLimit": 3,
        "UseDefaultServerCert": true,
        "X509Mode": "BYOC",
        "RequestId": "8a95a551-ca77-45f6-aa00-77a090cac898"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud