OnsConsumerResetOffset - ApsaraMQ for RocketMQ

Deskripsi operasi

Catatan

Operasi API yang disediakan oleh Alibaba Cloud digunakan untuk mengelola dan melakukan kueri terhadap sumber daya layanan Alibaba Cloud. Kami menyarankan agar Anda hanya mengintegrasikan operasi API ini dalam sistem manajemen, bukan dalam sistem inti layanan messaging, karena penggunaannya di sistem inti dapat menimbulkan risiko.

Anda dapat memanggil operasi ini untuk menghapus pesan yang terakumulasi atau mereset offset konsumen ke timestamp tertentu. Berikut dua metode yang tersedia untuk menghapus pesan terakumulasi:

Hapus semua pesan yang terakumulasi dalam topik tertentu.
Hapus pesan yang dipublikasikan ke topik tertentu sebelum titik waktu tertentu.

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

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 kelompok konsumen yang ingin Anda kueri pesan dead-letter-nya.	GID_test_consumer_id
Topic	string	Yes	Nama topik yang offset konsumennya ingin Anda reset.	test-mq-topic
Type	integer	Yes	Metode yang ingin Anda gunakan untuk menghapus pesan yang terakumulasi. Nilai yang valid: 0: Semua pesan yang terakumulasi dihapus. Pesan yang belum dikonsumsi diabaikan. Konsumen dalam kelompok konsumen yang ditentukan hanya akan mengonsumsi pesan yang dipublikasikan ke topik setelah titik waktu tertentu. Jika "reconsumeLater" dikembalikan, pesan yang terakumulasi tidak dihapus karena sistem sedang mencoba mengirim ulang pesan tersebut ke konsumen. 1: Pesan yang dipublikasikan ke topik sebelum titik waktu tertentu dihapus. Anda harus menentukan titik waktu tersebut. Konsumen dalam kelompok konsumen yang ditentukan hanya akan mengonsumsi pesan yang dipublikasikan ke topik setelah titik waktu tersebut. Anda dapat menentukan titik waktu mulai dari titik waktu paling awal saat pesan dipublikasikan ke topik hingga titik waktu paling baru saat pesan dipublikasikan ke topik. Titik waktu yang berada di luar rentang waktu yang diizinkan tidak valid.	1
ResetTimestamp	integer	No	Timestamp yang menjadi tujuan reset offset konsumen. Parameter ini hanya berlaku ketika parameter Type diatur ke 1. Satuan: milidetik.	1591153871000
InstanceId	string	No	ID instans tempat kelompok konsumen tersebut berada.	MQ_INST_111111111111_DOxxxxxx

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan. Parameter ini merupakan parameter umum. Setiap permintaan memiliki ID unik. Anda dapat menggunakan ID ini untuk memecahkan masalah.	D52C68F8-EC5D-4294-BFFF-1A6A25AF****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D52C68F8-EC5D-4294-BFFF-1A6A25AF****"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.