All Products
Search
Document Center

ApsaraMQ for RocketMQ:DeleteTopic

Last Updated:Sep 24, 2024

Deletes a specified topic.

Operation description

If you delete the topic, the publishing and subscription relationships that are established based on the topic are cleared. Exercise caution when you call this operation.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
rocketmq:DeleteTopicdelete
  • Topic
    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}
    none
none

Request syntax

DELETE /instances/{instanceId}/topics/{topicName} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The ID of the instance to which the topic belongs.

rmq-cn-7e22ody****
topicNamestringYes

The name of the topic.

topic_test

Response parameters

ParameterTypeDescriptionExample
object

The response object.

requestIdstring

The ID of the request. The system generates a unique ID for each request. You can troubleshoot issues based on the request ID.

AF9A8B10-C426-530F-A0DD-96320B39****
successboolean

Indicates whether the call is successful.

true
databoolean

The result data that is returned.

true
codestring

The error code.

Topic.NotFound
messagestring

The error message.

The topic cannot be found.
httpStatusCodeinteger

The HTTP status code.

400
dynamicCodestring

The dynamic error code.

TopicName
dynamicMessagestring

The dynamic error message.

topicName

Examples

Sample success responses

JSONformat

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history