Domain name for API request: mqtt.intl.tencentcloudapi.com.
This API is used to query device certificate details.
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: DescribeDeviceCertificate. |
| 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. |
| DeviceCertificateSn | Yes | String | The SN serial number of the device certificate is used for unique identification of a device certificate. |
| InstanceId | Yes | String | The instance ID of the TDMQ MQTT can be obtained from the DescribeInstanceList API or the console. |
| Parameter Name | Type | Description |
|---|---|---|
| CreatedTime | Integer | Create time, millisecond-level timestamp. |
| UpdateTime | Integer | Last update time, millisecond-level timestamp. |
| NotAfterTime | Integer | Certificate expiration date, millisecond-level timestamp. |
| LastActivationTime | Integer | Last activation time, millisecond-level timestamp. |
| LastInactivationTime | Integer | Last deactivation time, millisecond-level timestamp. |
| Status | String | Device certificate status ACTIVE: Activate INACTIVE: Inactive REVOKED: Revoked PENDING_ACTIVATION: To be activated. |
| CaSn | String | Certificate serial number |
| DeviceCertificateSn | String | Certificate serial number of the device |
| DeviceCertificate | String | Device certificate content |
| DeviceCertificateCn | String | Device certificate common name |
| Format | String | Certificate format, currently only support PEM format |
| ClientId | String | Client ID. |
| CertificateSource | String | Certificate source API: Manually register JITP: Automatic registration |
| NotBeforeTime | Integer | Start of certificate effective time, millisecond-level timestamp. |
| OrganizationalUnit | String | Organization unit |
| 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. |
This example shows you the example.
POST / HTTP/1.1
Host: mqtt.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceCertificate
<Common request parameters>
{
"DeviceCertificateSn": "0eef68a582b94254296e54ce754f94d707a59911",
"InstanceId": "mqtt-jbgwp4ae"
}
{
"Error": null,
"RequestId": null,
"Response": {
"CaSn": "1b1e3bf3702110125887a3a721a7e66f05522513",
"CertificateSource": "API",
"ClientId": "client1",
"CreatedTime": 1724050379000,
"DeviceCertificate": "-----BEGIN CERTIFICATE-----\nMIIEQjCCAyqgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmREwDQYJKoZIhvcNAQEL\n-----END CERTIFICATE-----\n",
"DeviceCertificateCn": "mqtt-test.xxx.tencent.com",
"DeviceCertificateSn": "0eef68a582b94254296e54ce754f94d707a59911",
"OrganizationalUnit": "TencentCloud",
"Format": "PEM",
"LastActivationTime": 1724050378987,
"LastInactivationTime": 0,
"NotAfterTime": 1758185683000,
"NotBeforeTime": 1714985683000,
"RequestId": "1b5fc3fa-4bbf-421a-aad1-c45d49119a2c",
"Status": "ACTIVE",
"UpdateTime": 1724050379000
}
}
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.
文档反馈