Creates a consumer group for a change tracking task. Downstream clients can use the consumer group to consume tracked data.

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 CreateConsumerChannel

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

ConsumerGroupName String Yes Consumer Group A

The name of the consumer group. The name can be up to 128 characters in length. We recommend that you use an informative name for easy identification.

ConsumerGroupPassword String Yes Test123456

The password of the consumer group.

  • A password must contain two or more of the following characters: uppercase letters, lowercase letters, digits, and special characters.
  • A password must be 8 to 32 characters in length.
ConsumerGroupUserName String Yes dtstest

The username of the consumer group.

  • A username must contain one or more of the following characters: uppercase letters, lowercase letters, digits, and underscores (_).
  • A username cannot exceed 16 characters in length.
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 dtsboss6pn1w******

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 boss6pn1w******

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
ConsumerGroupID String dtsor2y66j4219****

The ID of the consumer group. You can specify this parameter on a downstream client when you consume tracked data.

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 5F566C5B-E5B0-4020-A531-FC6F5005****

The ID of the request.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=CreateConsumerChannel
&ConsumerGroupName=Consumer Group B
&ConsumerGroupPassword=Test123456
&ConsumerGroupUserName=dtstest
&RegionId=cn-hangzhou
&DtsInstanceId=dtsboss6pn1w******

Sample success responses

XML format 

<CreateConsumerChannelResponse>
      <ConsumerGroupID>dtsor2y66j4219****</ConsumerGroupID>
      <RequestId>5F566C5B-E5B0-4020-A531-FC6F5005****</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</CreateConsumerChannelResponse>

JSON format 

{
	"ConsumerGroupID": "dtsor2y66j4219****",
	"RequestId": "5F566C5B-E5B0-4020-A531-FC6F5005****",
	"HttpStatusCode": 200,
	"Success": true
}

Error codes

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