すべてのプロダクト
Search
ドキュメントセンター

ApsaraMQ for RocketMQ:ListDisasterRecoveryItems

最終更新日:Sep 24, 2026

バックアップマッピングタスクのリストを照会します。

今すぐお試しください

この 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:ListDisasterRecoveryItems

get

*インスタンス。

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

なし なし

リクエスト構文

GET /disaster_recovery/{planId}/items HTTP/1.1

パスパラメーター

パラメーター

型

必須 / 任意

説明

例

planId

integer

必須

バックアッププランの ID。

1234

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

topicName

string

任意

Topic 名。

topic-test284

filter

string

任意

フィルター条件。topicName でフィルターします。

topic_test

pageNumber

integer

任意

返される結果のページ番号。

1

pageSize

integer

任意

1 ページあたりに返される結果の最大値。

10

レスポンスフィールド

フィールド

型

説明

例

object

Result<MyPage>

requestId

string

リクエストの ID。

C115601B-8736-5BBF-AC99-7FEAE12xxxx

success

boolean

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

true

data

object

応答データ。

scrollId

string

リクエストのスクロール ID。この値はシステムによって自動的に生成されます。ページネーションを続行するには、後続のページ分割リクエストにこの値を含めます。

B13D0B07-F24B-4790-88D8-D47A38063D00

pageNumber

integer

現在のページ番号。

1

pageSize

integer

ページサイズ。

10

totalCount

integer

レコードの総数。

49

list

array<object>

ページ分割データ。

array<object>

ページ分割データ。

itemId

integer

バックアッププランの ID。

100070284

planId

integer

マッピングの ID。

1300000016

itemStatus

string

バックアップマッピングのステータス。有効な値:

  • CREATING: 作成中。

  • CHANGING: 変更中。

  • RUNNING: 実行中。

  • MANUAL_STOPPED: 手動で停止。

  • OVERDUE_STOPPED: 支払い遅延により停止。

RUNNING

topics

array<object>

バックアップマッピングに含まれる Topic。

object

バックアップマッピングに含まれる Topic。

regionId

string

リージョン ID。

cn-hangzhou

instanceType

string

インスタンスタイプ。

ALIYUN_ROCKETMQ

instanceId

string

インスタンスの ID。

rmq-cn-kh43w0olz0c

topicName

string

Topic 名。

topic-test

consumerGroupId deprecated

string

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

グループ-test

deliveryOrderType

string

ターゲットインスタンスに配信されるメッセージの順序。

このパラメーターの有効な値は以下のとおりです:

  • Concurrently: 同時配信。

  • Orderly: 順序付き配信。

列挙値:

  • Concurrently :

    同時配信。

  • Orderly :

    順序付き配信。

Concurrently

extInfo

object

拡張情報のフォーマット。

string

拡張情報のフォーマット。

{}

createTime

string

作成時間。フォーマットは YYYY-MM-DD HH:mm:ss です。

2024-09-20 03:38:28

updateTime

string

更新時間。フォーマットは YYYY-MM-DD HH:mm:ss です。

2024-10-04 02:19:44

code

string

エラーコード。

200

message

string

エラーメッセージ。

xxx

httpStatusCode

integer

HTTP 状態コード。

200

dynamicCode

string

動的エラーコード。

InstanceId

dynamicMessage

string

動的エラーメッセージ。

インスタンスId

accessDeniedDetail

string

アクセス拒否の詳細。このパラメーターは、RAM 権限が不十分なためにリクエストが拒否された場合にのみ返されます。

xxx

例

成功レスポンス

JSONJSON

{
  "requestId": "C115601B-8736-5BBF-AC99-7FEAE12xxxx",
  "success": true,
  "data": {
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00\n",
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 49,
    "list": [
      {
        "itemId": 100070284,
        "planId": 1300000016,
        "itemStatus": "RUNNING",
        "topics": [
          {
            "regionId": "cn-hangzhou",
            "instanceType": "ALIYUN_ROCKETMQ",
            "instanceId": "rmq-cn-kh43w0olz0c",
            "topicName": "topic-test",
            "consumerGroupId": "group-test",
            "deliveryOrderType": "Concurrently"
          }
        ],
        "extInfo": {
          "key": "{}"
        },
        "createTime": "2024-09-20 03:38:28",
        "updateTime": "2024-10-04 02:19:44"
      }
    ]
  },
  "code": "200",
  "message": "xxx",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId",
  "accessDeniedDetail": "xxx"
}

エラーコード

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

変更履歴

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