Gunakan OnsConsumerStatus untuk mendiagnosis masalah grup konsumen - ApsaraMQ for RocketMQ

Operasi ini mengkueri data status terperinci untuk ID grup tertentu, termasuk pemeriksaan hubungan subscription, statistik TPS konsumsi, status load balancing, dan koneksi sisi consumer.

Deskripsi operasi

Penting OpenAPI Alibaba Cloud merupakan API management. API ini digunakan untuk mengelola dan mengkueri sumber daya Alibaba Cloud. Gunakan hanya dalam alur kerja manajemen. Jangan mengandalkan OpenAPI dalam alur kerja inti penerbitan atau konsumsi pesan. Melakukannya dapat menimbulkan risiko.

Anda dapat menggunakan operasi ini untuk memecahkan masalah konsumsi yang tidak normal setelah memastikan adanya akumulasi pesan atau status online client. Responsnya membantu Anda memverifikasi konsistensi hubungan subscription untuk ID grup tertentu, memastikan load balancing berjalan normal, serta mengambil informasi Jstack dari client yang sedang online.
Operasi ini memanggil banyak antarmuka backend untuk mengagregasi data, sehingga dapat berjalan lambat. Hindari pemanggilan yang terlalu sering.

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:QueryConsumerStatus

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 grup consumer yang akan dikueri.	GID_test_group_id
Detail	boolean	No	Apakah akan mengembalikan informasi terperinci. Nilai yang valid: true: Mengembalikan informasi terperinci, termasuk ConsumerConnectionInfoList dan DetailInTopicList. false: Nilai default. Tidak mengembalikan informasi terperinci. ConsumerConnectionInfoList dan DetailInTopicList kosong.	true
NeedJstack	boolean	No	Apakah akan mencetak informasi Jstack. Nilai yang valid: true: Mencetak informasi Jstack. Ambil jejak stack dari bidang respons Jstack. Catatan Untuk mencetak informasi Jstack, atur parameter permintaan Detail ke true. false: Nilai default. Tidak mencetak informasi Jstack. Bidang respons Jstack kosong.	true
InstanceId	string	No	ID instans yang terkait dengan ID grup yang akan dikueri.	MQ_INST_111111111111_DOxxxxxx

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	Parameter umum. Setiap permintaan memiliki ID unik. Gunakan ID ini untuk melokalisasi dan memecahkan masalah.	10EDC518-10E7-4B34-92FB-171235FA****
Data	object	Hasil kueri.
ConsumeTps	number	Total TPS konsumsi.	0
ConsumeModel	string	Model konsumsi. Nilai yang valid: CLUSTERING: Mode konsumsi clustering BROADCASTING: Mode konsumsi broadcasting Untuk informasi lebih lanjut tentang mode subscription ini, lihat Clustering and broadcasting consumption.	CLUSTERING
ConnectionSet	object
ConnectionDo	array<object>	Informasi tentang client yang sedang online di kluster.
	object
RemoteIP	string	Alamat IP host atau Alamat IP publik.	42.120.74.**
Version	string	Versi consumer.	V4_3_6_SNAPSHOT
ClientAddr	string	Alamat dan Port instans consumer.	30.5.121.**
Language	string	Bahasa consumer.	JAVA
ClientId	string	ID instans consumer.	30.5.121.**@25560#-1999745829#-1737591554#458773089270275
Diff	integer		100
TotalDiff	integer	Total akumulasi pesan di seluruh kluster.	197
ConsumerConnectionInfoList	object
ConsumerConnectionInfoDo	array<object>	Informasi terperinci tentang client yang sedang online di kluster, termasuk Jstack dan RT konsumsi. Untuk mendapatkan informasi ini, atur parameter permintaan Detail ke true. Jika tidak, responsnya kosong.
	array<object>	test, this content is not published to ICMS
ConsumeModel	string	Model konsumsi. Nilai yang valid: CLUSTERING: Mode konsumsi clustering BROADCASTING: Mode konsumsi broadcasting Untuk informasi lebih lanjut tentang mode subscription ini, lihat Clustering and broadcasting consumption.	CLUSTERING
RunningDataList	object
ConsumerRunningDataDo	array<object>	Statistik status Real-time.
	object
Rt	number	waktu respons (RT) konsumsi, dalam milidetik.	0
Topic	string	Nama topik yang dilanggani.	test-mq_topic
FailedCountPerHour	integer	Jumlah pesan yang gagal dikonsumsi per jam.	0
OkTps	number	TPS untuk pesan yang berhasil dikonsumsi.	0
FailedTps	number	TPS untuk pesan yang gagal dikonsumsi.	0
SubscriptionSet	object
SubscriptionData	array<object>	Kumpulan hubungan subscription.
	array<object>
SubString	string	Ekspresi tag yang digunakan untuk melanggani topik.	*
SubVersion	integer	Nomor versi hubungan subscription. Ini adalah bilangan bulat panjang auto-increment.	1570701364301
Topic	string	Nama topik yang dilanggani.	test-mq_topic
TagsSet	object
Tag	array	Kumpulan tag yang dilanggani.
	string	Kumpulan tag yang dilanggani.	ff
