すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:ListMigrationOperations

    ドキュメントセンター

    ApsaraMQ for RocketMQ:ListMigrationOperations

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

    list

    *インスタンス。

    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

    任意

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

    説明

    • Topic 名である操作キーによるフィルタリングをサポートします。

    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

    ページサイズ。

    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

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

    説明

    • メッセージ移行ステージでは、操作オブジェクトは Topic 名です。

    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

    作成時間。フォーマットは 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

    エラーコード。

    Instance.NotFound
    message

    string

    エラーメッセージ。

    Topic は既に存在します
    httpStatusCode

    integer

    HTTP 状態コード。

    200
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

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

    例

    成功レスポンス

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

    エラーコード

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

    変更履歴

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