ActiveDeviceCertificate - 激活设备证书

更新时间:

设备证书是由CA根证书签发给客户端设备使用的数字证书,用于客户端和服务端连接时,服务端对客户端进行安全认证。 客户端设备使用设备证书进行接入认证时,服务端会根据已注册的CA证书验证设备证书是否正确,若CA证书和设备证书匹配成功,则客户端认证通过,且系统会将该设备证书自动注册到服务端中。 设备证书在服务端注册后默认为激活状态,若您需要使用的设备证书被修改为未激活状态,您可以调用本接口将设备证书重新激活。

接口说明

  • 仅铂金版和专业版实例支持使用 ActiveDeviceCertificate 接口。

  • 单用户请求频率限制为 500 次/秒。如有特殊需求,请联系微消息队列 MQTT 版技术支持,钉钉群号:35228338。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mq:ActiveDeviceCertificate

none

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

  • mq:MqttInstanceAccess

请求参数

名称

类型

必填

描述

示例值

MqttInstanceId

string

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

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

DeviceSn

string

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

356217374433******

CaSn

string

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

取值范围:不超过 128 Byte。

007269004887******

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

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

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

DeviceSn

string

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

356217374433******

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 ParameterFieldCheckFailed Failed to validate the parameters. The parameters may be missing or invalid. 参数校验失败,可能缺失或者传入值非法。
500 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
403 PermissionCheckFailed Failed to verify API permissions. ram权限检查失败
403 MqttOwnerCheckError Failed to validate the instance permission

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

变更历史

更多信息,参考变更详情