ListMigrations - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries migration tasks.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /migrations HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
filter	string	No	The filter condition for the query.	xx
migrationType	string	Yes	The migration type: INSTANCE_MIGRATION: instance migration Valid values: INSTANCE_MIGRATION : Instance migration	INSTANCE_MIGRATION
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
resourceGroupId	string	No	The resource group ID.	rg-acfm4goe2ckfiva

Response elements

Element	Type	Description	Example
	object	Result<MyPage>
requestId	string	The request ID.	E5897B2E-C3AC-56DC-A482-F0E9E53F48D5
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.	3
totalCount	integer	The total number of entries.	1
list	array<object>	The data on the current page.
	array<object>	The list of migration tasks.
migrationId	integer	The migration ID.	21
migrationName	string	The migration name.	xxx
migrationType	string	The migration type: INSTANCE_MIGRATION: instance migration	INSTANCE_MIGRATION
migrationStatus	string	The migration status: CREATED: Created MIGRATING: In progress COMPLETED: Complete CANCELLED: Canceled Valid values: CANCELLED : Canceled CREATED : Created COMPLETED : Complete MIGRATING : In progress	MIGRATING
userId	string	The user ID.	111
currentStage	object	The current migration stage.
stageType	string	The stage type. CONNECT_NETWORK: Network connection MIGRATE_METADATA: Metadata migration REPLACE_ENDPOINT: Endpoint replacement MIGRATE_MESSAGE: Message migration Valid values: REPLACE_ENDPOINT : Endpoint replacement MIGRATE_METADATA : Metadata migration CONNECT_NETWOR : Network connection MIGRATE_MESSAGE : Message migration	MIGRATE_METADATA
stageStatus	string	The stage status: INIT: Not started DOING: In progress DONE: Complete Valid values: INIT : Not started DONE : Complete DOING : In progress	DOING
stageData	any	The stage data.	[]
migrationSource	object	The migration source.
sourceType	string	The migration source type: EXTERNAL_INSTANCE: External instance INTERNAL_INSTANCE: Alibaba Cloud V5.0 instance Valid values: EXTERNAL_INSTANCE : External instance INTERNAL_INSTANCE : Alibaba Cloud V5.0 instance	EXTERNAL_INSTANCE
sourceData	any	The source data.	{ "clusterType":"INTERNET_NETWORK", "aclType":"NONE", "clusterName":"test", "namesrvAddrList":"47.110.248.xxx:9876"], "brokerObtainMethod":"AUTO_OBTAIN" }
migrationTarget	object	The migration target.
targetType	string	The migration target type: INTERNAL_INSTANCE: Alibaba Cloud V5.0 instance Valid values: INTERNAL_INSTANCE : Alibaba Cloud V5.0 instance	INTERNAL_INSTANCE
targetData	any	The target data.	{ "clusterType":"ROCKETMQ_V5", "instanceId":"rmq-cn-778429mp301", "regionId":"cn-hangzhou" }
createTime	string	The time when the task was created.	2022-08-01 00:00:00
updateTime	string	The time when the task was last updated.	2022-08-01 20:05:50
code	string	The error code.	MissingInstanceId
message	string	The error message.	The instance cannot be found.
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.