Help Center/ Distributed Cache Service/ API Reference/ API V2/ Data Migration/ Listing Migration Tasks
Updated on 2025-05-13 GMT+08:00
View PDF

Listing Migration Tasks

Function

This API is used to query the migration task list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/migration-tasks

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Parameter description:

Offset, which is the position where the query starts.

Constraints:

N/A.

Value range:

≥ 0

Default value:

0

limit

No

Integer

Parameter description:

Number of records displayed on each page.

Constraints:

N/A.

Value range:

1–1,000

Default value:

10

name

No

String

Parameter description:

Name of the migration task.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

Parameter description:

Number of migration tasks.

Value range:

N/A.

migration_tasks

Array of MigrationTaskList objects

Parameter description:

Migration task list.

Value range:

N/A.
Table 4 MigrationTaskList

Parameter

Type

Description

task_id

String

Parameter description:

Migration task ID.

Value range:

N/A.

task_name

String

Parameter description:

Migration task name.

Value range:

N/A.

status

String

Parameter description:

Migration status.

Value range:

  • SUCCESS: The task succeeded.

  • FAILED: The task failed.

  • MIGRATING: Migration is in progress.

  • TERMINATED: The task has stopped.

migration_type

String

Parameter description:

Migration mode.

Value range:

  • backupfile_import: backup file import

  • online_migration: online migration

migration_method

String

Parameter description:

Type of the migration.

Value range:

  • full_amount_migration: full migration

  • incremental_migration: incremental migration

ecs_tenant_private_ip

String

Parameter description:

Private IP address of the migration ECS on the tenant side. This IP address can be added to the whitelist if it is in the same VPC as the private IP address of the target or source Redis.

Value range:

N/A.

data_source

String

Parameter description:

Source Redis address, which is ip:port or a bucket name.

Value range:

N/A.

source_instance_name

String

Parameter description:

Name of the source instance. If the source Redis is self-hosted, this parameter is left blank.

Value range:

N/A.

source_instance_id

String

Parameter description:

ID of the source instance. If the source Redis is self-hosted, this parameter is left blank.

Value range:

N/A.

target_instance_addrs

String

Parameter description:

Target Redis address. The format is ip:port.

Value range:

N/A.

target_instance_name

String

Parameter description:

Target instance name.

Value range:

N/A.

target_instance_id

String

Parameter description:

Target instance ID.

Value range:

N/A.

created_at

String

Parameter description:

Time when the migration task is created.

Value range:

N/A.

description

String

Parameter description:

Description of the migration task.

Value range:

N/A.

source_instance_status

String

Parameter description:

Status of the source instance. If the source Redis is self-hosted, this parameter is left blank.

Value range:

N/A.

target_instance_status

String

Parameter description:

Status of the target instance.

Value range:

N/A.

source_instance_subnet_id

String

Parameter description:

ID of the source instance subnet. If the source Redis is self-hosted, this parameter is left blank.

Value range:

N/A.

target_instance_subnet_id

String

Parameter description:

ID of the target instance subnet.

Value range:

N/A.

source_instance_spec_code

String

Parameter description:

Specification code of the source instance. If the source Redis is self-hosted, this parameter is left blank.

Value range:

N/A.

target_instance_spec_code

String

Parameter description:

Specification code of the target instance.

Value range:

N/A.

error_message

String

Parameter description:

Error message.

Value range:

N/A.

released_at

String

Parameter description:

Time when the migration ECS is released.

Value range:

N/A.

version

String

Parameter description:

Migration task version.

Value range:

N/A.

resume_mode

String

Parameter description:

Operation mode of the migration task.

Value range:

  • auto: automatically reconnect

  • manual: manually reconnect

supported_features

Array of strings

Parameter description:

Supported features.

Value range:

N/A.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A.

error_code

String

Parameter description:

Error code.

Value range:

For details, see Error Codes.

error_ext_msg

String

Parameter description:

Extended error information. This parameter is not used currently and is set to null.

Value range:

N/A.

Example Requests

GET https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-tasks?offset=0&limit=10&name=dcs-migration-i9qk

Example Responses

Status code: 200

Querying the migration task list.

{
  "count" : 1,
  "migration_tasks" : [ {
    "task_id" : "2944a563-6f27-4604-9c16-a9a53cd95cc7",
    "task_name" : "dcs-migration-test-6-16",
    "status" : "TERMINATED",
    "migration_type" : "online_migration",
    "migration_method" : "incremental_migration",
    "data_source" : "192.168.0.200:6379",
    "source_instance_name" : "migration-resource",
    "source_instance_id" : "132e0017-715b-4556-930a-95c7db7e8f7a",
    "target_instance_addrs" : "192.168.0.153:6379",
    "target_instance_name" : "migration-target",
    "target_instance_id" : "eb1a8d1c-9ea6-4fcd-ac43-c3d3c2493f06",
    "created_at" : "2021-06-16T06:12:55.508Z",
    "description" : "dcs-test",
    "source_instance_status" : "RUNNING",
    "target_instance_status" : "RUNNING",
    "source_instance_subnet_id" : "192.168.0.1",
    "target_instance_subnet_id" : "192.168.0.2",
    "source_instance_spec_code" : "redis.single.xu1.tiny.128",
    "target_instance_spec_code" : "redis.single.xu1.tiny.128",
    "error_message" : null,
    "released_at" : "202404011057",
    "version" : "6.0.21",
    "resume_mode" : "auto",
    "supported_features" : [ ]
  } ]
}

Status Codes

Status Code

Description

200

Querying the migration task list.

400

Invalid request.

401

Invalid authentication information.

403

The request is rejected.

404

The requested resource is not found.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Data Migration