调用GetRegisterCode接口获取CA证书的注册码。
使用场景
注册CA证书到云消息队列 MQTT 版服务端时,需要上传CA证书的验证证书和注册码,用于验证用户是否有该CA证书的私钥。使用本接口可以获取CA证书的注册码。
使用限制
- 仅铂金版实例支持使用GetRegisterCode接口。
- 单用户请求频率限制为500次/秒。如有特殊需求,请联系云消息队列 MQTT 版技术支持,钉钉群号:35228338。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetRegisterCode | 系统规定参数。取值:GetRegisterCode。 |
MqttInstanceId | String | 是 | post-cn-7mz2d****** | 云消息队列 MQTT 版的实例ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 020F6A43-19E6-4B6E-B846-44EB31DF**** | 公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。 |
RegisterCode | String | 13274673-8f90-4630-bea1-9cccb25756ad2089****** | 返回的CA证书的注册码。 |
示例
请求示例
http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/?Action=GetRegisterCode
&MqttInstanceId=post-cn-7mz2d******
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetRegisterCodeResponse>
<RequestId>020F6A43-19E6-4B6E-B846-44EB31DF****</RequestId>
<RegisterCode>13274673-8f90-4630-bea1-9cccb25756ad2089******</RegisterCode>
</GetRegisterCodeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "020F6A43-19E6-4B6E-B846-44EB31DF****",
"RegisterCode" : "13274673-8f90-4630-bea1-9cccb25756ad2089******"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 参数校验失败,可能缺失或者传入值非法。 |
访问错误中心查看更多错误码。