文档

QueryCustomAuthPermission - 查询Topic授权

更新时间:
一键部署

查询Topic授权信息。

调试

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

授权信息

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

请求参数

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

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

post-cn-0pp12gl****
IdentityTypestring

身份类型。

USER
Identitystring

用户名或客户端 ID。

test
Topicstring

授权的 Topic,支持 mqtt 多级 topic 与通配符。

test
NextTokenstring

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

AAAAAThmKW2HkRgzo4G7IRRTK2fC6zZmAk6y0bwoNPFOOcSP
Sizeinteger

查询数量,最大值:100。

100

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

63309FDB-ED6C-46AE-B31C-A172FBA0****
Codeinteger

响应 code。

200
Successboolean

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

True
Messagestring

返回结果的提示信息。

operation success.
Dataobject

查询结果。

Resultsobject []

返回数据。

Identitystring

用户名或客户端 ID。

test
PermitActionstring

授权操作。

PUB_SUB
Effectstring

允许或拒绝。

ALLOW
IdentityTypestring

身份类型。

  • USER:仅用户名。

  • CLIENT:具体到客户端。

USER
Topicstring

Topic 资源信息,支持 MQTT 多级 topic 与通配符。

test
NextTokenstring

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

AAAAAV/vsqTyeMlX1MIk7/b6NrZLIlsSVf49O04ac7HAmlBoaYspakK7ZZkR3vRDp5Y9Nz0EmuWYrtF+1qkUwuJzPk/qEto/FGxl5Kd+qdwNt3t8

示例

正常返回示例

JSON格式

{
  "RequestId": "63309FDB-ED6C-46AE-B31C-A172FBA0****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "Identity": "test",
        "PermitAction": "PUB_SUB",
        "Effect": "ALLOW",
        "IdentityType": "USER",
        "Topic": "test"
      }
    ],
    "NextToken": "AAAAAV/vsqTyeMlX1MIk7/b6NrZLIlsSVf49O04ac7HAmlBoaYspakK7ZZkR3vRDp5Y9Nz0EmuWYrtF+1qkUwuJzPk/qEto/FGxl5Kd+qdwNt3t8"
  }
}

错误码

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.参数校验失败,可能缺失或者传入值非法。
404ApiNotSupportThe specified API is not supported.当前接口不支持,请检查。

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