文档

QueryCustomAuthIdentity - 查询身份认证

更新时间:
一键部署

查询自定义身份认证。

调试

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

授权信息

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

请求参数

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

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

post-111****
Usernamestring

用户名。

test
IdentityTypestring

身份类型。

USER
ClientIdstring

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

GID_test@@@test
NextTokenstring

用来标记当前查询结束的位置,以便下一次调用时作为参数传入,继续翻页。首次调用或返回最后一页时,取值为空字符串。

eyJhY2NvdW50IjoiMTM4MTcxODk3NDQzMjQ1OSIsImV2ZW50SWQiOiJGMkUxOUE3QS1FM0Q0LTVCOEYtQkU4OS1CNkMyM0RBM0UyRjIiLCJsb2dJZCI6IjY2LTEzODE3MTg5NzQ0MzI0NTkiLCJydyI6IlciLCJ0aW1lIjoxNjc4MzI2MTI1MDAwfQ
Sizeinteger

查询数量,最大值:100。

100

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

11568B5B-13A8-4E72-9DBA-3A14F7D3****
Codeinteger

接口返回码:200:表示成功。 其它:表示错误码。错误码详情,请参见错误码。

200
Successboolean

是否调用成功:true:调用成功。 false:调用失败。

True
Messagestring

附加信息。

operation success.
Dataobject

查询结果。

Resultsobject []

返回数据。

Usernamestring

用户名。

test
Secretstring

密钥。

62a5916d71767185b48907d85c2efa****
IdentityTypestring

身份类型。

  • USER:仅用户名。

  • CLIENT:具体到客户端。

USER
ClientIdstring

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

GID_ICP@@@4d378084
SignModestring

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

SIGNED
NextTokenstring

如果还有多余的返回值则会返回 NextToken。

AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ

示例

正常返回示例

JSON格式

{
  "RequestId": "11568B5B-13A8-4E72-9DBA-3A14F7D3****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "Username": "test",
        "Secret": "62a5916d71767185b48907d85c2efa****",
        "IdentityType": "USER",
        "ClientId": "GID_ICP@@@4d378084",
        "SignMode": "SIGNED"
      }
    ],
    "NextToken": "AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ"
  }
}

错误码

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

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