查询设备证书详情

最近更新时间:2025-04-25 01:47:46

我的收藏

1. 接口描述

接口请求域名: mqtt.tencentcloudapi.com 。

查询设备证书详情接口

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceCertificate。
Version String 公共参数,本接口取值:2024-05-16。
Region String 公共参数,详见产品支持的 地域列表
DeviceCertificateSn String 设备证书的SN序列号,用于唯一标识一个设备证书。
示例值:0eef68a582b94254296e54ce754f94d707a59913
InstanceId String 腾讯云MQTT实例ID,从 DescribeInstanceList接口或控制台获得。
示例值:mqtt-xxxx

3. 输出参数

参数名称 类型 描述
CreatedTime Integer 创建时间,毫秒级时间戳 。
示例值:1713164969433
UpdateTime Integer 上次更新时间,毫秒级时间戳 。
示例值:1713164969433
NotAfterTime Integer 证书失效日期,毫秒级时间戳 。
示例值:1713164969433
LastActivationTime Integer 上次激活时间,毫秒级时间戳 。
示例值:1713164969433
LastInactivationTime Integer 上次取消激活时间,毫秒级时间戳 。
示例值:1713164969433
Status String 设备证书的状态
ACTIVE:激活
INACTIVE:未激活
REVOKED:吊销
PENDING_ACTIVATION:注册待激活
示例值:ACTIVE
CaSn String Ca证书序列号
示例值:1b1e3bf3702110125887a3a721a7e66f05522513
DeviceCertificateSn String 设备证书序列号
示例值:0eef68a582b94254296e54ce754f94d707a59911
DeviceCertificate String 设备证书内容
示例值:-----BEGIN CERTIFICATE-----\nMIIEQjCCAyqgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmREwDQYJKoZIhvcNAQEL\n-----END CERTIFICATE-----\n
DeviceCertificateCn String 设备证书common name
示例值:mqtt-test.xxx.tencent.com
Format String 证书格式,当前仅支持PEM格式
示例值:PEM
ClientId String 客户端id
示例值:client1
CertificateSource String 证书来源
API:手动注册
JITP:自动注册
示例值:API
NotBeforeTime Integer 证书生效开始时间,毫秒级时间戳 。
示例值:1713164969433
OrganizationalUnit String 组织单位
示例值:TencentCloud-1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceCertificate
<公共请求参数>

{
    "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
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码