Jstack	object
ThreadTrackDo	array<object>	Jejak stack Jstack. Untuk mendapatkan informasi Jstack, atur parameter permintaan NeedJstack ke true. Jika tidak, responsnya kosong.
	array<object>	test—this content is not published to ICMS
TrackList	object
Track	array	String jejak stack Jstack.
	string	String jejak stack Jstack.	TID: 52 STATE: WAITING
Thread	string	Nama thread.	ConsumeMessageThread_0
LastTimeStamp	integer	Timestamp konsumsi terakhir. Nilai ini menggunakan timestamp Unix tingkat milidetik.	1570701368114
StartTimeStamp	integer	Timestamp saat konsumsi dimulai. Nilai ini menggunakan timestamp Unix tingkat milidetik.	1570701361528
Language	string	Bahasa client.	JAVA
ClientId	string	ID instans consumer.	30.5..@25560#-1999745829#-1737591554#458773089270275
Connection	string	Informasi koneksi.	**
Version	string	Nomor versi client.	V4_3_6
ConsumeType	string	Mode konsumsi pesan. Nilai yang valid: PUSH: ApsaraMQ for RocketMQ mendorong pesan ke consumer. PULL: Consumer menarik pesan dari ApsaraMQ for RocketMQ.	PUSH
ThreadCount	integer	Jumlah thread konsumsi.	20
InstanceId	string	ID instans.	MQ_INST_111111111111_DOxxxxxx
DetailInTopicList	object
DetailInTopicDo	array<object>	Detail konsumsi untuk setiap topik. Untuk mendapatkan informasi ini, atur parameter permintaan Detail ke true. Jika tidak, responsnya kosong.
	object
DelayTime	integer	Waktu tunda konsumsi untuk topik tertentu, dalam milidetik.	0
TotalDiff	integer	Total akumulasi pesan untuk topik tersebut.	0
LastTimestamp	integer	Timestamp konsumsi terakhir. Nilai ini menggunakan timestamp Unix tingkat milidetik.	1570701259403
Topic	string	Nama topik.	test-mq_topic
SubscriptionSame	boolean	Apakah hubungan subscription konsisten.	true
DelayTime	integer	Waktu tunda konsumsi maksimum di semua topik yang dilanggani oleh ID grup tertentu, dalam milidetik.	100857
LastTimestamp	integer	Timestamp konsumsi terakhir. Nilai ini menggunakan timestamp Unix tingkat milidetik.	1566883844954
Online	boolean	Apakah client sedang online.	true
RebalanceOK	boolean	Apakah penyeimbangan ulang normal. Nilai yang valid: true: Normal false: Tidak normal	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "10EDC518-10E7-4B34-92FB-171235FA****",
  "Data": {
    "ConsumeTps": 0,
    "ConsumeModel": "CLUSTERING",
    "ConnectionSet": {
      "ConnectionDo": [
        {
          "RemoteIP": "42.120.74.**",
          "Version": "V4_3_6_SNAPSHOT",
          "ClientAddr": "30.5.121.**",
          "Language": "JAVA",
          "ClientId": "30.5.121.**@25560#-1999745829#-1737591554#458773089270275",
          "Diff": 100
        }
      ]
    },
    "TotalDiff": 197,
    "ConsumerConnectionInfoList": {
      "ConsumerConnectionInfoDo": [
        {
          "ConsumeModel": "CLUSTERING",
          "RunningDataList": {
            "ConsumerRunningDataDo": [
              {
                "Rt": 0,
                "Topic": "test-mq_topic",
                "FailedCountPerHour": 0,
                "OkTps": 0,
                "FailedTps": 0
              }
            ]
          },
          "SubscriptionSet": {
            "SubscriptionData": [
              {
                "SubString": "*",
                "SubVersion": 1570701364301,
                "Topic": "test-mq_topic",
                "TagsSet": {
                  "Tag": [
                    "ff"
                  ]
                }
              }
            ]
          },
          "Jstack": {
            "ThreadTrackDo": [
              {
                "TrackList": {
                  "Track": [
                    "TID: 52 STATE: WAITING"
                  ]
                },
                "Thread": "ConsumeMessageThread_0"
              }
            ]
          },
          "LastTimeStamp": 1570701368114,
          "StartTimeStamp": 1570701361528,
          "Language": "JAVA",
          "ClientId": "30.5.**.**@25560#-1999745829#-1737591554#458773089270275",
          "Connection": "**",
          "Version": "V4_3_6",
          "ConsumeType": "PUSH",
          "ThreadCount": 20
        }
      ]
    },
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 0,
          "TotalDiff": 0,
          "LastTimestamp": 1570701259403,
          "Topic": "test-mq_topic"
        }
      ]
    },
    "SubscriptionSame": true,
    "DelayTime": 100857,
    "LastTimestamp": 1566883844954,
    "Online": true,
    "RebalanceOK": true
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.