文档

DeleteCaCertificate - 删除CA证书

更新时间:
一键部署

云消息队列 MQTT 版支持X.509证书认证,客户端可通过设备证书完成接入认证。CA证书用于为客户端签发设备证书,并验证设备证书的正确性。 使用CA证书需要先将证书注册到云消息队列 MQTT 版服务端,若您不再需要使用某个CA证书,您可以调用DeleteCaCertificate接口将该证书从服务端记录中删除。

接口说明

  • 仅铂金版和专业版实例支持使用 DeleteCaCertificate 接口。
  • 单用户请求频率限制为 500 次/秒。如有特殊需求,请联系云消息队列 MQTT 版技术支持,钉钉群号:35228338。
  • DeleteCaCertificate 接口仅支持对已在云消息队列 MQTT 版服务端注册的 CA 证书进行操作,您可以通过 ListCaCertificate 接口查询指定实例下已注册的 CA 证书。
  • 删除指定 CA 证书,由该 CA 证书签发的且已在云消息队列 MQTT 版服务端注册的所有设备证书也将被自动删除。

调试

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

授权信息

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

请求参数

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

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

post-cn-7mz2d******
Snstring

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

取值范围:不超过 128 Byte。

007269004887******

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

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

已删除 CA 证书的 SN 序列号,用于唯一标识一个 CA 证书。

007269004887******

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
2022-08-24OpenAPI 错误码发生变更查看变更详情

控制台操作

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