Deletes a consumer group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteConsumerChannel

The operation that you want to perform. Set the value to DeleteConsumerChannel.

ConsumerGroupId String Yes dtsktbb6jdn2******

The ID of the consumer group. You can call the DescribeConsumerChannel operation to query the consumer group ID.

RegionId String Yes cn-hangzhou

The ID of the region where the change tracking instance resides. For more information, see List of supported regions.

DtsInstanceId String No dtsboss6pn1w73****

The ID of the change tracking instance. You can call the DescribeDtsJobs operation to query the instance ID.

Note You must specify at least one of the DtsInstanceId and DtsJobId. parameters.
DtsJobId String No boss6pn1w73****

The ID of the change tracking task. You can call the DescribeDtsJobs operation to query the task ID.

Note You must specify at least one of the DtsInstanceId and DtsJobId. parameters.

Response parameters

Parameter Type Example Description
ErrCode String InternalError

The error code returned if the call failed.

ErrMessage String The request processing has failed due to some unknown error.

The error message returned if the call failed.

HttpStatusCode String 200

The HTTP status code.

RequestId String F9E00ABE-2AD9-40A9-8C3C-D817E648****

The ID of the request.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DeleteConsumerChannel
&ConsumerGroupId=dtsktbb6jdn2******
&RegionId=cn-hangzhou
&DtsInstanceId=dtsboss6pn1w73****

Sample success responses

XML format

<DeleteConsumerChannelResponse>
      <RequestId>F9E00ABE-2AD9-40A9-8C3C-D817E648****</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</DeleteConsumerChannelResponse>

JSON format

{
    "RequestId": "F9E00ABE-2AD9-40A9-8C3C-D817E648****",
    "HttpStatusCode": 200,
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.