文档

InactivateDeviceCertificate - 注销设备证书

更新时间:
一键部署

设备证书是由CA根证书签发给客户端设备使用的数字证书,用于客户端和服务端连接时,服务端对客户端进行安全认证。认证通过后服务端和客户端可基于证书内的加密密钥进行安全通信,若认证不通过则服务端拒绝客户端接入。 若您暂时不需要使用某个设备证书,可通过该接口注销设备证书,将设备证书状态变成未激活。

接口说明

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

调试

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

授权信息

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

请求参数

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

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

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

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

356217374433******
CaSnstring

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

取值范围:不超过 128 Byte。

007269004887******

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

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

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

356217374433******

示例

正常返回示例

JSON格式

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "DeviceSn": "356217374433******"
}

错误码

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实例权限校验失败

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

变更历史

变更时间变更内容概要操作
2022-08-24新增 OpenAPI查看变更详情

控制台操作

除了调用 InactivateDeviceCertificate 接口,您还可以通过微消息队列 MQTT 版控制台注销设备证书。具体操作,请参见设备证书管理