QueryCustomAuthConnectBlack - 查询连接黑名单 - 云消息队列 MQTT 版

查询连接黑名单。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mq:QueryCustomAuthConnectBlack

get

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	消息队列 MQTT 版实例的 ID。	post-111****
ClientId	string	否	查询具体的设备 Client ID。	GID_test@@@test
NextToken	string	否	用来标记当前查询结束的位置，以便下一次调用时作为参数传入，继续翻页。首次调用或返回最后一页时，取值为空字符串。	xOfRU60sGEwN1OlFBIL8Ew==
Size	integer	是	查询数量，最大值：100。	100

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	020F6A43-19E6-4B6E-B846-44EB31DF****
Code	integer	接口返回码：200：表示成功。其它：表示错误码。错误码详情，请参见错误码。	200
Success	boolean	是否调用成功：true：调用成功。 false：调用失败。	True
Message	string	返回信息。	operation success.
Data	object	返回参数数据结构。
Results	array<object>	返回数据。
	object	返回数据。
ClientId	string	设备的 Client ID。	GID_TEST@@@test
Effect	string	允许或拒绝。	ALLOW
PermitAction	string	授权操作。	CONNECT
NextToken	string	下一页的 token。	AAAAAZ0cM0HTqLXvgm7oMHWXcvc=

示例

正常返回示例

JSON格式

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "ClientId": "GID_TEST@@@test",
        "Effect": "ALLOW",
        "PermitAction": "CONNECT"
      }
    ],
    "NextToken": "AAAAAZ0cM0HTqLXvgm7oMHWXcvc="
  }
}

错误码

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

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

变更历史

更多信息，参考变更详情。