Modifies the password of a consumer group

Note
  • This operation is applicable to only the new version of the change tracking feature. To use the new version, you must specify the SubscriptionInstanceNetworkType parameter when you call the ConfigureSubscriptionInstance operation. If you use the previous version, you do not need to specify the SubscriptionInstanceNetworkType parameter.
  • When you call this operation, the change tracking task must be in the NotStarted, Failed, Normal, or Abnormal state.

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 ModifyConsumerGroupPassword

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

ConsumerGroupID String Yes dtswc411cg617p****

The ID of the consumer group.

You can call the DescribeConsumerGroup operation to query the consumer group ID.

consumerGroupNewPassword String Yes Test654321

The new 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.
ConsumerGroupPassword String Yes Test123456

The current password of the consumer group.

SubscriptionInstanceId String Yes dtsg2m10r1x15a****

The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID.
RegionId String No cn-hangzhou

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

ConsumerGroupName String No Test Consumer Group

The name of the consumer group. You can call the DescribeConsumerGroup operation to query the consumer group name.

ConsumerGroupUserName String No dtstest

The username of the consumer group. You can call the DescribeConsumerGroup operation to query the username.

AccountId String No 12323344****

The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be removed in the future.

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.

RequestId String A06B5CFF-9576-4BC1-BE62-A3D43E1F****

The ID of the request.

Success String true

Indicates whether the call was successful.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=ModifyConsumerGroupPassword
&ConsumerGroupID=dtswc411cg617p****
&consumerGroupNewPassword=Test654321
&ConsumerGroupPassword=Test123456
&SubscriptionInstanceId=dtsg2m10r1x15a****
&<Common request parameters>

Sample responses

XML format 

<ModifyConsumerGroupPasswordResponse>
      <RequestId>A06B5CFF-9576-4BC1-BE62-A3D43E1F****</RequestId>
      <Success>true</Success>
</ModifyConsumerGroupPasswordResponse>

JSON format 

{
    "RequestId": "A06B5CFF-9576-4BC1-BE62-A3D43E1F****",
    "Success": true
}

Error codes

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