Menggunakan OnsConsumerAccumulate untuk menanyakan akumulasi pesan dan latensi konsumsi - ApsaraMQ untuk RocketMQ

Kueri akumulasi pesan untuk Group ID tertentu. Hasilnya mencakup jumlah pesan yang menumpuk dan latensi konsumsi.

Deskripsi operasi

Penting Alibaba Cloud OpenAPI adalah API management yang digunakan untuk mengelola dan mengkueri sumber daya Layanan Alibaba Cloud. Integrasikan API ini hanya ke dalam data link management Anda. Jangan gunakan API ini di data link inti untuk mengirim dan menerima pesan guna menghindari potensi ancaman.

Anda dapat menggunakan kueri akumulasi pesan di lingkungan produksi untuk memantau progres konsumsi Group ID tertentu, yang mencerminkan status konsumsi pesan beserta latensinya. Anda dapat mengkueri akumulasi pesan untuk semua topik yang berlangganan ke Group ID tersebut atau untuk masing-masing topik secara individual.

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

mq:QueryConsumerAccumulate

get

Group

acs:mq:{#regionId}:{#accountId}:{#GroupName}

Group

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}

None

mq:OnsInstanceBaseInfo

Parameter permintaan

Parameter	Type	Required	Description	Example
GroupId	string	Yes	ID Group yang ingin Anda kueri.	GID_test_consumer_id
Detail	boolean	No	Menentukan apakah akan mengkueri detail setiap topik. Nilai yang valid: true: Mengkueri detail. Detail dikembalikan dalam parameter DetailInTopicList. false: Tidak mengkueri detail. Ini adalah nilai default. Parameter DetailInTopicList mengembalikan kosong.	true
InstanceId	string	No	ID instans.	MQ_INST_111111111111_DOxxxxxx

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan. Ini adalah parameter umum. Setiap permintaan memiliki ID unik. Gunakan ID ini untuk melacak dan memecahkan masalah.	CE817BFF-B389-43CD-9419-95011AC9****
Data	object	Akumulasi pesan dari konsumen yang ditentukan.
ConsumeTps	number	Total TPS konsumsi pesan untuk kelompok instans konsumen yang termasuk dalam Group ID yang ditentukan.	10
DelayTime	integer	Latensi konsumsi pesan maksimum untuk Group ID tersebut. Nilainya merupakan latensi konsumsi terpanjang di antara semua topik yang berlangganan ke Group ID tersebut. Unit: milidetik.	10000
LastTimestamp	integer	Waktu produksi pesan yang paling baru dikonsumsi dalam kelompok instans konsumen yang termasuk dalam Group ID yang ditentukan. Unit: Unix timestamp dalam milidetik.	1566231000000
TotalDiff	integer	Jumlah pesan yang menumpuk untuk semua topik yang berlangganan ke Group ID tersebut.	100
Online	boolean	Menunjukkan apakah terdapat instans konsumen yang online di bawah Group ID ini. Jika setidaknya satu instans konsumen online, Group ID tersebut dianggap online. Nilai yang valid: true: Online false: Offline	true
DetailInTopicList	object
DetailInTopicDo	array<object>	Detail setiap topik. Jika parameter Detail dalam permintaan diatur ke false, parameter ini mengembalikan kosong.
	object
DelayTime	integer	Latensi konsumsi pesan maksimum dalam topik ini. Ini adalah selisih waktu antara waktu siap pesan yang belum dikonsumsi paling awal dalam topik tersebut dan waktu saat ini. Unit: milidetik.	10000
TotalDiff	integer	Jumlah pesan yang menumpuk dalam topik tersebut.	100
LastTimestamp	integer	Waktu produksi pesan yang paling baru dikonsumsi dalam topik tersebut. Unit: Unix timestamp dalam milidetik.	1566231000000
Topic	string	Nama topik.	test-mq-topic

Contoh

Respons sukses

JSONformat

{
  "RequestId": "CE817BFF-B389-43CD-9419-95011AC9****",
  "Data": {
    "ConsumeTps": 10,
    "DelayTime": 10000,
    "LastTimestamp": 1566231000000,
    "TotalDiff": 100,
    "Online": true,
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 10000,
          "TotalDiff": 100,
          "LastTimestamp": 1566231000000,
          "Topic": "test-mq-topic"
        }
      ]
    }
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.