文档中心

数据库传输服务

请输入

数据订阅（消费组管理）

DescribeSubscriptionGroup

调用 DescribeSubscriptionGroup 接口查询订阅消费组。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
TaskId	String	是	9863318d02ed4a6f88f14c03a2*****	任务 ID。说明您可以调用 DescribeTransmissionTasks接口查询任务 ID。
GroupName	String	是	9863318d02ed4a6f88f14c03a28c5b6c:test****	消费组名称。

返回参数

参数	类型	示例值	描述
Group	Object of SubscriptionGroupInfo	{ "CreateTime":1679280623, "DelaySeconds":0, "Description":"", "GroupName":"9863318d02ed4a6f88f14c03a2****:test", "LogEndOffset":0, "Offset":0, "PartitionId":0, "UpdateTime":1679280623, "Username":"test**" }	消费组的详细信息。

SubscriptionGroupInfo

参数	类型	示例值	描述
GroupName	String	9863318d02ed4a6f88f14c03a2****:test**	消费组名称。
Description	String	用于订阅到 Kafka。	消费组的描述，帮助您辨识消费组的用途。
CreateTime	Long	1679280623	创建消费组的时间。单位：秒。
UpdateTime	Long	1679280623	消费组的更新时间。单位：秒。
PartitionId	Integer	0	分区 ID。
LogEndOffset	Long	0	最新的位点。
Offset	Long	-1	当前消费位点。
DelaySeconds	Long	0	延迟时间。单位：秒。
Username	String	test****	账号名称。

示例

请求示例

POST /?Action=DescribeSubscriptionGroup&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": "9863318d02ed4a6f88f1*****",​
    "GroupName": "9863318d02ed4a6f88f14c03a28c5b6c:test****"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20230320105601136C584CCCD09D0FC552",​
        "Action": "DescribeSubscriptionGroup",​
        "Version": "2022-10-01",​
        "Service": "dts",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Group": {​
            "CreateTime": 1679280623,​
            "DelaySeconds": 0,​
            "Description": "",​
            "GroupName": "9863318d02ed4a6f88f14c03a2******:test****",​
            "LogEndOffset": 0,​
            "Offset": 0,​
            "PartitionId": 0,​
            "UpdateTime": 1679280623,​
            "Username": "test****"​
        }​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.02.03 14:24:30

这个页面对您有帮助吗？

有用

无用