CloseConnection - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Proactively closes an online connection. After you call this API operation, the device may reconnect to the broker based on the client reconnection mechanism.

Operation description

This API is still in the testing phase and is only available for Professional Edition instances in the Shanghai region. Legacy instances are not supported at this time.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mq:CloseConnection	none	*Instance `acs:mq:{#regionId}:{#accountId}:{#InstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID of the Micro Message Queue MQTT version instance.	post-cn-0pp12gl****
ClientId	string	Yes	Client ID of the device	GID_test@@@test

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	82B9E503-F4A1-4F30-976F-C6999FF9****
Code	integer	Return code of the interface: 200 indicates success. Other values indicate error codes. For details about the error codes, see Error Codes.	200
Message	string	Call result information	operation success.
Success	boolean	Indicates whether the operation was successful. true means success, false means failure.	True

Examples

Sample success responses

JSONformat

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

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	PermissionCheckFailed	An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.
404	ApiNotSupport	The specified API is not supported.
500	InternalError	An error occurred while processing your request. Try again later.

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

Change history

Change time	Summary of changes	Operation

No change history