AddCustomAuthConnectBlack - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Adds a device to the connection blacklist to disable connections from the device.

Debugging

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance.	mqtt-cn-i7m26mf****
ClientId	string	Yes	The client ID of the device whose connections you want to disable.	GID_test@@@test

Parameter	Type	Description	Example
	object	The schema object.
RequestId	string	The request ID.	82B9E503-F4A1-4F30-976F-C6999FF9****
Code	integer	The HTTP status code. The value 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the operation is successful. Valid values: true and false.	True
Message	string	The message returned.	operation success.

Sample success responses

JSONformat

{
  "RequestId": "82B9E503-F4A1-4F30-976F-C6999FF9****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

HTTP status code	Error code	Error message	Description
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.	-
400	Customauth.over.capacity	Over custom auth capacity.	User-defined permission quantity capacity exceeds the limit
404	ApiNotSupport	The specified API is not supported.	-

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