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

ApsaraMQ for RocketMQ:ListMigrationOperations

最終更新日:Apr 27, 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:ListMigrationOperations

list

*Instance

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

なし なし

リクエスト構文

GET /migrations/{migrationId}/stages/{stageType}/operations HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

migrationId

integer

必須

移行の ID です。

135

stageType

string

必須

移行ステージのタイプです。

列挙値:

  • MIGRATE_MESSAGE :

    メッセージ移行

MIGRATE_MESSAGE

リクエストパラメーター

パラメーター

必須 / 任意

説明

operationType

string

必須

操作タイプです。

列挙値:

  • MIGRATE_MESSAGE :

    メッセージ移行

MIGRATE_MESSAGE

filter

string

任意

フィルター条件です。

説明
  • operationKey(トピック名)で結果をフィルターできます。

xx

instanceId

string

任意

インスタンス ID です。

rmq-cn-zxu37eiqq0x

operationStatus

array

任意

操作ステータスの一覧です。

string

任意

操作ステータスです。

DOING

businessStatus

array

任意

ビジネスステータスの一覧です。

string

任意

ビジネスステータスです。

DOUBLE_READ

pageNumber

integer

必須

ページ番号です。

1

pageSize

integer

必須

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

10

レスポンスフィールド

フィールド

説明

object

Result<MyPage>

requestId

string

リクエスト ID です。

C7E8AE3A-219B-52EE-BE32-4036F5F88833

success

boolean

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

true

data

object

返されたデータです。

pageNumber

integer

ページ番号です。

1

pageSize

integer

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

10

totalCount

integer

エントリーの総数です。

1

list

array<object>

エントリーの一覧です。

array<object>

移行操作の一覧です。

operationId

integer

移行操作 ID です。

183

migrationId

integer

移行 ID です。

1

stageType

string

移行ステージです。

列挙値:

  • MIGRATE_MESSAGE :

    メッセージ移行

MIGRATE_MESSAGE

operationType

string

操作タイプです。

列挙値:

  • MIGRATE_MESSAGE :

    メッセージ移行

MIGRATE_MESSAGE

operationStatus

string

操作ステータスです。

列挙値:

  • INIT :

    未開始

  • DONE :

    完了

  • DOING :

    進行中

  • FAIL :

    失敗

DOING

operationKey

string

操作オブジェクトのプライマリキーです。

説明
  • メッセージ移行中、操作オブジェクトはトピック名です。

normal-topic-1

businessStatus

string

操作のビジネスステータスです。

列挙値:

  • MIGRATE_WAIT :

    ソースクラスターから読み取り、書き込みを行います。

  • SWITCH_WRITE :

    ターゲットクラスターに書き込み、ソースクラスターから冗長的に読み取ります。

  • MIGRATE_FINISH :

    ターゲットクラスターから読み取り、書き込みを行います。

  • DOUBLE_READ :

    ソースクラスターに書き込み、ターゲットクラスターから冗長的に読み取ります。

  • ALREADY_MIGRATED :

    移行済み

DOUBLE_READ

operationParam

object

操作パラメーターです。

paramData

any

パラメーターデータです。

{ "action": "MIGRATE_FORWARD", "targetStage": "MIGRATE_FINISH" }

operationResult

object

操作結果です。

resultData

any

操作結果です。

{ "checkStatus": "WAIT_CHECK", "sourceTopicStatus": "PERM_6", "targetTopicStatus": "PERM_4", "checkResult": {}, "migrateStage": "DOUBLE_READ" }

createTime

string

操作が作成された時刻です。

2022-08-01 00:00:00

updateTime

string

操作が最後に更新された時刻です。

2022-08-01 20:05:50

code

string

エラーコードです。

Instance.NotFound

message

string

エラーメッセージです。

The topic already exists.

httpStatusCode

integer

HTTP ステータスコードです。

200

dynamicCode

string

動的エラーコードです。

InstanceId

dynamicMessage

string

動的エラーメッセージです。

consumerGroupId

成功レスポンス

JSONJSON

{
  "requestId": "C7E8AE3A-219B-52EE-BE32-4036F5F88833",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "operationId": 183,
        "migrationId": 1,
        "stageType": "MIGRATE_MESSAGE",
        "operationType": "MIGRATE_MESSAGE",
        "operationStatus": "DOING",
        "operationKey": "normal-topic-1",
        "businessStatus": "DOUBLE_READ",
        "operationParam": {
          "paramData": "{\n      \"action\": \"MIGRATE_FORWARD\",\n      \"targetStage\": \"MIGRATE_FINISH\"\n}"
        },
        "operationResult": {
          "resultData": "{\n      \"checkStatus\": \"WAIT_CHECK\",\n      \"sourceTopicStatus\": \"PERM_6\",\n      \"targetTopicStatus\": \"PERM_4\",\n      \"checkResult\": {},\n      \"migrateStage\": \"DOUBLE_READ\"\n}"
        },
        "createTime": "2022-08-01 00:00:00",
        "updateTime": "2022-08-01 20:05:50"
      }
    ]
  },
  "code": "Instance.NotFound",
  "message": "The topic already exists.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "consumerGroupId"
}

エラーコード

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

変更履歴

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