Docs

Database Transmission Service

Data subscription (consumer group management)

CreateSubscriptionGroup

Call the CreateSubscriptionGroup API to create a subscription consumer group.

Request type

Synchronous request.

Precautions

Only support creating a consumer group for subscription tasks directed at built-in middleware, where EndpointType is set to Builtin_Kafka.

Request parameters

Parameter	Type	Is it required?	Sample	Description
TaskId	String	Yes	4ddec6d036384248a25862fb********	Task ID. tip You can call the DescribeTransmissionTasks API to query the task ID.
GroupName	String	Yes	test****	Consumer group name. Naming rules are as follows: The length must be between 2 to 32 characters. It consists of digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-).
Username	String	Yes	test****123	Set the consumer group account. Naming rules: The length must be between 2 and 16 characters. The name must start with a letter and end with a letter or a digit. It consists of numbers, uppercase letters, lowercase letters, and underscores (_).
Password	String	Yes	Admin123	Set the account and password of consumer group. Password rule: The length must be between 8 and 32 characters. It contains at least three of the following: uppercase letters, lowercase letters, digits, and special characters. Special characters are _#!@$%^&*()+=-.
Description	String	No	Subscription messages to Kafka.	The description of the consumer group helps you identify the purpose of the consumer group.

Response parameter

null

Example

Request example

POST /?Action=CreateSubscriptionGroup&Version=2022-10-01 HTTP/1.1​
Content-Type: application/json​
Host: dts.cn-beijing.volcengineapi.com​
X-Date: 20221001T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
{​
    "TaskId": "9863318d02ed4a6f88f14c03a2*****",​
    "GroupName": "9863318d02ed4a6f88f14c03a28c5b6c:test****123",​
    "Username": "test****123",​
    "Password": "Admin123"​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "20230320105753C96512C0DD83B00E0818",​
        "Action": "CreateSubscriptionGroup",​
        "Version": "2022-10-01",​
        "Service": "dts",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

Error code

For more details, see Error code.

Last updated: 2026.02.03 15:54:45