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

ApsaraMQ for RocketMQ:ListMigrations

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

list

*すべてのリソース。

*

なし なし

リクエスト構文

GET /migrations HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

filter

string

任意

クエリのフィルター条件。

xx

migrationType

string

必須

移行タイプ。有効な値:

  • INSTANCE_MIGRATION: インスタンス移行

列挙値:

  • INSTANCE_MIGRATION :

    インスタンス移行。

INSTANCE_MIGRATION

pageNumber

integer

必須

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

1

pageSize

integer

必須

各ページで返されるエントリ数。

10

resourceGroupId

string

任意

リソースグループの ID。

rg-acfm4goe2ckfiva

レスポンスフィールド

フィールド

型

説明

例

object

Result<MyPage>

requestId

string

リクエスト ID。

E5897B2E-C3AC-56DC-A482-F0E9E53F48D5

success

boolean

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

true

data

object

応答データ。

pageNumber

integer

現在のページ番号。

1

pageSize

integer

1 ページあたりのエントリ数。

3

totalCount

integer

エントリの総数。

1

list

array<object>

ページングデータ。

array<object>

移行タスクのリスト。

migrationId

integer

移行 ID。

21

migrationName

string

移行名。

xxx

migrationType

string

移行タイプ。有効な値:

  • INSTANCE_MIGRATION: インスタンス移行

INSTANCE_MIGRATION

migrationStatus

string

移行ステータス。有効な値:

  • CREATED: 作成済み。

  • MIGRATING: 移行中。

  • COMPLETED: 完了。

  • CANCELLED: キャンセル済み。

列挙値:

  • CANCELLED :

    キャンセル済み。

  • CREATED :

    作成済み。

  • COMPLETED :

    完了。

  • MIGRATING :

    移行中。

MIGRATING

userId

string

ユーザー ID。

111

currentStage

object

現在の移行ステージ。

stageType

string

ステージタイプ。有効な値:

  • CONNECT_NETWORK: ネットワーク接続。

  • MIGRATE_METADATA: メタデータ移行。

  • REPLACE_ENDPOINT: エンドポイント置換。

  • MIGRATE_MESSAGE: メッセージ移行。

列挙値:

  • REPLACE_ENDPOINT :

    エンドポイント置換。

  • MIGRATE_METADATA :

    メタデータ移行。

  • CONNECT_NETWOR :

    ネットワーク接続。

  • MIGRATE_MESSAGE :

    メッセージ移行。

MIGRATE_METADATA

stageStatus

string

ステージステータス。有効な値:

  • INIT: 未開始。

  • DOING: 進行中。

  • DONE: 完了。

列挙値:

  • INIT :

    未開始。

  • DONE :

    完了。

  • DOING :

    進行中。

DOING

stageData

any

ステージデータ。

[]

migrationSource

object

移行元。

sourceType

string

移行元タイプ。有効な値:

  • EXTERNAL_INSTANCE: 外部インスタンス。

  • INTERNAL_INSTANCE: Alibaba Cloud 5.0 インスタンス。

列挙値:

  • EXTERNAL_INSTANCE :

    外部インスタンス。

  • INTERNAL_INSTANCE :

    Alibaba Cloud 5.0 インスタンス。

EXTERNAL_INSTANCE

sourceData

any

ソースデータ。

{ "clusterType":"INTERNET_NETWORK", "aclType":"NONE", "clusterName":"test", "namesrvAddrList":"47.110.248.xxx:9876"], "brokerObtainMethod":"AUTO_OBTAIN" }

migrationTarget

object

移行先。

targetType

string

移行先タイプ。有効な値:

  • INTERNAL_INSTANCE: Alibaba Cloud 5.0 インスタンス。

列挙値:

  • INTERNAL_INSTANCE :

    Alibaba Cloud 5.0 インスタンス。

INTERNAL_INSTANCE

targetData

any

移行先データ。

{ "clusterType":"ROCKETMQ_V5", "インスタンスId":"rmq-cn-778429mp301", "regionId":"cn-hangzhou" }

createTime

string

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

2022-08-01 00:00:00

updateTime

string

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

2022-08-01 20:05:50

code

string

エラーコード。

MissingInstanceId

message

string

エラーメッセージ。

インスタンスが見つかりません

httpStatusCode

integer

HTTP 状態コード。

200

dynamicCode

string

動的エラーコード。

InstanceId

dynamicMessage

string

動的エラーメッセージ。

インスタンスId

例

成功レスポンス

JSONJSON

{
  "requestId": "E5897B2E-C3AC-56DC-A482-F0E9E53F48D5",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 3,
    "totalCount": 1,
    "list": [
      {
        "migrationId": 21,
        "migrationName": "xxx",
        "migrationType": "INSTANCE_MIGRATION",
        "migrationStatus": "MIGRATING",
        "userId": "111",
        "currentStage": {
          "stageType": "MIGRATE_METADATA",
          "stageStatus": "DOING",
          "stageData": "[]"
        },
        "migrationSource": {
          "sourceType": "EXTERNAL_INSTANCE",
          "sourceData": "{\n\"clusterType\":\"INTERNET_NETWORK\",\n\"aclType\":\"NONE\",\n\"clusterName\":\"test\",\n\"namesrvAddrList\":\"47.110.248.xxx:9876\"],\n\"brokerObtainMethod\":\"AUTO_OBTAIN\"\n}"
        },
        "migrationTarget": {
          "targetType": "INTERNAL_INSTANCE",
          "targetData": "{\n\"clusterType\":\"ROCKETMQ_V5\",\n\"instanceId\":\"rmq-cn-778429mp301\",\n\"regionId\":\"cn-hangzhou\"\n}"
        },
        "createTime": "2022-08-01 00:00:00",
        "updateTime": "2022-08-01 20:05:50"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

エラーコード

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

変更履歴

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