QueryCustomAuthConnectBlack - 查询连接黑名单_云消息队列 MQTT 版(MQTT )-阿里云帮助中心

查询连接黑名单。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
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	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.	当前接口不支持，请检查。

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