调用ActiveCaCertificate接口激活CA证书。
使用场景
云消息队列 MQTT 版支持X.509证书认证,客户端可通过设备证书完成接入认证。CA证书用于为客户端签发设备证书,并验证设备证书的正确性,需要在激活状态下使用。更多信息,请参见客户端证书认证。
CA证书注册后默认为激活状态,若您需要使用的CA证书被修改为未激活状态,您可以调用本接口将CA证书重新激活。
使用限制
- 仅铂金版实例支持使用ActiveCaCertificate接口。
- 单用户请求频率限制为500次/秒。如有特殊需求,请联系云消息队列 MQTT 版技术支持,钉钉群号:35228338。
- ActiveCaCertificate接口仅支持对已在云消息队列 MQTT 版服务端注册的CA证书进行操作,您可以通过ListCaCertificate接口查询指定实例下已注册的CA证书。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ActiveCaCertificate | 系统规定参数。取值:ActiveCaCertificate。 |
MqttInstanceId | String | 是 | post-cn-7mz2d****** | CA证书所绑定的实例ID,即云消息队列 MQTT 版的实例ID。 |
Sn | String | 是 | 007269004887****** | 待激活CA证书的SN序列号,用于唯一标识一个CA证书。 取值范围:不超过128 Byte。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 020F6A43-19E6-4B6E-B846-44EB31DF**** | 公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。 |
Sn | String | 007269004887****** | 已激活CA证书的SN序列号,用于唯一标识一个CA证书。 |
示例
请求示例
http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/?Action=ActiveCaCertificate
&MqttInstanceId=post-cn-7mz2d******
&Sn=007269004887******
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ActiveCaCertificateResponse>
<RequestId>020F6A43-19E6-4B6E-B846-44EB31DF****</RequestId>
<Sn>007269004887******</Sn>
</ActiveCaCertificateResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Sn" : "007269004887******"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 参数校验失败,可能缺失或者传入值非法。 |
500 | FindCaBySnError | Failed to find the CA by the SN. Please check sn is valid. | SN不存在 |
访问错误中心查看更多错误码。
控制台操作
除了调用ActiveCaCertificate接口,您还可以通过微消息队列MQTT版控制台激活CA证书。具体操作,请参见CA证书管理。