ApsaraMQ for RocketMQ:OnsConsumerTimeSpan - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri rentang waktu yang dapat Anda gunakan untuk menentukan titik waktu guna mereset offset konsumen untuk topik tertentu. Rentang waktu dimulai dari titik waktu saat pesan yang paling awal disimpan dipublikasikan ke topik hingga titik waktu saat pesan yang paling baru disimpan dipublikasikan ke topik.

Deskripsi operasi

Catatan

Operasi API yang disediakan oleh Alibaba Cloud digunakan untuk mengelola dan mengkueri sumber daya layanan Alibaba Cloud. Kami menyarankan Anda mengintegrasikan operasi API ini hanya dalam sistem manajemen. Jangan gunakan operasi API ini dalam sistem inti layanan pesan. Jika tidak, risiko sistem dapat terjadi.

Anda dapat memanggil operasi ini untuk mengkueri titik waktu saat pesan yang paling awal disimpan dipublikasikan ke topik tertentu dan titik waktu saat pesan yang paling baru disimpan dipublikasikan ke topik tersebut. Anda juga dapat memanggil operasi ini untuk mengkueri titik waktu terbaru saat pesan dalam topik dikonsumsi. Operasi ini biasanya digunakan bersama dengan operasi **OnsConsumerAccumulate** untuk menampilkan ringkasan kemajuan konsumsi.

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

get

Topic

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

Topic

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

None

mq:OnsInstanceBaseInfo

Parameter permintaan

Parameter	Type	Required	Description	Example
GroupId	string	Yes	ID grup konsumen yang rentang waktu reset-nya ingin Anda kueri.	GID_test_group_id
Topic	string	Yes	Topik tempat grup konsumen berlangganan.	test-mq_topic
InstanceId	string	No	ID instans tempat grup konsumen berada.	MQ_INST_111111111111_DOxxxxxx

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan. Parameter ini adalah parameter umum. Setiap permintaan memiliki ID unik. Anda dapat menggunakan ID ini untuk memecahkan masalah.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	Data yang dikembalikan.
MaxTimeStamp	integer	Titik waktu saat pesan yang paling baru disimpan dipublikasikan ke topik.	1570761026804
ConsumeTimeStamp	integer	Titik waktu terbaru saat pesan dalam topik dikonsumsi oleh grup pelanggan.	1570761026400
Topic	string	Nama topik yang ingin Anda kueri.	test-mq_topic
MinTimeStamp	integer	Titik waktu saat pesan yang paling awal disimpan dipublikasikan ke topik.	1570701231122
InstanceId	string	ID instans tempat grup konsumen berada.	MQ_INST_111111111111_DOxxxxxx

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "MaxTimeStamp": 1570761026804,
    "ConsumeTimeStamp": 1570761026400,
    "Topic": "test-mq_topic",
    "MinTimeStamp": 1570701231122,
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.