文档

GetDeviceCertificate - 获取设备证书详情

更新时间:
一键部署

设备证书是由CA根证书签发给客户端设备使用的数字证书,用于客户端和服务端连接时,服务端对客户端进行安全认证。认证通过后服务端和客户端可基于证书内的加密密钥进行安全通信,若认证不通过则服务端拒绝客户端接入。 您可以调用本接口获取设备证书的详细信息。

接口说明

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
MqttInstanceIdstring

设备证书所绑定的实例 ID,即云消息队列 MQTT 版的实例 ID。

post-cn-7mz2d******
DeviceSnstring

待查询设备证书的 SN 序列号,用于唯一标识一个设备证书。

取值范围:不超过 128 Byte。

356217374433******
CaSnstring

待查询设备证书所属的 CA 证书的 SN 序列号,用于唯一标识一个 CA 证书。

取值范围:不超过 128 Byte。

007269004887******

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

020F6A43-19E6-4B6E-B846-44EB31DF****
Dataobject

证书详细信息。

ValidBeginstring

设备证书生效的起始时间。格式为毫秒级别的 Unix 时间戳。

1654137303000
ValidEndstring

设备证书生效的终止时间。格式为毫秒级别的 Unix 时间戳。

1969497303000
DeviceSnstring

设备证书的 SN 序列号,用于唯一标识一个设备证书。

356217374433******
DeviceNamestring

设备证书的名称。

mqtt_device
DeviceContentstring

设备证书的内容。

\n 表示换行。

-----BEGIN DEVICECERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END DEVICECERTIFICATE-----
CaSnstring

设备证书所属的 CA 证书的 SN 序列号,用于唯一标识一个 CA 证书。

00f26900ba87******
Statusstring

设备证书的状态。取值如下:

  • 0:表示证书为未激活状态。

  • 1:表示证书为激活状态。

说明 设备证书注册后,默认为激活状态。
1

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史

控制台操作

除了调用 GetDeviceCertificate 接口,您还可以通过微消息队列 MQTT 版控制台查看指定设备证书的详细信息。具体操作,请参见 CA 证书管理