All Products
Search
Document Center

:DeleteConsumerGroupSubscription

Last Updated:Nov 28, 2024
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.

Deletes the subscriptions of a consumer group.

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.

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:DeleteConsumerGroupSubscriptiondelete
*ConsumerGroup
acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}
    none
none

Request syntax

DELETE /instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

rmq-cn-7e22ody****
consumerGroupIdstringYes

The ID of the consumer group for which you want to delete subscriptions.

CID-TEST
topicNamestringYes

The topic name.

topic_test
filterTypestringYes

The type of the filter expression. Valid values:

  • SQL: filters messages by using SQL expressions.
  • TAG: filters messages by using tags.

Valid values:

  • TAG: filters messages by using SQL expressions.
  • SQL: filters messages by using SQL expressions.
Enumeration Value:
  • TAG: TAG过滤.
  • SQL: SQL过滤.
TAG
filterExpressionstringYes

The filter expression.

*

Response parameters

ParameterTypeDescriptionExample
object

The result.

requestIdstring

The request ID.

723CDA5C-E25C-5EAF-9601-08C286DF8A4D
successboolean

Indicates whether the request was successful.

true
databoolean

The returned data.

true
codestring

The error code.

200
messagestring

The error message.

Parameter instanceId is mandatory for this action .
httpStatusCodeinteger

The HTTP status code.

200
dynamicCodestring

The dynamic error code.

InstanceId
dynamicMessagestring

The dynamic error message.

instanceId
accessDeniedDetailstring

The details about the access denial. This parameter is returned only if the access is denied due to the reason that the Resource Access Management (RAM) user does not have the required permissions.

xxx

Examples

Sample success responses

JSONformat

{
  "requestId": "723CDA5C-E25C-5EAF-9601-08C286DF8A4D",
  "success": true,
  "data": true,
  "code": "200",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

Error codes

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