全部产品
Search
文档中心

云消息队列 MQTT 版:AddCustomAuthIdentity - 添加身份认证

更新时间:Sep 26, 2024

添加账号身份认证信息,可以具体到客户端。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

云消息队列 MQTT 版实例的 ID。

mqtt-cn-xxxx
Usernamestring

用户名,不超过 64 位

test
Secretstring

密钥。

xxxxx
IdentityTypestring

身份类型。

  • USER:仅用户名。

  • CLIENT:具体到客户端。

USER
ClientIdstring

当身份类型是 CLIENT 时,指定设备的 ClientID。

GID_test@@@test
SignModestring

签名校验方式,ORIGIN:原始值比较,即比较 password 与 secret,SIGNED: 对 clientId 进行 HmacSHA1 加签(使用 secret,参考签名模式)验证,然后比较 password。

SIGNED

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

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

状态码。说明 200 表示成功。

200
Successboolean

操作是否成功。true 表示成功,false 表示失败。

True
Messagestring

返回信息。

operation success.

示例

正常返回示例

JSON格式

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

错误码

HTTP status code错误码错误信息描述
400InstancePermissionCheckFailedAn error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.实例权限校验失败,请确认MQTT实例的所属关系以及授权策略。
400InvalidParameter.%sAn error occurred while validating the parameter. The parameter may be missing or invalid.参数校验失败,可能缺失或者传入值非法。
400Customauth.over.capacityOver custom auth capacity.自定义权限数量容量超限
404ApiNotSupportThe specified API is not supported.当前接口不支持,请检查。

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

变更历史

变更时间变更内容概要操作
暂无变更历史