Monitor Keterlambatan Grup Konsumen dengan API GetConsumerGroupLag - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri akumulasi pesan dari grup konsumen.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

rocketmq:GetConsumerGroupLag

get

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}

None

Sintaks permintaan

GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/lag HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans.	rmq-cn-2r42vrvde0j
consumerGroupId	string	Yes	ID grup konsumen.	CID-TEST

Parameter permintaan

Parameter	Type	Required	Description	Example
topicName	string	No	Nama topik yang dilanggan oleh grup konsumen.	normal-topic-1
liteTopicName	string	No	Nama lite topic.	abc

Elemen respons

Element	Type	Description	Example
	object	Result<ConsumerGroupLagDto>
requestId	string	ID permintaan.	F5764C40-FB8C-53AE-B95D-96AB3D0E9375
success	boolean	Menunjukkan apakah permintaan berhasil.	true
data	object	Data yang dikembalikan.
regionId	string	ID wilayah.	cn-hangzhou
instanceId	string	ID instans.	rmq-cn-7e22ody****
consumerGroupId	string	ID grup konsumen.	CID-TEST
totalLag	object	Total akumulasi pesan.
readyCount	integer	The number of ready messages.	1
inflightCount	integer	The number of inflight messages.	1
deliveryDuration	integer	The delivery latency. Unit: seconds.	12
lastConsumeTimestamp	integer	The timestamp of the last consumption.	1735629607846
topicLagMap	object	Akumulasi pesan untuk setiap topik.
	object	Detail akumulasi pesan.
readyCount	integer	The number of ready messages.	1
inflightCount	integer	The number of inflight messages.	1
deliveryDuration	integer	The delivery latency. Unit: seconds.	12
lastConsumeTimestamp	integer	The timestamp of the last consumption.	1735629607846
topicName	string	Nama topik yang dilanggan.	test1
liteTopicLagMap	object	Akumulasi pesan untuk lite topic.
	object	Akumulasi pesan untuk lite topic.
readyCount	integer	The number of accumulated messages.	300
deliveryDuration	integer	The delivery latency. Unit: seconds.	30
code	string	Kode kesalahan.	Topic.NotFound
message	string	Pesan kesalahan.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	Kode status HTTP.	200
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Pesan kesalahan dinamis.	instanceId

Contoh

Respons sukses

JSONformat

{
  "requestId": "F5764C40-FB8C-53AE-B95D-96AB3D0E9375",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "totalLag": {
      "readyCount": 1,
      "inflightCount": 1,
      "deliveryDuration": 12,
      "lastConsumeTimestamp": 1735629607846
    },
    "topicLagMap": {
      "key": {
        "readyCount": 1,
        "inflightCount": 1,
        "deliveryDuration": 12,
        "lastConsumeTimestamp": 1735629607846
      }
    },
    "topicName": "test1",
    "liteTopicLagMap": {
      "key": {
        "readyCount": 300,
        "deliveryDuration": 30
      }
    }
  },
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.