すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:GetDisasterRecoveryPlan

    ドキュメントセンター

    ApsaraMQ for RocketMQ:GetDisasterRecoveryPlan

    最終更新日: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:GetDisasterRecoveryPlan

    get

    *Instance

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

    		 なし なし

    リクエスト構文

    GET /disaster_recovery/{planId} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    planId

    integer

    必須

    グローバルレプリケータータスクの ID。

    1234

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    requestId

    string

    リクエスト ID。

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

    boolean

    リクエストが成功したかどうかを示します。

    true
    data

    object

    返されたデータ。

    planId

    integer

    グローバルレプリケータータスクの ID。

    1300000016
    planName

    string

    グローバルレプリケータータスクの名前。

    xxx
    planDesc

    string

    グローバルレプリケータータスクの説明。

    xxxx
    planType

    string

    グローバルレプリケータータスクのタイプ。有効な値：

    • ACTIVE_PASSIVE：一方向バックアップ

    • ACTIVE_ACTIVE：双方向バックアップ

    ACTIVE_PASSIVE
    planStatus

    string

    グローバルレプリケータータスクのステータス。有効な値：

    • CREATED

    • RUNNING

    • DELETED

    RUNNING
    extInfo

    object

    拡張情報。

    string

    拡張情報。

    xxxx
    instances

    array<object>

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

    array<object>

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

    instanceType

    string

    インスタンスタイプ。

    ALIYUN_ROCKETMQ
    regionId

    string

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

    cn-shanghai
    instanceId

    string

    インスタンス ID。

    rmq-cn-gpz3qtcdxxx
    instanceRole

    string

    インスタンスロール。

    ACTIVE
    authType

    string

    認証タイプ。

    ACL_AUTH
    username

    string

    認証に使用されるユーザー名。

    xxx
    password

    string

    認証に使用されるパスワード。

    xxx
    endpointUrl

    string

    エンドポイント。

    xxx
    networkType

    string

    ネットワークタイプ。

    TCP_INTERNET
    vpcId

    string

    VPC (Virtual Private Cloud) ID。

    vpc-wz9qt50xhtj9krb******

    vSwitchId

    string

    vSwitch ID。

    vsw-uf6gwtbn6etadpv******

    messageProperty

    object

    メッセージ属性。

    propertyKey

    string

    属性キー。

    xxx
    propertyValue

    string

    属性値。

    xxx
    securityGroupId

    string

    セキュリティグループ ID。

    sg-bp17hpmgz9******

    consumerGroupId

    string

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

    GID_DS_XXX_YYY
    createTime

    string

    クエリタスクが作成された時間。

    2022-08-01 20:05:50
    updateTime

    string

    クエリタスクが最後に変更された時間。

    2022-08-01 20:05:50
    autoSyncCheckpoint

    boolean

    コンシューマーの進捗の自動同期が有効になっているかどうかを示します。

    説明

    このパラメーターは、syncCheckpointEnabled が true に設定されている場合にのみ有効になります。

    有効な値：

    • true

    • false

    列挙値:

    • true :

      有効

    • false :

      無効

    true
    syncCheckpointEnabled

    boolean

    コンシューマーの進捗同期が有効になっているかどうかを示します。

    有効な値：

    • true

    • false

    列挙値:

    • true :

      有効

    • false :

      無効

    true
    code

    string

    エラーコード。

    200
    message

    string

    エラーメッセージ。

    xxx
    httpStatusCode

    integer

    レスポンスコード。

    200
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId
    accessDeniedDetail

    string

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

    xxx

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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