All Products
Search

This Product

    ApsaraMQ for RocketMQ:UpdateDisasterRecoveryPlan

    Document Center

    ApsaraMQ for RocketMQ:UpdateDisasterRecoveryPlan

    Last Updated:Jun 10, 2026

    Memodifikasi rencana cadangan pesan global.

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

    update

    *Instance

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

    		 None None

    Sintaks permintaan

    PATCH /disaster_recovery/{planId} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    planId

    integer

    Yes

    ID rencana cadangan pesan global.

    1300000016

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    body

    object

    No

    Isi permintaan.

    planName

    string

    No

    Nama tugas Global Replicator.

    xxx
    planDesc

    string

    No

    Deskripsi tugas Global Replicator.

    xxx
    planType

    string

    No

    Jenis tugas Global Replicator. Setelah Anda membuat tugas Global Replicator, Anda tidak dapat mengubah jenis tugas tersebut. Nilai yang valid:

    • ACTIVE_PASSIVE: cadangan satu arah

    • ACTIVE_ACTIVE: cadangan dua arah

    Valid values:

    • ACTIVE_ACTIVE :

      Cadangan satu arah

    • ACTIVE_PASSIVE :

      Cadangan dua arah

    ACTIVE_PASSIVE
    instances

    array<object>

    No

    Instans yang terlibat dalam tugas Global Replicator. Setelah Anda membuat tugas Global Replicator, Anda tidak dapat mengubah instans yang terlibat dalam tugas tersebut. Anda hanya dapat mengubah atribut pesan dan jenis autentikasi tugas.

    array<object>

    No

    Instans yang terlibat dalam tugas Global Replicator.

    instanceType

    string

    No

    Jenis instans. Nilai yang valid:

    • ALIYUN_ROCKETMQ: instans ApsaraMQ for RocketMQ

    • EXTERNAL_ROCKETMQ: kluster RocketMQ sumber terbuka

    Valid values:

    • ALIYUN_ROCKETMQ :

      Instans Alibaba Cloud

    • EXTERNAL_ROCKETMQ :

      Instans eksternal

    ALIYUN_ROCKETMQ
    regionId

    string

    No

    ID region tempat instans berada.

    cn-hangzhou
    instanceId

    string

    No

    ID instans.

    rmq-cn-83l3r0xxxx
    instanceRole

    string

    No

    Peran instans. Nilai yang valid:

    • ACTIVE: instans utama

    • Passive: instans sekunder

    Valid values:

    • PASSIVE :

      Sekunder

    • ACTIVE :

      Utama

    ACTIVE
    authType

    string

    No

    Jenis autentikasi. Nilai yang valid:

    • NO_AUTH: tanpa autentikasi

    • ACL_AUTH: autentikasi berbasis daftar kontrol akses (ACL)

    Valid values:

    • NO_AUTH :

      Tanpa autentikasi

    • ACL_AUTH :

      Autentikasi ACL

    NO_AUTH
    username

    string

    No

    Nama pengguna yang digunakan untuk autentikasi. Parameter ini diperlukan hanya jika Anda menetapkan authType ke ACL_AUTH.

    xxx
    password

    string

    No

    Kata sandi yang digunakan untuk autentikasi. Parameter ini diperlukan hanya jika Anda menetapkan authType ke ACL_AUTH.

    xxx
    endpointUrl

    string

    No

    Endpoint instans. Parameter ini diperlukan hanya jika Anda menetapkan instanceType ke EXTERNAL_ROCKETMQ.

    xxx
    networkType

    string

    No

    Jenis jaringan. Parameter ini diperlukan hanya jika Anda menetapkan instanceType ke EXTERNAL_ROCKETMQ. Nilai yang valid:

    • TCP_INTERNET: Internet melalui TCP

    • TCP_VPC: virtual private cloud (VPC) melalui TCP.

    Valid values:

    • TCP_VPC :

      TCP VPC

    • TCP_INTERNET :

      TCP Internet

    TCP_INTERNET
    vpcId

    string

    No

    ID VPC yang terkait dengan instans. Parameter ini diperlukan hanya jika Anda menetapkan instanceType ke EXTERNAL_ROCKETMQ dan networkType ke TCP_VPC.

    vpc-wz9qt50xhtj9krb******

    vSwitchId

    string

    No

    ID vSwitch yang terkait dengan instans. Parameter ini diperlukan hanya jika Anda menetapkan instanceType ke EXTERNAL_ROCKETMQ dan networkType ke TCP_VPC.

    vsw-uf6gwtbn6etadpv******

    messageProperty

    object

    No

    Atribut pesan. Ketika Anda menyinkronkan pesan ke kluster tujuan, sistem secara otomatis menambahkan atribut tersebut ke pesan untuk pemfilteran berbasis SQL.

    propertyKey

    string

    No

    The attribute key.

    aaa
    propertyValue

    string

    No

    The attribute value.

    bbb
    securityGroupId

    string

    No

    ID grup keamanan tempat instans berada. Parameter ini diperlukan hanya jika Anda menetapkan instanceType ke EXTERNAL_ROCKETMQ dan networkType ke TCP_VPC.

    sg-bp17hpmgz9******

    consumerGroupId

    string

    No

    ID grup konsumen.

    GID_DS_XXX_YYY
    autoSyncCheckpoint

    boolean

    No

    Menentukan apakah akan mengaktifkan sinkronisasi progres konsumen otomatis.

    Catatan

    Parameter ini berlaku hanya jika Anda menetapkan syncCheckpointEnabled ke true.

    Nilai yang valid:

    • true

    • false

    Valid values:

    • true :

      Aktifkan

    • false :

      Nonaktifkan

    true
    syncCheckpointEnabled

    boolean

    No

    Menentukan apakah akan mengaktifkan sinkronisasi progres konsumen.

    Nilai yang valid:

    • true

    • false

    Valid values:

    • true :

      Aktifkan

    • false :

      Nonaktifkan

    true

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    requestId

    string

    ID permintaan.

    A07B41BD-6DD3-5349-9E76-00303Dxxxx
    success

    boolean

    Menunjukkan apakah permintaan berhasil.

    true
    data

    boolean

    Data yang dikembalikan.

    true
    code

    string

    Kode kesalahan.

    DisasterRecoveryPlanStatus.Error
    message

    string

    Pesan kesalahan.

    The current status of the disaster recovery plan does not support this operation.
    httpStatusCode

    integer

    Kode respons.

    200
    dynamicCode

    string

    Kode kesalahan dinamis.

    InstanceId
    dynamicMessage

    string

    Pesan kesalahan dinamis.

    instanceId
    accessDeniedDetail

    string

    Detail tentang penolakan akses. Parameter ini dikembalikan hanya jika akses ditolak karena pengguna Resource Access Management (RAM) tidak memiliki izin yang diperlukan.

    xxx

    Contoh

    Respons sukses

    JSONformat

    {
  "requestId": "A07B41BD-6DD3-5349-9E76-00303Dxxxx",
  "success": true,
  "data": true,
  "code": "DisasterRecoveryPlanStatus.Error",
  "message": "The current status of the disaster recovery plan does not support this operation.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.