ListDeviceCertificate - 查询设备证书列表_云消息队列 MQTT 版(MQTT)-阿里云帮助中心

设备证书是由CA根证书签发给客户端设备使用的数字证书，用于客户端和服务端连接时，服务端对客户端进行安全认证。认证通过后服务端和客户端可基于证书内的加密密钥进行安全通信，若认证不通过则服务端拒绝客户端接入。本接口用于查询指定实例下所有注册的设备证书。

接口说明

仅铂金版和专业版实例支持使用 ListDeviceCertificate 接口。
单用户请求频率限制为 500 次/秒。如有特殊需求，请联系云消息队列 MQTT 版技术支持，钉钉群号：35228338。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
MqttInstanceId	string	是	云消息队列 MQTT 版的实例 ID，表示需要查看哪个实例下的所有设备证书。	post-cn-7mz2d******
PageNo	string	是	查询第几页的返回结果。起始页从第 1 页开始计算。	2
PageSize	string	是	每页最多显示几条查询记录。取值范围：1~100。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。	020F6A43-19E6-4B6E-B846-44EB31DF****
Data	object	查询结果。
Total	integer	查询结果最大页数。	1
PageNo	integer	当前返回的查询记录是第几页。	2
PageSize	integer	每页显示的最大结果数。	10
DeviceCertificateVOS	array<object>	设备证书的详细信息。
DeviceCertificateVO	object
ValidBegin	string	设备证书生效的起始时间。格式为毫秒级别的 Unix 时间戳。	1654137303000
ValidEnd	string	设备证书生效的终止时间。格式为毫秒级别的 Unix 时间戳。	1969497303000
DeviceSn	string	设备证书的 SN 序列号，用于唯一标识一个设备证书。	356217374433******
DeviceContent	string	设备证书的内容。 \n 表示换行。	-----BEGIN DEVICECERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END DEVICECERTIFICATE-----
Status	string	设备证书的状态。取值如下： 0：表示证书为未激活状态。 1：表示证书为激活状态。设备证书注册后，默认为激活状态。	1
CaSn	string	设备证书所属的 CA 证书的 SN 序列号，用于唯一标识一个 CA 证书。	00f26900ba87******
DeviceName	string	设备证书的名称。	mqtt_device

示例

正常返回示例

JSON格式

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Data": {
    "Total": 1,
    "PageNo": 2,
    "PageSize": 10,
    "DeviceCertificateVOS": [
      {
        "ValidBegin": "1654137303000",
        "ValidEnd": "1969497303000",
        "DeviceSn": "356217374433******",
        "DeviceContent": "-----BEGIN DEVICECERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END DEVICECERTIFICATE-----",
        "Status": "1",
        "CaSn": "00f26900ba87******",
        "DeviceName": "mqtt_device"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterFieldCheckFailed	Failed to validate the parameters. The parameters may be missing or invalid.	参数校验失败，可能缺失或者传入值非法。
500	FindDeviceBySnError	Failed to find the device certificate by the SN. Please check sn is valid	获取设备证书失败
500	MqttInstanceNotFound	Specified instance is not found	实例不存在
500	MqttOwnerCheckError	Failed to validate the instance permission	实例权限校验失败

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史

控制台操作

除了调用 ListDeviceCertificate 接口，您还可以通过微消息队列 MQTT 版控制台查看指定实例下所有注册的设备证书。具体操作，请参见设备证书管理。