设备证书是由CA根证书签发给客户端设备使用的数字证书,用于客户端和服务端连接时,服务端对客户端进行安全认证。 客户端设备使用设备证书进行接入认证时,服务端会根据已注册的CA证书验证设备证书是否正确,若CA证书和设备证书匹配成功,则客户端认证通过,且系统会将该设备证书自动注册到服务端中。 设备证书在服务端注册后默认为激活状态,若您需要使用的设备证书被修改为未激活状态,您可以调用本接口将设备证书重新激活。
接口说明
- 仅铂金版和专业版实例支持使用 ActiveDeviceCertificate 接口。
- 单用户请求频率限制为 500 次/秒。如有特殊需求,请联系微消息队列 MQTT 版技术支持,钉钉群号:35228338。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MqttInstanceId | string | 是 | 设备证书所绑定的实例 ID,即微消息队列 MQTT 版的实例 ID。 | post-cn-7mz2d****** |
DeviceSn | string | 是 | 待激活设备证书的 SN 序列号,用于唯一标识一个设备证书。 | 356217374433****** |
CaSn | string | 是 | 待激活设备证书所属的 CA 证书的 SN 序列号,用于唯一标识一个 CA 证书。 取值范围:不超过 128 Byte。 | 007269004887****** |
返回参数
示例
正常返回示例
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 | FindDeviceBySnError | Failed to find the device certificate by the SN. Please check sn is valid | 获取设备证书失败 |
500 | MqttInstanceNotFound | Specified instance is not found | 实例不存在 |
500 | MqttOwnerCheckError | Failed to validate the instance permission | 实例权限校验失败 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史
控制台操作
除了调用 ActiveDeviceCertificate 接口,您还可以通过微消息队列 MQTT 版控制台激活设备证书。具体操作,请参见设备证书管理 。