調(diào)用DescribeConsumerGroup接口查詢數(shù)據(jù)訂閱實(shí)例中的消費(fèi)組詳情。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeConsumerGroup

系統(tǒng)規(guī)定參數(shù)，取值：DescribeConsumerGroup。

SubscriptionInstanceId String 是 dtso5xx5t9u19e****

數(shù)據(jù)訂閱實(shí)例ID，可以通過(guò)調(diào)用DescribeSubscriptionInstances接口查詢。
RegionId String 否 cn-hangzhou

數(shù)據(jù)訂閱實(shí)例所在地域的ID，詳情請(qǐng)參見(jiàn)支持的地域列表。

PageSize Integer 否 30

每頁(yè)記錄數(shù)，取值： 30、50、100，默認(rèn)值為30。

PageNum Integer 否 1

頁(yè)碼，取值為大于0且不超過(guò)Integer數(shù)據(jù)類型的最大值，默認(rèn)值為1。

AccountId String 否 12323344****

阿里云主賬號(hào)ID，無(wú)需設(shè)置，該參數(shù)即將下線。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
ConsumerChannels Array of DescribeConsumerChannel

消費(fèi)組列表。
DescribeConsumerChannel
ConsumerGroupID String dtspis1110z232****

消費(fèi)組ID。
ConsumerGroupName String consumergrouptest

消費(fèi)組名稱。
ConsumerGroupUserName String test

消費(fèi)組賬號(hào)。
ConsumptionCheckpoint String 2019-10-02T12:00:00Z

消費(fèi)位點(diǎn)，即客戶端在訂閱通道內(nèi)消費(fèi)最后一條信息的時(shí)間點(diǎn)，格式為yyyy-MM-ddTHH:mm:ssZ（UTC時(shí)間）。

MessageDelay Long 172714

消息延遲時(shí)間=當(dāng)前時(shí)間-數(shù)據(jù)訂閱通道中存在時(shí)間最早的未被消費(fèi)的消息的時(shí)間戳，單位為秒。

說(shuō)明 如果該參數(shù)返回-1，則表示當(dāng)前沒(méi)有客戶端連接該消費(fèi)組。
UnconsumedData Long 186600

未消費(fèi)的消息總數(shù)=未被消費(fèi)的訂閱數(shù)據(jù)數(shù)量+心跳消息數(shù)量

說(shuō)明 如果該參數(shù)返回-1，則表示當(dāng)前沒(méi)有客戶端連接該消費(fèi)組。
ErrCode String InternalError

調(diào)用出錯(cuò)時(shí)返回的錯(cuò)誤碼。
ErrMessage String The request processing has failed due to some unknown error.

調(diào)用錯(cuò)誤時(shí)返回對(duì)應(yīng)的錯(cuò)誤信息。
PageNumber Integer 1

頁(yè)碼。
PageRecordCount Integer 30

一頁(yè)最多可展示的消費(fèi)組數(shù)量。
RequestId String 4204E899-8193-4D7D-A4FB-3A7F9063****

請(qǐng)求ID。
Success String true

請(qǐng)求是否成功。
TotalRecordCount Integer 1

消費(fèi)組總數(shù)。

示例

請(qǐng)求示例

http(s)://dts.aliyuncs.com/?Action=DescribeConsumerGroup
&SubscriptionInstanceId=dtso5xx5t9u19e****
&<公共請(qǐng)求參數(shù)>

正常返回示例

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
}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
500 InternalError The request processing has failed due to some unknown error. 系統(tǒng)錯(cuò)誤

訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。