Menggunakan OnsTrendGroupOutputTps untuk menanyakan statistik konsumsi pesan - ApsaraMQ untuk RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Deskripsi operasi

Penting Alibaba Cloud OpenAPI is a control plane API used to manage and query resources of Alibaba Cloud services. You can integrate OpenAPI only on the control plane. Do not use OpenAPI for the core data link of message sending and receiving because this can pose a threat to the link.

When you generate consumption data reports in a production environment, you can use this operation to query the following statistics for a specified group ID over a period of time:

A statistical curve of the total number of consumed messages
A statistical curve of the Transaction Per Second (TPS) for message consumption

If your application has a small and uneven volume of messages, querying by TPS may not return meaningful data. In this case, you can query the total number of consumed messages.

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

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 kelompok yang akan dikueri.	GID_test
Topic	string	Yes	Nama topik yang akan dikueri.	test
BeginTime	integer	Yes	Awal rentang waktu yang akan dikueri. Nilai ini adalah Stempel waktu UNIX dalam milidetik.	1570852800000
EndTime	integer	Yes	Akhir rentang waktu yang akan dikueri. Nilai ini adalah Stempel waktu UNIX dalam milidetik.	1570868400000
Type	integer	Yes	Jenis informasi yang akan dikueri. Nilai valid: 0: Kurva statistik jumlah total Paket yang dikonsumsi. 1: Kurva statistik TPS untuk konsumsi Paket.	0
InstanceId	string	No	ID instans tempat kelompok berada.	MQ_INST_111111111111_DOxxxxxx
Period	integer	No	Periode sampling. Unit: menit. Nilai valid: 1, 5, dan 10.	10

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. This is a common parameter. Each request has a unique ID that you can use to troubleshoot issues.	CE57AEDC-8FD2-43ED-8E3B-1F878077****
Data	object	The returned data.
Records	object
StatsDataDo	array<object>	The data set returned based on sampling period.
	object
Y	number	The Y axis. This parameter indicates the TPS for message consumption or the number of messages that are consumed.	0
X	integer	The X axis. The value of this parameter is a UNIX timestamp in milliseconds.	1570867800000
XUnit	string	The unit of the x-axis. The time is measured in ms.	ms
YUnit	string	The unit of the y-axis. The value can be the number of consumed messages (msg) or the TPS for message consumption (msg/min).	msg
Title	string	The name of the table.	TopicXXX@GID_XXXReceive Trend Chart

Contoh

Respons sukses

JSONformat

{
  "RequestId": "CE57AEDC-8FD2-43ED-8E3B-1F878077****",
  "Data": {
    "Records": {
      "StatsDataDo": [
        {
          "Y": 0,
          "X": 1570867800000
        }
      ]
    },
    "XUnit": "ms",
    "YUnit": "msg",
    "Title": "TopicXXX@GID_XXXReceive Trend Chart"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.