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

Deskripsi operasi

Penting

Alibaba Cloud OpenAPI is a management API. You can use it to manage and query Alibaba Cloud service resources. This API is intended for management purposes only. Do not use this API for core data links that send and receive messages because this may introduce potential threats to your data links.

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 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	The updated remarks for the consumer group.	This is the remark for test.
deliveryOrderType `deprecated`	string	No	This parameter cannot be modified.	Concurrently
consumeRetryPolicy	object	Yes	The updated consumption retry policy for the consumer group. For more information, see Consumption retry.
retryPolicy	string	Yes	The retry policy. For more information, see Message retry. Valid values: FixedRetryPolicy: fixed interval retry. This policy applies only to orderly messages. DefaultRetryPolicy: backoff retry. This policy applies only to concurrent messages. Valid values: FixedRetryPolicy : Fixed interval retry DefaultRetryPolicy : Backoff retry	DefaultRetryPolicy
maxRetryTimes	integer	No	The maximum number of retries.	16
deadLetterTargetTopic	string	No	The dead-letter topic. If a message fails to be consumed after the maximum number of retries, the message is sent to a dead-letter topic. You can then perform business recovery or trace the message. For more information, see Consumption retry and dead-letter messages.	DLQ_mqtest
fixedIntervalRetryTime	integer	No	The fixed retry interval. Unit: seconds. This parameter is valid only if you set the retryPolicy parameter to FixedRetryPolicy. Value range: Concurrent delivery: 10 to 1800 Orderly delivery: 1 to 600	10
maxReceiveTps	integer	No	The maximum transactions per second (TPS) for message consumption.	1000

Elemen respons

Element	Type	Description	Example
	object	Result<boolean>
requestId	string	The request ID. Each request has a unique ID. You can use this ID to troubleshoot issues.	C7F94090-3358-506A-97DC-34BC803C****
success	boolean	Indicates whether the request was successful.	true
data	boolean	The returned result.	true
code	string	The error code.	InvalidDeliveryOrderType
message	string	The error message.	Parameter deliveryOrderType is invalid.
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	DeliveryOrderType
dynamicMessage	string	The dynamic error message.	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.