All Products
Search

This Product

    ApsaraMQ for RocketMQ:GetDisasterRecoveryPlan

    Document Center

    ApsaraMQ for RocketMQ:GetDisasterRecoveryPlan

    Last Updated:Jun 10, 2026

    Mengkueri detail tugas Global Replicator.

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

    get

    *Instance

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

    		 None None

    Sintaks permintaan

    GET /disaster_recovery/{planId} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    planId

    integer

    Yes

    ID tugas Global Replicator.

    1234

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example

    Tidak ada parameter yang diperlukan.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The response parameters.

    requestId

    string

    The request ID.

    7358418D-83BD-507A-8079-611C63E0xxx
    success

    boolean

    Indicates whether the request was successful.

    true
    data

    object

    The returned data.

    planId

    integer

    The ID of the Global Replicator task.

    1300000016
    planName

    string

    The name of the Global Replicator task.

    xxx
    planDesc

    string

    The description of the Global Replicator task.

    xxxx
    planType

    string

    The type of the Global Replicator task. Valid values:

    • ACTIVE_PASSIVE: one-way backup

    • ACTIVE_ACTIVE: two-way backup

    ACTIVE_PASSIVE
    planStatus

    string

    The status of the Global Replicator task. Valid values:

    • CREATED

    • RUNNING

    • DELETED

    RUNNING
    extInfo

    object

    The extended information.

    string

    The extended information.

    xxxx
    instances

    array<object>

    The instances involved in the Global Replicator task.

    array<object>

    The instance involved in the Global Replicator task.

    instanceType

    string

    The instance type.

    ALIYUN_ROCKETMQ
    regionId

    string

    The ID of the region where the instance resides.

    cn-shanghai
    instanceId

    string

    The instance ID.

    rmq-cn-gpz3qtcdxxx
    instanceRole

    string

    The instance role.

    ACTIVE
    authType

    string

    The authentication type.

    ACL_AUTH
    username

    string

    The username used for authentication.

    xxx
    password

    string

    The password used for authentication.

    xxx
    endpointUrl

    string

    The endpoint.

    xxx
    networkType

    string

    The network type.

    TCP_INTERNET
    vpcId

    string

    The virtual private cloud (VPC) ID.

    vpc-wz9qt50xhtj9krb******

    vSwitchId

    string

    The vSwitch ID.

    vsw-uf6gwtbn6etadpv******

    messageProperty

    object

    The message attribute.

    propertyKey

    string

    The attribute key.

    xxx
    propertyValue

    string

    The attribute value.

    xxx
    securityGroupId

    string

    The security group ID.

    sg-bp17hpmgz9******

    consumerGroupId

    string

    The consumer Group ID.

    GID_DS_XXX_YYY
    createTime

    string

    The time when the query task was created.

    2022-08-01 20:05:50
    updateTime

    string

    The time when the query task was last modified.

    2022-08-01 20:05:50
    autoSyncCheckpoint

    boolean

    Indicates whether automatic consumer progress synchronization is enabled.

    Catatan

    This parameter takes effect only when syncCheckpointEnabled is set to true.

    Valid values:

    • true

    • false

    Valid values:

    • true :

      Enabled

    • false :

      Disabled

    true
    syncCheckpointEnabled

    boolean

    Indicates whether consumer progress synchronization is enabled.

    Valid values:

    • true

    • false

    Valid values:

    • true :

      Enabled

    • false :

      Disabled

    true
    code

    string

    The error code.

    200
    message

    string

    The error message.

    xxx
    httpStatusCode

    integer

    The response code.

    200
    dynamicCode

    string

    The dynamic error code.

    InstanceId
    dynamicMessage

    string

    The dynamic error message.

    instanceId
    accessDeniedDetail

    string

    The details about the access denial. This parameter is returned only if the access is denied because the Resource Access Management (RAM) user does not have the required permissions.

    xxx

    Contoh

    Respons sukses

    JSONformat

    {
  "requestId": "7358418D-83BD-507A-8079-611C63E0xxx",
  "success": true,
  "data": {
    "planId": 1300000016,
    "planName": "xxx",
    "planDesc": "xxxx",
    "planType": "ACTIVE_PASSIVE",
    "planStatus": "RUNNING",
    "extInfo": {
      "key": "xxxx"
    },
    "instances": [
      {
        "instanceType": "ALIYUN_ROCKETMQ",
        "regionId": "cn-shanghai",
        "instanceId": "rmq-cn-gpz3qtcdxxx",
        "instanceRole": "ACTIVE",
        "authType": "ACL_AUTH",
        "username": "xxx",
        "password": "xxx",
        "endpointUrl": "xxx",
        "networkType": "TCP_INTERNET",
        "vpcId": "vpc-wz9qt50xhtj9krb******\n",
        "vSwitchId": "vsw-uf6gwtbn6etadpv******\n",
        "messageProperty": {
          "propertyKey": "xxx",
          "propertyValue": "xxx"
        },
        "securityGroupId": "sg-bp17hpmgz9******\n",
        "consumerGroupId": "GID_DS_XXX_YYY"
      }
    ],
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "autoSyncCheckpoint": true,
    "syncCheckpointEnabled": true
  },
  "code": "200",
  "message": "xxx",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.