QueryCustomAuthConnectBlack - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Queries a client ID in a connection blacklist.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance.	post-111****
ClientId	string	No	The ID of the client to be queried.	GID_test@@@test
NextToken	string	No	The token that marks the end position of the previous returned page. To obtain the next batch of data, call the operation again by using the value of NextToken returned by the previous request. If you call this operation for the first time or want to query all results, set NextToken to an empty string.	xOfRU60sGEwN1OlFBIL8Ew==
Size	integer	Yes	The number of clients to be queried. Maximum value: 100.	100

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	020F6A43-19E6-4B6E-B846-44EB31DF****
Code	integer	The HTTP status code. The status code 200 indicates that the request is successful. Other status codes indicate that the request failed. For a list of error codes, see Error codes.	200
Success	boolean	Indicates whether the request is successful. Valid values: true and false.	True
Message	string	The returned message.	operation success.
Data	object	The returned data.
Results	array<object>	The returned results.
	object
ClientId	string	The client ID.	GID_TEST@@@test
Effect	string	Indicates whether to allow or deny access.	ALLOW
PermitAction	string	The authorized permissions.	CONNECT
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results.	AAAAAZ0cM0HTqLXvgm7oMHWXcvc=

Examples

Sample success responses

JSONformat

{
  "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="
  }
}

Error codes

HTTP status code	Error code	Error message
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
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.

For a list of error codes, visit the Service error codes.