Domain name for API request: mqtt.intl.tencentcloudapi.com.
Query device certificates with paging
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: DescribeDeviceCertificates. |
| 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 console. |
| Filters.N | No | Array of Filter | Support search parameter Client id: Client id, obtained based on actual business operations. CaSn: The SN serial number of the CA certificate belonging to it can be obtained by querying the cluster CA certificate list (https://www.tencentcloud.com/document/api/1778/116206?from_cn_redirect=1) or through business operations. DeviceCertificateSn: SN serial number of the device certificate. Can be obtained from Query Device Certificate Detail. DeviceCertificateCn: The device certificate CN. OrganizationalUnit: Cert OU NotAfterEnd: Certificates with expiration time less than or equal to the specified time NotAfterStart: Cert with expiration time equal to or greater than the specified time Status: Device certificate status. ACTIVE (activated); INACTIVE (inactive); REVOKED (revoked); PENDING_ACTIVATION (to be activated). |
| Limit | No | Integer | Pagination limit. Default 20. Maximum 100. |
| Offset | No | Integer | Pagination offset, default 0 |
| OrderBy | No | String | Sorting rule CREATE_TIME_DESC, descending order by creation time CREATE_TIME_ASC, sort by creation time in ascending order UPDATE_TIME_DESC, descending order by update time UPDATE_TIME_ASC, update time in ascending order |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number. |
| Data | Array of DeviceCertificateItem | Device certificate 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: DescribeDeviceCertificates
<Common request parameters>
{
"InstanceId": "mqtt-qgzaawn9"
}
{
"Error": null,
"RequestId": null,
"Response": {
"Data": [
{
"ClientId": "client-1",
"DeviceCertificateSn": "0eef68a582b94254296e54ce754f94d707a59913",
"DeviceCertificateCn": "tx",
"DeviceCertificate": "-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----\n",
"CaSn": "1b1e3bf3702110125887a3a721a7e66f05522513",
"OrganizationalUnit": "tx",
"Format": "PEM",
"Status": "ACTIVE",
"CertificateSource": "API",
"LastActivationTime": 1742983099435,
"LastInactivationTime": 0,
"CreatedTime": 1742983115198,
"UpdateTime": 1742983115198,
"NotBeforeTime": 1734537600000,
"NotAfterTime": 1766073600000
}
],
"RequestId": "378f8c36-a6a1-406c-85ac-f2379386eed6",
"TotalCount": 1
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