All Products
Search

This Product

    ApsaraMQ for RocketMQ:UpdateInstance

    Document Center

    ApsaraMQ for RocketMQ:UpdateInstance

    Last Updated:Jul 23, 2026

    Memperbarui informasi dasar dan konfigurasi spesifikasi dari sebuah instans ApsaraMQ for RocketMQ.

    Deskripsi operasi

    Penting OpenAPI yang disediakan oleh Alibaba Cloud adalah API manajemen dan kontrol yang digunakan untuk mengelola dan mengkueri Sumber daya layanan Alibaba Cloud. Disarankan hanya untuk integrasi dalam tautan manajemen dan kontrol. Penggunaan OpenAPI dalam tautan data inti untuk pengiriman dan penerimaan Paket sangat dilarang. Jika tidak, risiko dapat terjadi pada tautan tersebut.

    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 None

    Sintaks permintaan

    PATCH /instances/{instanceId} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    instanceId

    string

    Yes

    ID instans yang akan diperbarui.

    rmq-cn-7e22ody****

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    body

    object

    No

    Struktur badan permintaan.

    instanceName

    string

    No

    Nama instans yang diperbarui.

    test_instans
    remark

    string

    No

    Keterangan yang diperbarui untuk instans.

    This is the remark for test.
    networkInfo

    object

    No

    Informasi jaringan instans yang diperbarui.

    internetInfo

    object

    No

    Informasi jaringan publik. Parameter ini hanya valid ketika fitur akses jaringan publik diaktifkan untuk instans.

    ipWhitelist

    array

    No

    Daftar putih (whitelist) alamat IP untuk akses publik.

    • Jika Anda tidak mengonfigurasi daftar putih alamat IP, secara default instans mengizinkan akses dari alamat IP publik mana pun.

    • Jika Anda mengonfigurasi daftar putih alamat IP, hanya alamat IP yang ada dalam daftar putih yang dapat mengakses instans melalui internet.

    string

    No

    Alamat IP atau blok CIDR dalam daftar putih alamat IP publik.

    192.168.x.x/24
    productInfo

    object

    No

    Konfigurasi ekstensi instans.

    sendReceiveRatio

    number

    No

    Rasio pengiriman Paket terhadap penerimaan.

    Nilai valid: [0.25, 1]

    0.5
    autoScaling

    boolean

    No

    Apakah akan mengaktifkan kapasitas elastis burstable di luar spesifikasi.

    Setelah kapasitas elastis burstable diaktifkan, ApsaraMQ for RocketMQ memungkinkan instans melampaui batas TPS dari spesifikasi dasar dalam rentang tertentu. Bagian yang melebihi spesifikasi dasar akan dikenakan biaya tambahan untuk spesifikasi elastis. Untuk informasi lebih lanjut tentang penagihan, lihat Biaya komputasi.

    Catatan

    Hanya instans dengan spesifikasi tertentu yang mendukung kapasitas elastis burstable. Untuk informasi lebih lanjut tentang instans yang didukung, lihat Spesifikasi instans.

    Valid values:

    • true :

      Aktifkan skalabilitas elastis.

    • false :

      Nonaktifkan skalabilitas elastis.

    true.
    messageRetentionTime

    integer

    No

    Periode retensi Paket. Unit: jam.

    Untuk rentang nilai valid, lihat Batasan > Kuota Sumber daya > Periode Retensi Pesan.

    Log broker di ApsaraMQ for RocketMQ sepenuhnya bersifat arsitektur tanpa server dan elastis, serta biaya dibebankan berdasarkan ruang penyimpanan aktual. Anda dapat mengontrol kapasitas penyimpanan Paket dengan menyesuaikan periode retensi Paket. Untuk informasi lebih lanjut, lihat Biaya penyimpanan.

    72
    traceOn

    boolean

    No

    Apakah akan mengaktifkan fitur jejak Paket.

    Parameter ini tidak berlaku. Terlepas dari apakah parameter ini diaktifkan, instans mendukung fitur jejak secara default.

    Valid values:

    • false :

      Nonaktifkan fitur jejak Paket.

    • true :

      Aktifkan fitur jejak Paket.

    true.
    adaptiveElasticity

    boolean

    No

    aclInfo

    object

    No

    Informasi Kontrol akses.

    aclTypes

    array

    No

    Tipe otentikasi instans.

    string

    No

    Tipe otentikasi instans.

    Valid values:

    • default :

      Pengenalan identitas cerdas.

    • apache_acl :

      Apache RocketMQ ACL.

    apache_acl.
    defaultVpcAuthFree

    boolean

    No

    Apakah akan mengaktifkan akses bebas otentikasi untuk koneksi VPC di bawah tipe pengenalan identitas cerdas.

    Valid values:

    • true :

      Aktifkan akses bebas otentikasi.

    • false :

      Nonaktifkan akses bebas otentikasi.

    false.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Result

    requestId

    string

    ID permintaan. Setiap ID permintaan unik dan aktif untuk pemecahan masalah dan pelacakan isu.

    AA87DE09-DA44-52F4-9515-78B1B607****
    success

    boolean

    Menunjukkan apakah eksekusi berhasil.

    true.
    data

    boolean

    Hasil yang dikembalikan.

    true.
    code

    string

    Kode error.

    MissingInstanceId.
    message

    string

    Paket error.

    Parameter instanceId is mandatory for this action .
    httpStatusCode

    integer

    Kode status HTTP.

    400
    dynamicCode

    string

    Kode error dinamis.

    InstanceId.
    dynamicMessage

    string

    Paket error dinamis.

    instansId

    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.