릴리스 노트
Domain name for API request: dts.intl.tencentcloudapi.com.
This API is used to creat a consumer group for the subscription instance.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateConsumerGroup. |
| Version | Yes | String | Common Params. The value used for this API: 2021-12-06. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| SubscribeId | Yes | String | Subscription instance ID |
| ConsumerGroupName | Yes | String | Consumer group name, which consists of numbers, letters (upper and lower case), or begins with _ - . Ends with numbers, letters (upper and lower case). The full name of the actually generated consumer group is in the form: consumer-grp-#{SubscribeId}-#{ConsumerGroupName}. |
| AccountName | Yes | String | Account name, which consists of numbers, letters (upper and lower case), or begins with _-.. Ends with numbers, letters (upper and lower case). The full name of the actually generated account is in the form: account-#{SubscribeId}-#{AccountName}. |
| Password | Yes | String | Consumer group password, which should be longer than 3 characters. |
| Description | No | String | Consumer group description |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to creat a consumer group.
POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateConsumerGroup
<Common request parameters>
{
"SubscribeId": "subs-9jyki7hniw",
"ConsumerGroupName": "test",
"AccountName": "test",
"Password": "123",
"Description": "this is a test account"
}{
"Response": {
"RequestId": "20461920-b18e-11ec-ae1a-cfe224f4f21f"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | The CAM signature/authentication information is incorrect. |
| AuthFailure.AuthFailureError | Authentication failed. |
| FailedOperation | Operation failed. |
| FailedOperation.FailedOperationError | The operation failed. |
| InternalError | An internal error occurred. |
| InternalError.InternalErrorError | An internal error occurred. |
| InvalidParameter.InvalidParameterError | The parameter is invalid. |
| InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.InvalidParameterValue | The parameter value is incorrect. |
| InvalidParameterValue.InvalidParameterValueError | The parameter is invalid. |
| OperationDenied | The operation was denied. |
| OperationDenied.OperationDeniedError | The operation was denied. |
| ResourceNotFound | The resource does not exist. |
| ResourceNotFound.ResourceNotFoundError | The resource was not found. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnauthorizedOperation.UnauthorizedOperationError | The operation is unauthorized. |
| UnsupportedOperation | The operation is not supported. |
| UnsupportedOperation.UnsupportedOperationError | The operation is not supported. |
피드백