UpdateConsumerGroup - ApsaraMQ for RocketMQ

Deskripsi operasi

Penting Alibaba Cloud OpenAPI adalah API management. Anda dapat menggunakannya untuk mengelola dan mengkueri sumber daya Layanan Alibaba Cloud. API ini hanya ditujukan untuk keperluan manajemen. Jangan gunakan API ini untuk tautan data inti yang mengirim dan menerima pesan karena hal ini dapat menimbulkan ancaman potensial terhadap tautan data Anda.

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

*ConsumerGroup

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 tersebut 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 yang diperbarui untuk kelompok konsumen.	This is the remark for test.
deliveryOrderType `deprecated`	string	No	Parameter ini tidak dapat diubah. Valid values: Concurrently : Concurrent Orderly : Orderly	Concurrently
consumeRetryPolicy	object	Yes	Kebijakan retry konsumsi yang diperbarui untuk kelompok konsumen. Untuk informasi selengkapnya, lihat Consumption retry.
retryPolicy	string	Yes	Kebijakan retry. Untuk informasi selengkapnya, lihat Message retry. Nilai yang valid: FixedRetryPolicy: retry dengan interval tetap. Kebijakan ini hanya berlaku untuk pesan orderly. DefaultRetryPolicy: retry dengan backoff. Kebijakan ini hanya berlaku untuk pesan concurrent. Valid values: FixedRetryPolicy : Fixed interval retry DefaultRetryPolicy : Backoff retry	DefaultRetryPolicy
maxRetryTimes	integer	No	Jumlah maksimum retry.	16
deadLetterTargetTopic	string	No	Topik dead-letter. Jika sebuah pesan gagal dikonsumsi setelah mencapai jumlah maksimum retry, pesan tersebut akan dikirim ke topik dead-letter. Anda kemudian dapat melakukan pemulihan bisnis atau melacak pesan tersebut. Untuk informasi selengkapnya, lihat Consumption retry and dead-letter messages.	DLQ_mqtest
fixedIntervalRetryTime	integer	No	Interval retry tetap. Satuan: detik. Parameter ini hanya berlaku jika Anda mengatur parameter retryPolicy ke FixedRetryPolicy. Rentang nilai: Pengiriman concurrent: 10 hingga 1800 Pengiriman orderly: 1 hingga 600	10
maxReceiveTps	integer	No	Transaksi per detik (TPS) maksimum untuk konsumsi pesan.	1000

Elemen respons

Element	Type	Description	Example
	object	Result<boolean>
requestId	string	ID permintaan. Setiap permintaan memiliki ID unik. Anda dapat menggunakan ID ini untuk memecahkan masalah.	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	Menunjukkan apakah permintaan berhasil.	true
data	boolean	Hasil yang dikembalikan.	true
code	string	Kode kesalahan.	InvalidDeliveryOrderType
message	string	Pesan kesalahan.	Parameter deliveryOrderType is invalid.
httpStatusCode	integer	Kode status HTTP.	400
dynamicCode	string	Kode kesalahan dinamis.	DeliveryOrderType
dynamicMessage	string	Pesan kesalahan 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.