DeleteInstance - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Deletes a ApsaraMQ for RocketMQ instance.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

After an instance is deleted, the instance cannot be restored. Exercise caution when you call this operation.
This operation is used to delete a pay-as-you-go instance. A subscription instance is automatically released after it expires. You do not need to manually delete a subscription instance.

Debugging

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

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:
- The required resource types are displayed in bold characters.
- 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
rocketmq:DeleteInstance	delete	Instance acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

DELETE /instances/{instanceId}

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the ApsaraMQ for RocketMQ instance that you want to delete.	rmq-cn-7e22ody0129

Response parameters

Parameter	Type	Description	Example
	object	Result
requestId	string	The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.	048242AA-BADA-5F29-B2CD-ED9FA344467F
success	boolean	Indicates whether the call was successful.	true
data	boolean	The returned result.	true
code	string	The error code returned if the call failed.	MissingInstanceId
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code returned.	400
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Sample success responses

JSONformat

{
  "requestId": "048242AA-BADA-5F29-B2CD-ED9FA344467F",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history