查询设备证书

最近更新时间:2024-12-13 01:48:27

我的收藏

1. 接口描述

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

分页查询设备证书

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceCertificates。
Version String 公共参数,本接口取值:2024-05-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 集群ID
示例值:mqtt-12345
Filters.N Array of Filter 过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
示例值:[{"Name":"DeviceCertificateSn","Values":["mqtt"]}]
Limit Integer 分页limit
示例值:20
Offset Integer 分页偏移量
示例值:0
OrderBy String CREATE_TIME_DESC, 创建时间降序
CREATE_TIME_ASC,创建时间升序
UPDATE_TIME_DESC,更新时间降序
UPDATE_TIME_ASC,更新时间升序
示例值:CREATE_TIME_DESC

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数
示例值:1
Data Array of DeviceCertificateItem 设备证书
示例值:[ { "ClientId": "mqtt_495bf0d1", "DeviceCertificateSn": "sn", "DeviceCertificateCn": ".mqtt.tencenttdmq.com", "DeviceCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIDtzCCAp+gAwIBAgIUDAmlFLEYRYrhNkFH+uRaU/0TZCswDQYJKoZIhvcNAQEL\r\n\n-----END CERTIFICATE-----\r\n", "CaSn": "51e61225de8146bea80e793197d7cc3e7680d978", "Format": "PEM", "Status": "ACTIVE", "CertificateSource": "API", "LastActivationTime": 1728893405812, "LastInactivationTime": 0, "CreatedTime": 1728893406000, "UpdateTime": 1728893850000, "NotBeforeTime": 1728893395000, "NotAfterTime": 1772093395000 }, { "ClientId": "mqtt_495bf0d1", "DeviceCertificateSn": "sn", "DeviceCertificateCn": "client-test", "DeviceCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIDrDCCApSgAwIBAgIUDAmlFLEYRYrhNkFH+uRaU/0TZCowDQYJKoZIhvcNAQEL\r\n-----END CERTIFICATE-----\r\n", "CaSn": "51e61225de8146bea80e793197d7cc3e7680d978", "Format": "PEM", "Status": "ACTIVE", "CertificateSource": "API", "LastActivationTime": 1728892994189, "LastInactivationTime": 0, "CreatedTime": 1728892994000, "UpdateTime": 1728893891000, "NotBeforeTime": 1728892979000, "NotAfterTime": 1772092979000 }, { "ClientId": " ", "DeviceCertificateSn": "sn", "DeviceCertificateCn": ".mqtt.tencenttdmq.com", "DeviceCertificate": "-----BEGIN CERTIFICATE-----\nMIIDrzCCApegAwIBAgIUV23UtXK/m8jslmJsfVgfxsECUNcwDQYJKoZIhvcNAQEL\n-----END CERTIFICATE-----\n", "CaSn": "5c443401cd63e4840bb6839fc1e404ee7b719876", "Format": "PEM", "Status": "ACTIVE", "CertificateSource": "API", "LastActivationTime": 1728725044431, "LastInactivationTime": 1728725012888, "CreatedTime": 1728725044000, "UpdateTime": 1728725048000, "NotBeforeTime": 1726115615000, "NotAfterTime": 1769315615000 } ]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

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

{
    "InstanceId": "mqtt-qgzaawn9"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Data": [],
        "RequestId": "378f8c36-a6a1-406c-85ac-f2379386eed6",
        "TotalCount": 0
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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