Stopping a Data Migration Task

project_id

Yes

String

Definition:

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

Constraints:

N/A

Range:

N/A

Default Value:

N/A

task_id

Yes

String

Definition:

ID of the data migration task.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

task_id

String

Definition:

Migration task ID.

Range:

N/A

task_name

String

Definition:

Name of the migration task.

Range:

N/A

description

String

Definition:

Description of the migration task.

Range:

N/A

status

String

Definition

Status of the migration task.

Range

• SUCCESS: The task succeeded.

• FAILED: The task failed.

• MIGRATING: Migration is in progress.

• TERMINATED: The task has stopped.

• TERMINATING: The task is being stopped.

• INCRMIGEATING: Incremental migration is in progress.

• FULLMIGRATING: Full migration is in progress.

• RUNNING: The task is to be configured.

• MIGRATION_FAILED: The migration failed.

• RELEASED: The task has been released.

migration_type

String

Definition

Description of the migration task.

Range

• backupfile_import: backup import

• online_migration: online migration

migration_method

String

Definition:

Type of the migration.

Range:

• full_amount_migration: full migration

• incremental_migration: online migration

ecs_tenant_private_ip

String

Definition:

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.

Range:

N/A

backup_files

BackupFilesRespBody object

Definition:

Backup files to be imported when the migration mode is backup file import.

network_type

String

Definition:

Network type. The value can be vpc or vpn.

Range:

• vpc

• vpn

source_instance

SourceInstanceRespBody object

Definition:

Source Redis information.

target_instance

TargetInstanceRespBody object

Definition:

Target Redis instance information.

created_at

String

Definition:

Time when the migration task is created.

Range:

N/A

updated_at

String

Definition:

Time when the migration task is complete.

Range:

N/A

released_at

String

Definition:

Time when the migration ECS is released.

Range:

N/A

version

String

Definition:

Version of the migration ECS.

Range:

N/A

resume_mode

String

Definition:

Data migration mode.

Range:

• auto: automatic migration

• manual: manual migration

supported_features

Array of strings

Definition:

Supported features.

Range:

N/A

tenant_vpc_id

String

Definition:

VPC ID.

Range:

N/A

tenant_subnet_id

String

Definition:

Subnet ID.

Range:

N/A

tenant_security_group_id

String

Definition:

Security group ID.

Range:

N/A

bandwidth_limit_mb

String

Definition:

Maximum bandwidth.

Range:

N/A

task_status

String

Definition:

Task status. EXCHANGING is returned only when IP addresses are being switched.

Range:

EXCHANGING: IP addresses are being switched.

file_source

String

Definition:

Data source, which can be an OBS bucket or a backup record.

Range:

• self_build_obs: OBS bucket data.

• backup_record: Redis backup file.

bucket_name

String

Definition:

OBS bucket name.

Range:

N/A

files

Array of FilesResp objects

Definition:

List of backup files to be imported.

backup_id

String

Definition:

Backup record ID.

Range:

N/A

file_name

String

Definition:

Name of a backup file.

Range:

N/A

size

String

Definition:

File size in bytes.

Range:

N/A

update_at

String

Definition:

Time when the file is last modified. The format is YYYY-MM-DD HH:MM:SS.

Range:

N/A

addrs

String

Definition:

IP address and domain name of the Redis instance.

Range:

N/A

password

String

Definition:

Redis password.

Range:

N/A

id

String

Definition:

Redis instance ID.

Range:

N/A

ip

String

Definition:

Redis IP address.

Range:

N/A

port

String

Definition:

Redis port.

Range:

N/A

name

String

Definition:

Redis name.

Range:

N/A

proxy_multi_db

Boolean

Definition:

Indicates whether multi-DB is enabled for Proxy Cluster DCS instances.

Range:

• true: Yes

• false: No

db

String

Definition:

Redis database.

Range:

0–255

withProxy

Boolean

Definition:

Indicates whether proxy nodes are available.

Range:

• true: Yes

• false: No

addrs

String

Definition:

Source Redis address (specified in the source_instance parameter).

Range:

N/A

password

String

Definition:

Redis password.

Range:

N/A

id

String

Definition:

Redis instance ID.

Range:

N/A

ip

String

Definition:

Redis IP address.

Range:

N/A

port

String

Definition:

Redis port.

Range:

N/A

name

String

Definition:

Redis name.

Range:

N/A

proxy_multi_db

Boolean

Definition:

Indicates whether multi-DB is enabled for Proxy Cluster DCS instances.

Range:

• true: Yes

• false: No

db

String

Definition:

Redis database.

Range:

0–255

withProxy

Boolean

Definition:

Indicates whether proxy nodes are available.

Range:

• true: Yes

• false: No

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.

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.

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.

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.

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.

200

Data migration task stopped successfully.

400

Invalid request.

401

Invalid authentication information.

403

The request is rejected.

404

The requested resource is not found.

500

Internal service error.