DescribeSubscriptionGroup--数据库传输服务-火山引擎

文档中心

立即注册

导航

数据库传输服务

DescribeSubscriptionGroup

最近更新时间：2024.09.09 14:38:56首次发布时间：2023.03.29 20:41:51

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

请求类型

同步请求。

请求参数

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

返回参数

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

参数

类型

示例值

描述

Group

Object

{
    "CreateTime":1679280623,
    "DelaySeconds":0,
    "Description":"",
    "GroupName":"9863318d02ed4a6f88f14c03a2******:test****",
    "LogEndOffset":0,
    "Offset":0,
    "PartitionId":0,
    "UpdateTime":1679280623,
    "Username":"test****"
}

消费组的详细信息。

示例

请求示例

POST /?Action=DescribeSubscriptionGroup&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": "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****"
        }
    }
}

错误码

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