すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:UpdateDisasterRecoveryPlan

    ドキュメントセンター

    ApsaraMQ for RocketMQ:UpdateDisasterRecoveryPlan

    最終更新日:Dec 21, 2025

    グローバルメッセージバックアッププランを変更します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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>

    任意

    グローバルレプリケータータスクに関連するインスタンス。グローバルレプリケータータスクを作成した後は、タスクに関連するインスタンスを変更することはできません。変更できるのは、タスクのメッセージ属性と認証タイプのみです。

    array<object>

    任意

    グローバルレプリケータータスクに関連するインスタンス。

    instanceType

    string

    任意

    インスタンスタイプ。有効な値：

    • ALIYUN_ROCKETMQ：ApsaraMQ for RocketMQ インスタンス

    • EXTERNAL_ROCKETMQ：オープンソース RocketMQ クラスター

    列挙値:

    • ALIYUN_ROCKETMQ :

      Alibaba Cloud インスタンス

    • EXTERNAL_ROCKETMQ :

      外部インスタンス

    ALIYUN_ROCKETMQ
    regionId

    string

    任意

    インスタンスが存在するリージョンの ID。

    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` を `EXTERNAL_ROCKETMQ` に設定した場合にのみ必須です。

    xxx
    networkType

    string

    任意

    ネットワークタイプ。このパラメーターは、`instanceType` を `EXTERNAL_ROCKETMQ` に設定した場合にのみ必須です。有効な値：

    • TCP_INTERNET：TCP 経由のインターネット

    • TCP_VPC：TCP 経由の Virtual Private Cloud (VPC)。

    列挙値:

    • TCP_VPC :

      TCP (VPC)

    • TCP_INTERNET :

      TCP (パブリックネットワーク)

    TCP_INTERNET
    vpcId

    string

    任意

    インスタンスが関連付けられている VPC の ID。このパラメーターは、`instanceType` を `EXTERNAL_ROCKETMQ` に、`networkType` を `TCP_VPC` に設定した場合にのみ必須です。

    vpc-wz9qt50xhtj9krb******

    vSwitchId

    string

    任意

    インスタンスが関連付けられている vSwitch の ID。このパラメーターは、`instanceType` を `EXTERNAL_ROCKETMQ` に、`networkType` を `TCP_VPC` に設定した場合にのみ必須です。

    vsw-uf6gwtbn6etadpv******

    messageProperty

    object

    任意

    メッセージ属性。メッセージを宛先クラスターに同期すると、システムは SQL ベースのフィルタリングのためにこの属性をメッセージに自動的に追加します。

    propertyKey

    string

    任意

    属性キー。

    aaa
    propertyValue

    string

    任意

    属性値。

    bbb
    securityGroupId

    string

    任意

    インスタンスが属するセキュリティグループの ID。このパラメーターは、`instanceType` を `EXTERNAL_ROCKETMQ` に、`networkType` を `TCP_VPC` に設定した場合にのみ必須です。

    sg-bp17hpmgz9******

    consumerGroupId

    string

    任意

    コンシューマーグループ ID。

    GID_DS_XXX_YYY
    autoSyncCheckpoint

    boolean

    任意

    コンシューマー進捗の自動同期を有効にするかどうかを指定します。

    説明

    このパラメーターは、syncCheckpointEnabled を true に設定した場合にのみ有効です。

    有効な値：

    • true

    • false

    列挙値:

    • true :

      有効

    • false :

      無効

    true
    syncCheckpointEnabled

    boolean

    任意

    コンシューマー進捗同期を有効にするかどうかを指定します。

    有効な値：

    • true

    • false

    列挙値:

    • true :

      有効

    • false :

      無効

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    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

    レスポンスコード。

    200
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId
    accessDeniedDetail

    string

    アクセス拒否の詳細。このパラメーターは、Resource Access Management (RAM) ユーザーに必要な権限がないためにアクセスが拒否された場合にのみ返されます。

    xxx

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。