調用DescribeConsumerGroup介面查詢資料訂閱執行個體中的消費組詳情。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | DescribeConsumerGroup | 系統規定參數，取值：DescribeConsumerGroup。 |
| SubscriptionInstanceId | String | 是 | dtso5xx5t9u19e**** | 資料訂閱執行個體ID，可以通過調用DescribeSubscriptionInstances介面查詢。 |
| RegionId | String | 否 | cn-hangzhou | 資料訂閱執行個體所在地區的ID，詳情請參見支援的地區列表。 |
| PageSize | Integer | 否 | 30 | 每頁記錄數，取值： 30、50、100，預設值為30。 |
| PageNum | Integer | 否 | 1 | 頁碼，取值為大於0且不超過Integer資料類型的最大值，預設值為1。 |
| AccountId | String | 否 | 12323344**** | 阿里雲主帳號ID，無需設定，該參數即將下線。 |
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| ConsumerChannels | Array of DescribeConsumerChannel | 消費組列表。 |
|
| DescribeConsumerChannel | |||
| ConsumerGroupID | String | dtspis1110z232**** | 消費組ID。 |
| ConsumerGroupName | String | consumergrouptest | 消費組名稱。 |
| ConsumerGroupUserName | String | test | 消費組帳號。 |
| ConsumptionCheckpoint | String | 2019-10-02T12:00:00Z | 消費位點，即用戶端在訂閱通道內消費最後一條資訊的時間點，格式為yyyy-MM-ddTHH:mm:ssZ（UTC時間）。 |
| MessageDelay | Long | 172714 | 訊息延遲時間=目前時間-資料訂閱通道中存在時間最早的未被消費的訊息的時間戳記，單位為秒。 說明 如果該參數返回-1，則表示當前沒有用戶端串連該消費組。 |
| UnconsumedData | Long | 186600 | 未消費的訊息總數=未被消費的訂閱資料數量+心跳訊息數量 說明 如果該參數返回-1，則表示當前沒有用戶端串連該消費組。 |
| ErrCode | String | InternalError | 調用出錯時返回的錯誤碼。 |
| ErrMessage | String | The request processing has failed due to some unknown error. | 調用錯誤時返回對應的錯誤資訊。 |
| PageNumber | Integer | 1 | 頁碼。 |
| PageRecordCount | Integer | 30 | 一頁最多可展示的消費組數量。 |
| RequestId | String | 4204E899-8193-4D7D-A4FB-3A7F9063**** | 請求ID。 |
| Success | String | true | 請求是否成功。 |
| TotalRecordCount | Integer | 1 | 消費組總數。 |
樣本
請求樣本
http(s)://dts.aliyuncs.com/?Action=DescribeConsumerGroup
&SubscriptionInstanceId=dtso5xx5t9u19e****
&<公用請求參數>正常返回樣本
XML格式
<DescribeConsumerGroupResponse>
<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>30</PageRecordCount>
<RequestId>4204E899-8193-4D7D-A4FB-3A7F9063****</RequestId>
<PageNumber>1</PageNumber>
<ConsumerChannels>
<DescribeConsumerChannel>
<ConsumptionCheckpoint></ConsumptionCheckpoint>
<ConsumerGroupID>dtspis1110z232gbm4</ConsumerGroupID>
<ConsumerGroupUserName>test</ConsumerGroupUserName>
<ConsumerGroupName>consumergrouptest</ConsumerGroupName>
<MessageDelay>-1</MessageDelay>
<UnconsumedData>-1</UnconsumedData>
</DescribeConsumerChannel>
</ConsumerChannels>
<Success>true</Success>
</DescribeConsumerGroupResponse>JSON格式
{
"TotalRecordCount": 1,
"PageRecordCount": 30,
"RequestId": "4204E899-8193-4D7D-A4FB-3A7F9063****",
"PageNumber": 1,
"ConsumerChannels": {
"DescribeConsumerChannel": [
{
"ConsumptionCheckpoint": "2019-10-02T12:00:00Z",
"ConsumerGroupID": "dtspis1110z232gbm4",
"ConsumerGroupUserName": "test",
"ConsumerGroupName": "consumergrouptest",
"MessageDelay": -1,
"UnconsumedData": -1
}
]
},
"Success": true
}錯誤碼
| HttpCode | 錯誤碼 | 錯誤資訊 | 描述 |
| 500 | InternalError | The request processing has failed due to some unknown error. | 系統錯誤 |
訪問錯誤中心查看更多錯誤碼。