DeleteDeviceCertificate - 删除设备证书

更新时间:

设备证书是由CA根证书签发给客户端设备使用的数字证书,用于客户端和服务端连接时,服务端对客户端进行安全认证。认证通过后服务端和客户端可基于证书内的加密密钥进行安全通信,若认证不通过则服务端拒绝客户端接入。 若您不想需要使用某个设备证书,您可以调用本接口将指定设备证书的注册信息从服务端的存储记录中删除。

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:DeleteDeviceCertificatedelete
*Instance
acs:mq:{#regionId}:{#accountId}:{#InstanceId}
  • mq:MqttInstanceAccess

请求参数

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

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

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

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

取值范围:不超过 128 Byte。

356217374433****
CaSnstring

设备证书所属的 CA 证书的序列号,用于唯一标识一个 CA 证书。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.参数校验失败,可能缺失或者传入值非法。
400MqttOwnerCheckErrorFailed to validate the instance permission实例权限校验失败
403PermissionCheckFailedFailed to verify API permissions.ram权限检查失败
500FindDeviceBySnErrorFailed to find the device certificate by the SN. Please check sn is valid获取设备证书失败
500MqttInstanceNotFoundSpecified instance is not found实例不存在

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

变更历史

变更时间变更内容概要操作
2025-02-18OpenAPI 错误码发生变更查看变更详情

控制台操作

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