调用CreateConsumerChannel接口为DTS订阅任务新增消费组,用于下游客户端消费订阅数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateConsumerChannel |
系统规定参数,取值:CreateConsumerChannel。 |
ConsumerGroupName | String | 是 | 订阅组A |
消费组的名称,不超过128个字符。建议配置具有业务意义的名称,便于后续识别。 |
ConsumerGroupPassword | String | 是 | Test123456 |
消费组的账号密码。
|
ConsumerGroupUserName | String | 是 | dtstest |
消费组的账号。
|
RegionId | String | 是 | cn-hangzhou |
DTS订阅实例所在地域的ID,请参见支持的地域列表。 |
DtsInstanceId | String | 否 | dtsboss6pn1w****** |
订阅实例ID,可以调用DescribeDtsJobs查询。 说明 参数DtsInstanceId与DtsJobId,两者必须传入其一。
|
DtsJobId | String | 否 | boss6pn1w****** |
订阅任务ID,可以调用DescribeDtsJobs查询。 说明 参数DtsInstanceId与DtsJobId,两者必须传入其一。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ConsumerGroupID | String | dtsor2y66j4219**** |
消费组ID,可在下游客户端消费订阅数据时传入。 |
ErrCode | String | InternalError |
调用出错时返回的错误码。 |
ErrMessage | String | The request processing has failed due to some unknown error. |
调用出错时返回对应的错误信息。 |
HttpStatusCode | String | 200 |
状态码。 |
RequestId | String | 5F566C5B-E5B0-4020-A531-FC6F5005**** |
请求ID。 |
Success | String | true |
请求是否成功。 |
示例
请求示例
http(s)://dts.aliyuncs.com/?Action=CreateConsumerChannel
&ConsumerGroupName=订阅组A
&ConsumerGroupPassword=Test123456
&ConsumerGroupUserName=dtstest
&RegionId=cn-hangzhou
&DtsInstanceId=dtsboss6pn1w******
正常返回示例
XML
格式
<CreateConsumerChannelResponse>
<ConsumerGroupID>dtsor2y66j4219****</ConsumerGroupID>
<RequestId>5F566C5B-E5B0-4020-A531-FC6F5005****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Success>true</Success>
</CreateConsumerChannelResponse>
JSON
格式
{
"ConsumerGroupID": "dtsor2y66j4219****",
"RequestId": "5F566C5B-E5B0-4020-A531-FC6F5005****",
"HttpStatusCode": 200,
"Success": true
}
错误码
访问错误中心查看更多错误码。