All Products
Search

This Product

    ApsaraMQ for RocketMQ:ListMigrationOperations

    Document Center

    ApsaraMQ for RocketMQ:ListMigrationOperations

    Last Updated:Dec 19, 2025

    Queries a list of migration operations.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    rocketmq:ListMigrationOperations

    list

    *Instance

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

    		 None None

    Request syntax

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    migrationId

    integer

    Yes

    The migration ID.

    135
    stageType

    string

    Yes

    The type of the migration stage.

    Valid values:

    • MIGRATE_MESSAGE :

      Message migration

    MIGRATE_MESSAGE
    operationType

    string

    Yes

    The type of the operation.

    Valid values:

    • MIGRATE_MESSAGE :

      Migrate message

    MIGRATE_MESSAGE
    filter

    string

    No

    The filter condition for the query.

    Note

    • You can filter the results by operationKey, which is the topic name.

    xx
    instanceId

    string

    No

    The instance ID.

    rmq-cn-zxu37eiqq0x
    pageNumber

    integer

    Yes

    The page number of the results to return.

    1
    pageSize

    integer

    Yes

    The number of entries to return on each page.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    Result<MyPage>

    requestId

    string

    The request ID.

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

    boolean

    Indicates whether the request was successful.

    true
    data

    object

    The returned data.

    pageNumber

    integer

    The current page number.

    1
    pageSize

    integer

    The number of entries per page.

    10
    totalCount

    integer

    The total number of records.

    1
    list

    array<object>

    The paged data.

    object

    The list of migration operations.

    operationId

    integer

    The migration operation ID.

    183
    migrationId

    integer

    The migration ID.

    1
    stageType

    string

    The type of the migration stage.

    Valid values:

    • MIGRATE_MESSAGE :

      Message migration

    MIGRATE_MESSAGE
    operationType

    string

    The type of the operation.

    Valid values:

    • MIGRATE_MESSAGE :

      Migrate message

    MIGRATE_MESSAGE
    operationStatus

    string

    The status of the operation:

    • INIT (Not started)

    • DOING (In progress)

    • DONE (Completed)

    • FAIL (Failed)

    Valid values:

    • INIT :

      Not started

    • DONE :

      Completed

    • DOING :

      In progress

    • FAIL :

      Failed

    DOING
    operationKey

    string

    The primary key of the operation object.

    Note

    • During the message migration stage, the operation object is the topic name.

    normal-topic-1
    businessStatus

    string

    The business status of the operation.

    Valid values:

    • MIGRATE_WAIT :

      Read from and write to the source cluster.

    • SWITCH_WRITE :

      Write to the target cluster with redundant reads.

    • MIGRATE_FINISH :

      Read from and write to the target cluster.

    • DOUBLE_READ :

      Write to the source cluster with redundant reads.

    • ALREADY_MIGRATED :

      Migrated.

    DOUBLE_READ
    operationParam

    object

    The operation parameters.

    paramData

    any

    The parameter information.

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

    object

    The operation result.

    resultData

    any

    The operation result.

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

    string

    The time when the operation was created.

    2022-08-01 00:00:00
    updateTime

    string

    The time when the operation was last updated.

    2022-08-01 20:05:50
    code

    string

    The error code.

    Instance.NotFound
    message

    string

    The error message.

    The topic already exists.
    httpStatusCode

    integer

    The HTTP status code.

    200
    dynamicCode

    string

    The dynamic error code.

    InstanceId
    dynamicMessage

    string

    The dynamic error message.

    consumerGroupId

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.