You need to enable JavaScript to run this app.
导航

CreateSubscriptionGroup

最近更新时间2024.01.16 17:59:28

首次发布时间2023.03.29 20:41:43

调用 CreateSubscriptionGroup 接口创建订阅消费组。

前提条件

仅支持对订阅到内置中间件的订阅任务创建消费组,即 EndpointType 取值为 Builtin_Kafka

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

TaskId

String

4ddec6d036384248a25862fb********

任务 ID。

说明

您可以调用 DescribeTransmissionTasks 接口查询任务 ID。

GroupName

String

test****

消费组名称。名称命名规则如下:

  • 长度需在 2~32 个字符内。

  • 由数字、大写字母、小写字母、下划线(_)和中划线(-)组成。

DescriptionString订阅消息至 Kafka。消费组的描述,帮助您辨识消费组的用途。

Username

String

test****123

设置消费组账号。命名规则:

  • 长度需在 2~16 个字符内。

  • 以字母开头,字母或数字结尾。

  • 由数字、大写字母、小写字母、下划线(_)组成。

Password

String

Admin123

设置消费组账号密码。密码规则:

  • 长度需在 8~32 个字符内。

  • 至少包含大写字母、小写字母、数字或特殊字符中的三种类型。特殊字符包含 _#!@$%^&*()+=-

返回参数

null

请求示例

POST /?Action=CreateSubscriptionGroup&Version=2022-10-01 HTTP/1.1
Content-Type: application/json
Host:dts.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"
}

返回示例

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

错误码

更多详情,请参见错误码