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

ApsaraMQ for RocketMQ:ExecuteMigrationOperation

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

update

*Instance

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

なし なし

リクエスト構文

POST /migrations/{migrationId}/stages/{stageType}/operations/{operationId}/execute HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

migrationId

integer

必須

移行 ID。

44

stageType

string

必須

移行ステージのタイプ。

列挙値:

  • MIGRATE_MESSAGE :

    メッセージ移行

MIGRATE_MESSAGE

operationId

integer

必須

移行操作 ID。

2729

リクエストパラメーター

パラメーター

必須 / 任意

説明

instanceId

string

任意

インスタンス ID。

rmq-cn-x0r37kel***

body

object

任意

リクエストボディ。

operationParam

object

任意

操作パラメーター。

paramData

any

任意

操作のパラメーター。JSON 文字列として指定します。詳細は例をご参照ください。

action (操作) フィールドには、次の値を指定できます:

  • MIGRATE_FORWARD (順方向移行)

  • MIGRATE_BACKWARD (逆方向移行)

targetStage フィールドには、次の値を指定できます:

  • MIGRATE_WAIT (ソースクラスターからの読み取りとソースクラスターへの書き込み)

  • DOUBLE_READ (ソースクラスターへの書き込みと冗長読み取りの実行)

  • SWITCH_WRITE (移行先クラスターへの書き込みと冗長読み取りの実行)

  • MIGRATE_FINISH (移行先クラスターからの読み取りと移行先クラスターへの書き込み)

説明
  • 順方向移行では、一度に 1 つのステージしか進めることができません。

  • 逆方向移行では、以前の任意のステージにロールバックできます。

迁移前进:{"action":"MIGRATE_FORWARD","targetStage":"MIGRATE_FINISH"} 迁移后退:{"action":"MIGRATE_BACKWARD","targetStage":"MIGRATE_WAIT"}

レスポンスフィールド

フィールド

説明

object

結果

requestId

string

リクエスト ID。

814BCD66-2D76-5080-AAD2-E50E5BDB0995

success

boolean

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

true

data

object

返されたデータ。

operationId

integer

移行操作 ID。

110

migrationId

integer

移行 ID。

6

stageType

string

移行ステージのタイプ。

列挙値:

  • MIGRATE_MESSAGE :

    メッセージを移行します。

MIGRATE_MESSAGE

operationType

string

操作タイプ。

MIGRATE_MESSAGE

operationStatus

string

操作ステータス:

列挙値:

  • INIT :

    操作は開始されていません。

  • DONE :

    操作は完了しました。

  • DOING :

    操作は進行中です。

  • FAIL :

    操作は失敗しました。

DOING

operationKey

string

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

normal-topic-1

businessStatus

string

操作のビジネスステータス:

列挙値:

  • MIGRATE_CHECK :

    ソースクラスターからの読み取りとソースクラスターへの書き込み。

  • SWITCH_WRITE :

    移行先クラスターへの書き込みと冗長読み取りの実行。

  • MIGRATE_FINISH :

    移行先クラスターからの読み取りと移行先クラスターへの書き込み。

  • DOUBLE_READ :

    ソースクラスターへの書き込みと冗長読み取りの実行。

  • ALREADY_MIGRATED :

    オブジェクトは移行済みです。

MIGRATE_WAIT

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 20:05:50

updateTime

string

操作が最後に更新された時間。

2022-08-01 20:05:50

code

string

エラーコード。

Topic.NotFound

message

string

エラーメッセージ。

The topic already exists.

httpStatusCode

integer

HTTP ステータスコード。

200

dynamicCode

string

動的エラーコード。

InstanceId

dynamicMessage

string

動的エラーメッセージ。

instanceId

成功レスポンス

JSONJSON

{
  "requestId": "814BCD66-2D76-5080-AAD2-E50E5BDB0995",
  "success": true,
  "data": {
    "operationId": 110,
    "migrationId": 6,
    "stageType": "MIGRATE_MESSAGE",
    "operationType": "MIGRATE_MESSAGE",
    "operationStatus": "DOING",
    "operationKey": "normal-topic-1",
    "businessStatus": "MIGRATE_WAIT",
    "operationParam": {
      "paramData": "{\"action\":\"MIGRATE_FORWARD\",\"targetStage\":\"MIGRATE_FINISH\"}"
    },
    "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 20:05:50",
    "updateTime": "2022-08-01 20:05:50"
  },
  "code": "Topic.NotFound",
  "message": "The topic already exists.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

エラーコード

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

変更履歴

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