All Products
Search

This Product

    ApsaraMQ for RocketMQ:UpdateInstance

    Document Center

    ApsaraMQ for RocketMQ:UpdateInstance

    Last Updated:Jun 10, 2026

    Memperbarui informasi dasar dan spesifikasi instans Message Queue for Apache RocketMQ.

    Deskripsi operasi

    Penting

    OpenAPI Alibaba Cloud adalah API control plane untuk mengelola dan melakukan kueri sumber daya cloud. Gunakan hanya pada jalur kontrol (control path). Jangan gunakan API ini pada jalur data inti (core data path) untuk transportasi pesan, karena hal ini dapat membahayakan keandalan layanan.

    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

    Isi permintaan (request body).

    instanceName

    string

    No

    Nama instans yang diperbarui.

    test_instance
    remark

    string

    No

    Keterangan yang diperbarui untuk instans.

    This is the remark for test.
    networkInfo

    object

    No

    Informasi jaringan yang diperbarui untuk instans.

    internetInfo

    object

    No

    Informasi internet. Parameter ini hanya valid jika akses publik diaktifkan untuk instans.

    ipWhitelist

    array

    No

    The whitelist that includes the IP addresses that are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.

    • If you do not configure an IP address whitelist, all CIDR blocks are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.

    • If you configure an IP address whitelist, only the IP addresses in the whitelist are allowed to access the ApsaraMQ for RocketMQ broker over the Internet.

    string

    No

    The IP addresses in the whitlist.

    192.168.x.x/24
    productInfo

    object

    No

    Konfigurasi tambahan dari instans.

    sendReceiveRatio

    number

    No

    Rasio pengiriman/penerimaan pesan.

    Nilai yang valid: [0.25, 1].

    0.5
    autoScaling

    boolean

    No

    Menentukan apakah akan mengaktifkan performa burstable untuk instans.

    Jika Anda mengaktifkan performa burstable, instans dapat melampaui transactions per second (TPS) baseline-nya dalam rentang tertentu. Anda dikenai biaya untuk TPS yang melebihi baseline. Untuk informasi lebih lanjut tentang penagihan, lihat Biaya daya komputasi.

    Catatan

    Performa burstable hanya didukung oleh edisi instans tertentu. Untuk informasi lebih lanjut tentang edisi instans yang didukung, lihat Edisi instans.

    Valid values:

    • true :

      Mengaktifkan performa burstable.

    • false :

      Menonaktifkan performa burstable.

    true
    messageRetentionTime

    integer

    No

    Periode retensi pesan. Satuan: jam.

    Untuk informasi tentang rentang nilai, lihat bagian "Periode retensi pesan" pada topik Batasan.

    Penyimpanan pesan di Message Queue for Apache RocketMQ bersifat serverless dan elastis. Anda dikenai biaya berdasarkan penggunaan penyimpanan aktual. Anda dapat mengubah periode retensi pesan untuk menyesuaikan kapasitas penyimpanan. Untuk informasi lebih lanjut, lihat Biaya penyimpanan.

    72
    traceOn

    boolean

    No

    Menentukan apakah akan mengaktifkan fitur pelacakan pesan (message trace).

    Parameter ini belum berlaku. Pelacakan pesan diaktifkan secara default untuk semua instans.

    Valid values:

    • false :

      Menonaktifkan fitur pelacakan pesan.

    • true :

      Mengaktifkan fitur pelacakan pesan.

    true
    aclInfo

    object

    No

    Informasi kontrol akses.

    aclTypes

    array

    No

    Mekanisme autentikasi untuk instans.

    string

    No

    Mekanisme autentikasi untuk instans.

    Valid values:

    • default :

      autentikasi cerdas (intelligent authentication)

    • apache_acl :

      Apache RocketMQ ACL

    apache_acl
    defaultVpcAuthFree

    boolean

    No

    Menentukan apakah akan mengaktifkan akses tanpa kata sandi melalui VPC ketika autentikasi cerdas digunakan.

    Valid values:

    • true :

      Mengaktifkan akses tanpa kata sandi.

    • false :

      Menonaktifkan akses tanpa kata sandi.

    false

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Objek respons.

    requestId

    string

    ID unik permintaan, digunakan untuk memecahkan masalah dan menelusuri isu.

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

    boolean

    Menunjukkan apakah operasi berhasil.

    true
    data

    boolean

    Hasil dari operasi.

    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.