Gunakan UpdateConsumerGroup API - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Deskripsi operasi

Penting OpenAPI yang disediakan oleh Alibaba Cloud adalah API manajemen dan kontrol yang digunakan untuk mengelola dan mengkueri resource layanan Alibaba Cloud. API ini hanya direkomendasikan untuk integrasi dalam tautan manajemen dan kontrol. Jangan gunakan OpenAPI dalam tautan data inti untuk mengirim dan menerima Paket. Jika tidak, risiko dapat terjadi pada tautan data.

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

rocketmq:UpdateConsumerGroup

update

*Kelompok Konsumen.

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}

None

Sintaks permintaan

PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans tempat kelompok konsumen yang akan diperbarui berada.	rmq-cn-7e22on9****
consumerGroupId	string	Yes	ID kelompok konsumen yang akan diperbarui.	CID-TEST

Parameter permintaan

Parameter	Type	Required	Description	Example
body	object	No	Badan permintaan.
remark	string	No	Keterangan kelompok konsumen yang diperbarui.	Ini adalah keterangan untuk pengujian
deliveryOrderType `deprecated`	string	No	Modifikasi tidak didukung. Valid values: Concurrently : Pengiriman konkuren. Orderly : Pengiriman berurutan.	Concurrently
consumeRetryPolicy	object	Yes	Kebijakan retry konsumsi yang diperbarui dari kelompok konsumen. Untuk informasi selengkapnya, lihat Consumption retry.
retryPolicy	string	Yes	Tipe kebijakan retry. Untuk informasi selengkapnya, lihat Message retry. Nilai valid: FixedRetryPolicy: retry interval tetap. Hanya mendukung pengiriman Pesanan. DefaultRetryPolicy: retry backoff inkremental. Hanya mendukung pengiriman konkuren. Valid values: FixedRetryPolicy : Retry interval tetap. DefaultRetryPolicy : Retry backoff inkremental.	DefaultRetryPolicy
maxRetryTimes	integer	No	Jumlah retry maksimum.	16
deadLetterTargetTopic	string	No	Topik dead-letter. Jika konsumen gagal mengonsumsi Paket dan Paket tetap gagal setelah retry, Paket akan dikirim ke topik dead-letter untuk pemulihan atau peninjauan bisnis berikutnya. Untuk informasi selengkapnya, lihat Consumption retry and dead-letter messages.	DLQ_mqtest
fixedIntervalRetryTime	integer	No	Interval retry tetap. Unit: detik. Parameter ini hanya berlaku ketika kebijakan retry diatur ke FixedRetryPolicy (retry interval tetap). Nilai valid: Pengiriman konkuren: 10-1800 Pengiriman berurutan: 1-600	10
maxReceiveTps	integer	No	Batas atas TPS untuk mengonsumsi Paket.	1000

Elemen respons

Element	Type	Description	Example
	object	Result
requestId	string	ID permintaan. Setiap permintaan memiliki ID unik yang dapat Anda gunakan untuk memecahkan masalah dan melacak masalah.	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	Apakah eksekusi berhasil.	true
data	boolean	Hasil yang dikembalikan.	true
code	string	Kode error.	InvalidDeliveryOrderType
message	string	Paket error.	Parameter deliveryOrderType tidak valid
httpStatusCode	integer	Kode status HTTP.	400
dynamicCode	string	Kode error dinamis.	DeliveryOrderType
dynamicMessage	string	Paket error dinamis.	deliveryOrderType

Contoh

Respons sukses

JSONformat

{
  "requestId": "C7F94090-3358-506A-97DC-34BC803C****",
  "success": true,
  "data": true,
  "code": "InvalidDeliveryOrderType",
  "message": "Parameter deliveryOrderType is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "DeliveryOrderType",
  "dynamicMessage": "deliveryOrderType"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.