调用CreateConsumerGroup接口为订阅通道新增消费组。

  • 本接口仅适用于新版订阅通道。
    说明 在调用ConfigureSubscriptionInstance接口时,需要传入SubscriptionInstanceNetworkType参数,如果不传入该参数则订阅通道被定义为旧版。
  • 只有订阅通道配置完成后,才能调用本接口。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateConsumerGroup 要执行的操作,取值:CreateConsumerGroup
SubscriptionInstanceId String dtsxxxxxxxx 订阅通道ID。
ConsumerGroupName String 测试订阅组 消费组名称。建议配置具有业务意义的名称,便于后续识别。
ConsumerGroupUserName String dtstest 消费组的账号。
  • 由大写字母、小写字母、数字、下划线中的任意一种或多种组成。
  • 最长16个字符。
ConsumerGroupPassword String Test123456 该消费组账号对应的密码。
  • 由大写字母、小写字母、数字、特殊字符中的任意两种或两种以上组成。
  • 密码长度为8-32个字符。

返回参数

名称 类型 示例值 描述
RequestId String 36923CC2-DDAB-4B48-A144-DA92C1E19537 请求ID。
ConsumerGroupID String dtsxxxxxxxx 消费组ID。

示例

    public String createConsumerGroup(String instanceId, String consumerGroupName, String consumerGroupUserName, String consumerGroupPassword) throws Exception {
        CreateConsumerGroupRequest request = new CreateConsumerGroupRequest();
        request.setSubscriptionInstanceId(instanceId);
        request.setConsumerGroupName(consumerGroupName);
        request.setConsumerGroupUserName(consumerGroupUserName);
        request.setConsumerGroupPassword(consumerGroupPassword);

        CreateConsumerGroupResponse response = client.getAcsResponse(request);
        return response.getConsumerGroupID();
    }

错误码

错误码 错误信息 描述
InvalidParameter The Input Parameter${parameter} is not valid. 输入的参数不合法,请检查输入的参数是否正确。
InvalidParameterValid The Value of Input Parameter${parameter} is not valid. 参数值校验不通过,请检查是否缺失所提示的参数以及用户AK是否正确。
MissingParameter The parameter "<parameter name>" is needed but no provided. 缺少参数,请检查是否缺失所提示的参数以及用户AK是否正确,具体请参照DTS OpenAPI文档。
Forbidden.InstanceNotFound Instanceis not found or does not belong to this account. 实例不存在,或者当前用户没有该实例的操作权限。