全部產品
Search

搜尋本產品

    ApsaraMQ for RocketMQ：UpdateDisasterRecoveryPlan - 修改備份計劃

    文件中心

    ApsaraMQ for RocketMQ：UpdateDisasterRecoveryPlan - 修改備份計劃

    更新時間：Dec 21, 2025

    修改備份計劃。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    rocketmq:UpdateDisasterRecoveryPlan

    update

    *Instance

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

    		 無 無

    請求文法

    PATCH /disaster_recovery/{planId} HTTP/1.1

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    planId

    integer

    是

    備份計劃 id

    1300000016

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    body

    object

    否

    請求體。

    planName

    string

    否

    計劃名稱

    xxx
    planDesc

    string

    否

    計劃描述

    xxx
    planType

    string

    否

    備份任務類，不支援修改。參數取值如下：

    • ACTIVE_PASSIVE：單向備份

    • ACTIVE_ACTIVE：雙向備份

    枚舉值：

    • ACTIVE_ACTIVE :

      單向備份

    • ACTIVE_PASSIVE :

      雙向備份

    ACTIVE_PASSIVE
    instances

    array<object>

    否

    備份計劃參與執行個體。不支援修改執行個體，只支援修改執行個體下面 messageProperty 訊息過濾條件，auth 認證方式

    array<object>

    否

    備份計劃參與執行個體

    instanceType

    string

    否

    執行個體類型：

    • ALIYUN_ROCKETMQ ：阿里雲執行個體

    • EXTERNAL_ROCKETMQ ：外部執行個體，開源執行個體，開源叢集

    枚舉值：

    • ALIYUN_ROCKETMQ :

      阿里雲執行個體

    • EXTERNAL_ROCKETMQ :

      外部執行個體

    ALIYUN_ROCKETMQ
    regionId

    string

    否

    執行個體所在地區

    cn-hangzhou
    instanceId

    string

    否

    執行個體 ID

    rmq-cn-83l3r0xxxx
    instanceRole

    string

    否

    執行個體角色，主或者備

    • ACTIVE：主

    • PASSIVE：備

    枚舉值：

    • PASSIVE :

      備

    • ACTIVE :

      主

    ACTIVE
    authType

    string

    否

    認證方式

    • NO_AUTH：無需認證

    • ACL_AUTH：acl 認證

    枚舉值：

    • NO_AUTH :

      無須認證

    • ACL_AUTH :

      acl 認證

    NO_AUTH
    username

    string

    否

    認證使用者名稱，authType 為 ACL_AUTH 時必填

    xxx
    password

    string

    否

    認證密碼，authType 為 ACL_AUTH 時必填

    xxx
    endpointUrl

    string

    否

    存取點地址，instanceType 執行個體類型為 ALIYUN_ROCKETMQ 無須填寫，EXTERNAL_ROCKETMQ 需要填寫

    xxx
    networkType

    string

    否

    網路類型，instanceType 執行個體類型為 ALIYUN_ROCKETMQ 無須填寫，EXTERNAL_ROCKETMQ 需要填寫 參數取值如下：

    • TCP_INTERNET：tcp 公網

    • TCP_VPC：tcp 專用網路

    枚舉值：

    • TCP_VPC :

      tcp 專用網路

    • TCP_INTERNET :

      tcp 公網

    TCP_INTERNET
    vpcId

    string

    否

    建立執行個體所關聯的專用網路的 ID，nstanceType 執行個體類型僅為 EXTERNAL_ROCKETMQ，networkType 為 TCP_VPC 時需要填寫

    vpc-wz9qt50xhtj9krb******

    vSwitchId

    string

    否

    執行個體所關聯的交換器 ID，nstanceType 執行個體類型僅為 EXTERNAL_ROCKETMQ，networkType 為 TCP_VPC 時需要填寫

    vsw-uf6gwtbn6etadpv******

    messageProperty

    object

    否

    訊息過濾屬性，訊息同步到目的地組群時，會自動添加上該屬性，用於訊息消費時進行 SQL 過濾。

    propertyKey

    string

    否

    屬性 key

    aaa
    propertyValue

    string

    否

    屬性 value

    bbb
    securityGroupId

    string

    否

    安全性群組 id，nstanceType 執行個體類型僅為 EXTERNAL_ROCKETMQ，networkType 為 TCP_VPC 時需要填寫

    sg-bp17hpmgz9******

    consumerGroupId

    string

    否

    消費者組 ID，用於從源執行個體拉取訊息。

    重要 自建執行個體必須填寫，阿里雲執行個體會自動產生。

    GID_DS_XXX_YYY
    autoSyncCheckpoint

    boolean

    否

    是否開啟消費進度自動同步。

    說明

    只有在開啟消費進度同步時有效。即 syncCheckpointEnabled欄位值為 true。

    枚舉值：

    • true :

      開啟

    • false :

      關閉

    true
    syncCheckpointEnabled

    boolean

    否

    同步消費進度開關

    枚舉值：

    • true :

      開啟

    • false :

      關閉

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Result

    requestId

    string

    請求 ID

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

    boolean

    是否成功

    true
    data

    boolean

    返回結果

    true
    code

    string

    錯誤碼

    DisasterRecoveryPlanStatus.Error
    message

    string

    錯誤資訊

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

    integer

    HTTP 狀態代碼

    200
    dynamicCode

    string

    動態錯誤碼

    InstanceId
    dynamicMessage

    string

    動態錯誤資訊

    instanceId
    accessDeniedDetail

    string

    訪問拒絕詳細資料，有且僅有在因 RAM 無許可權拒絕使用者訪問的情境

    xxx

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。