DescribeConsumerGroup - Data Transmission Service - Alibaba Cloud Documentation Center

Mengkueri detail kelompok konsumen dalam instance pelacakan perubahan.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara otomatis menghasilkan contoh kode operasi untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeConsumerGroup	Operasi yang ingin Anda lakukan. Tetapkan parameter ini ke DescribeConsumerGroup.
SubscriptionInstanceId	String	Yes	dtso5xx5t9u19e****	ID instans pelacakan perubahan. Anda dapat memanggil operasi untuk mengkueri ID instans tersebut.
RegionId	String	No	cn-hangzhou	ID wilayah tempat instans pelacakan perubahan berada. Untuk informasi selengkapnya, lihat Daftar wilayah yang didukung.
PageSize	Integer	No	30	Jumlah entri yang ditampilkan per halaman. Nilai yang valid: 30, 50, dan 100. Nilai default: 30.
PageNum	Integer	No	1	Nomor halaman yang akan ditampilkan. Nilainya harus berupa bilangan bulat yang lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1.
AccountId	String	No	12323344****	ID Akun Alibaba Cloud. Anda tidak perlu menentukan parameter ini karena parameter ini akan dihapus di masa mendatang.

Parameter respons

Parameter	Type	Example	Description
ConsumerChannels	Array of DescribeConsumerChannel		Daftar kelompok konsumen.
DescribeConsumerChannel
ConsumerGroupID	String	dtspis1110z232****	ID kelompok konsumen.
ConsumerGroupName	String	consumergrouptest	Nama kelompok konsumen.
ConsumerGroupUserName	String	test	Username kelompok konsumen.
ConsumptionCheckpoint	String	2019-10-02T12:00:00Z	Titik pemeriksaan konsumsi, yaitu waktu saat catatan data terbaru dikonsumsi oleh client pelacakan perubahan. Formatnya adalah yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.
MessageDelay	Long	172714	Penundaan pesan, yaitu waktu saat ini dikurangi stempel waktu pesan yang belum dikonsumsi paling awal dalam instans pelacakan perubahan. Satuan: detik. Catatan Jika nilai kembali parameter ini adalah -1, tidak ada client yang terhubung ke kelompok konsumen tersebut.
UnconsumedData	Long	186600	Jumlah total pesan yang belum dikonsumsi, yaitu jumlah catatan data yang belum dikonsumsi ditambah jumlah pesan heartbeat. Catatan Jika nilai kembali parameter ini adalah -1, tidak ada client yang terhubung ke kelompok konsumen tersebut.
ErrCode	String	InternalError	Kode kesalahan yang dikembalikan jika pemanggilan gagal.
ErrMessage	String	The request processing has failed due to some unknown error.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
PageNumber	Integer	1	Nomor halaman dari halaman yang dikembalikan.
PageRecordCount	Integer	30	Jumlah maksimum kelompok konsumen yang dapat ditampilkan dalam satu halaman.
RequestId	String	4204E899-8193-4D7D-A4FB-3A7F9063****	ID permintaan.
Success	String	true	Menunjukkan apakah pemanggilan berhasil atau tidak.
TotalRecordCount	Integer	1	Jumlah total kelompok konsumen.

Contoh

Contoh permintaan

http(s)://dts.aliyuncs.com/?Action=DescribeConsumerGroup
&SubscriptionInstanceId=dtso5xx5t9u19e****
&<Common request parameters>

Contoh respons

XML format

<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 format

{
    "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
}

Kode kesalahan

HttpCode	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.	Pesan kesalahan yang dikembalikan karena terjadi kesalahan sistem.

Untuk daftar kode kesalahan, kunjungi API Error Center.