All Products
Search

This Product

    ApsaraMQ for RocketMQ:OnsConsumerResetOffset

    Document Center

    ApsaraMQ for RocketMQ:OnsConsumerResetOffset

    Last Updated:Jun 10, 2026

    Mengatur ulang offset konsumen ke pengatur waktu tertentu untuk kelompok konsumen.

    Deskripsi operasi

    Catatan

    API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

    You can call this operation to clear accumulated messages or reset a consumer offset to a specified timestamp. You can use one of the following methods to clear accumulated messages:

    • Clear all accumulated messages in a specified topic.

    • Clear the messages that were published to the specified topic before a specified point in time.

    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 Paket dead-letter-nya ingin Anda kueri.

    GID_test_consumer_id
    Topic

    string

    Yes

    Nama Topik yang offset konsumennya ingin Anda atur ulang.

    test-mq-topic
    Type

    integer

    Yes

    Metode yang ingin Anda gunakan untuk menghapus Paket yang menumpuk. Nilai valid:

    • 0: Semua Paket yang menumpuk dihapus. Paket yang tidak dikonsumsi akan diabaikan. Konsumen dalam kelompok konsumen yang ditentukan hanya mengonsumsi Paket yang dipublikasikan ke Topik setelah pengatur waktu yang ditentukan.

    Jika "reconsumeLater" dikembalikan, Paket yang menumpuk tidak dihapus karena sistem sedang mencoba ulang untuk mengirim kembali Paket ke konsumen.

    • 1: Paket yang dipublikasikan ke Topik sebelum pengatur waktu yang ditentukan dihapus. Anda harus menentukan pengatur waktu. Konsumen dalam kelompok konsumen yang ditentukan hanya mengonsumsi Paket yang dipublikasikan ke Topik setelah pengatur waktu yang ditentukan.

    Anda dapat menentukan pengatur waktu dari pengatur waktu paling awal saat Paket dipublikasikan ke Topik hingga pengatur waktu paling baru saat Paket dipublikasikan ke Topik. Pengatur waktu yang tidak berada dalam Rentang Waktu yang diizinkan tidak valid.

    1
    ResetTimestamp

    integer

    No

    Pengatur waktu yang ingin Anda gunakan untuk mengatur ulang offset konsumen. Parameter ini hanya berlaku jika parameter Type diatur ke 1. Unit: milliseconds.

    1591153871000
    InstanceId

    string

    No

    ID Instans tempat kelompok konsumen berada.

    MQ_INST_111111111111_DOxxxxxx

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.

    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.