注册CA证书到云消息队列 MQTT 版服务端时,需要上传CA证书的验证证</span>书,用于验证用户是否有该CA证书的私钥。CA证书的验证证书需要通过CA证书的注册码生成,本接口用于获取指定CA证书的注册码。
接口说明
- 仅铂金版和专业版实例支持使用 GetRegisterCode 接口。
- 单用户请求频率限制为 500 次/秒。如有特殊需求,请联系云消息队列 MQTT 版技术支持,钉钉群号:35228338。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| mq:GetRegisterCode | get | *Instance acs:mq:{#regionId}:{#accountId}:{#InstanceId} |
|
|
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MqttInstanceId | string | 是 | 云消息队列 MQTT 版的实例 ID。 | post-cn-7mz2d****** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"RegisterCode": "13274673-8f90-4630-bea1-9cccb25756ad2089******"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | MqttOwnerCheckError | Failed to validate the instance permission | 实例权限校验失败 |
| 403 | PermissionCheckFailed | Failed to verify API permissions. | ram权限检查失败 |
| 500 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 参数校验失败,可能缺失或者传入值非法。 |
| 500 | MqttInstanceNotFound | Specified instance is not found | 实例不存在 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-02-18 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2022-08-24 | OpenAPI 错误码发生变更 | 查看变更详情 |
