UpdateInstance - ApsaraMQ for RocketMQ

Memperbarui informasi dasar dan spesifikasi instans ApsaraMQ for RocketMQ.

Deskripsi operasi

Catatan

Operasi API yang disediakan oleh Alibaba Cloud digunakan untuk mengelola dan mengkueri resource Layanan Alibaba Cloud. Kami menyarankan Anda hanya mengintegrasikan operasi API ini dalam sistem manajemen, bukan dalam sistem inti layanan messaging, karena dapat menimbulkan risiko sistem.

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

update

*Instance

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

None

Sintaks permintaan

PATCH /instances/{instanceId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans yang informasi dasar dan spesifikasinya ingin Anda perbarui.	rmq-cn-7e22ody****

Parameter permintaan

Parameter	Type	Required	Description	Example
body	object	No	Badan permintaan.
instanceName	string	No	Nama instans yang diperbarui.	test_instance
remark	string	No	Deskripsi instans yang diperbarui.	This is the remark for test.
networkInfo	object	No	Informasi jaringan instans yang diperbarui.
internetInfo	object	No	Informasi tentang Internet tempat instans diakses. Parameter ini hanya berlaku jika fitur akses Internet diaktifkan untuk instans tersebut.
ipWhitelist	array	No	Daftar putih yang mencakup alamat IP yang diizinkan untuk mengakses broker ApsaraMQ for RocketMQ melalui Internet. Jika Anda tidak mengonfigurasi daftar putih alamat IP, semua Blok CIDR diizinkan mengakses broker ApsaraMQ for RocketMQ melalui Internet. Jika Anda mengonfigurasi daftar putih alamat IP, hanya alamat IP dalam daftar putih yang diizinkan mengakses broker ApsaraMQ for RocketMQ melalui Internet.
	string	No	Alamat IP dalam daftar putih.	192.168.x.x/24
productInfo	object	No	Konfigurasi tambahan instans.
sendReceiveRatio	number	No	Rasio jumlah pesan yang dapat Anda kirim terhadap jumlah pesan yang dapat Anda terima pada instans tersebut. Nilai yang valid: 0,25 hingga 1.	0.5
autoScaling	boolean	No	Menentukan apakah akan mengaktifkan fitur transaksi per detik (TPS) elastis untuk instans tersebut. Nilai yang valid: true false Setelah Anda mengaktifkan fitur TPS elastis untuk instans ApsaraMQ for RocketMQ, Anda dapat menggunakan jumlah TPS tertentu yang melebihi batas spesifikasi. Anda akan dikenai biaya penggunaan fitur TPS elastis. Untuk informasi selengkapnya, lihat Computing fees. Catatan Fitur TPS elastis hanya didukung oleh edisi instans tertentu. Untuk informasi selengkapnya, lihat Instance editions. Valid values: true : 开启弹性 false : 关闭弹性	true
messageRetentionTime	integer	No	Periode retensi pesan. Satuan: jam. Untuk informasi tentang nilai yang valid untuk parameter ini, lihat bagian "Batas kuota sumber daya" dalam topik Limits. ApsaraMQ for RocketMQ mendukung penskalaan penyimpanan pesan arsitektur tanpa server. Anda dikenai biaya penyimpanan berdasarkan Penggunaan penyimpanan aktual Anda. Anda dapat mengubah periode retensi pesan untuk mengelola kapasitas penyimpanan. Untuk informasi selengkapnya, lihat Storage fees.	72
traceOn	boolean	No	Menentukan apakah akan mengaktifkan fitur jejak pesan. true false Parameter ini tidak sedang digunakan. Secara default, fitur jejak pesan diaktifkan untuk instans ApsaraMQ for RocketMQ, terlepas dari apakah parameter ini dikonfigurasi atau tidak. Valid values: false : 关闭消息轨迹功能 true : 开启消息轨迹功能	true
aclInfo	object	No	Daftar kontrol akses untuk instans tersebut.
aclTypes	array	No	Tipe autentikasi instans tersebut.
	string	No	Tipe autentikasi instans tersebut. Nilai yang valid: default: intelligent identity authentication apache_acl: access control list (ACL) identity authentication Valid values: default : 智能身份识别 apache_acl : Apache RocketMQ ACL	apache_acl
defaultVpcAuthFree	boolean	No	Menunjukkan apakah fitur akses tanpa autentikasi di VPC diaktifkan. Menunjukkan apakah fitur akses tanpa autentikasi di VPC diaktifkan. Nilai yang valid: true false Valid values: true : 开启免密访问 false : 关闭免密访问	false

Elemen respons

Element	Type	Description	Example
	object	Objek respons.
requestId	string	ID permintaan. Sistem menghasilkan ID unik untuk setiap permintaan. Anda dapat melakukan pemecahan masalah berdasarkan ID permintaan tersebut.	AA87DE09-DA44-52F4-9515-78B1B607****
success	boolean	Menunjukkan apakah panggilan berhasil.	true
data	boolean	Data hasil yang dikembalikan.	true
code	string	Kode kesalahan.	MissingInstanceId
message	string	Pesan kesalahan.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	Kode status HTTP.	400
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Pesan kesalahan dinamis.	instanceId

Contoh

Respons sukses

JSONformat

{
  "requestId": "AA87DE09-DA44-52F4-9515-78B1B607****",
  "success": true,
  "data": true,
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.