Updated on 2023-12-13 GMT+08:00

Stopping a Data Migration Task

Function

This API is used to stop a data migration task.

URI

POST /v2/{project_id}/migration-task/{task_id}/stop

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

task_id

Yes

String

Task ID

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

task_id

String

Migration task ID.

task_name

String

Migration task name.

description

String

Migration task description.

status

String

Migration task status. The value can be SUCCESS, FAILED, MIGRATING, TERMINATED, TERMINATING, INCRMIGRATING, FULLMIGRATING, RUNNING** (pending configuration), MIGRATION_FAILED, or RELEASED.

Enumeration values:

  • SUCCESS

  • FAILED

  • MIGRATING

  • TERMINATED

  • TERMINATING

  • INCRMIGEATING

  • FULLMIGRATING

  • RUNNING

  • MIGRATION_FAILED

  • RELEASED

migration_type

String

Migration mode, which can be backup file import or online migration.

Enumeration values:

  • backupfile_import

  • online_migration

migration_method

String

Type of the migration, which can be full migration or incremental migration.

Enumeration values:

  • full_amount_migration

  • incremental_migration

ecs_tenant_private_ip

String

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.

backup_files

BackupFilesBody object

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

network_type

String

Network type, which can be VPC or VPN.

Enumeration values:

  • vpc

  • vpn

source_instance

SourceInstanceBody object

Source Redis information. This parameter is mandatory for online migration.

target_instance

TargetInstanceBody object

Target Redis instance information.

created_at

String

Time when the migration task is created.

updated_at

String

Time when the migration task is complete.

Table 3 BackupFilesBody

Parameter

Type

Description

file_source

String

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

Enumeration values:

  • self_build_obs

  • backup_record

bucket_name

String

Name of the OBS bucket.

files

Array of Files objects

List of backup files to be imported. This parameter is mandatory when the data source is an OBS bucket.

backup_id

String

Backup record ID. This parameter is mandatory when the data source is a backup record.

Table 4 Files

Parameter

Type

Description

file_name

String

Name of a backup file.

size

String

File size in bytes.

update_at

String

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

Table 5 SourceInstanceBody

Parameter

Type

Description

addrs

String

Source Redis address (specified in the source_instance parameter).

password

String

Redis password. If a password is set, this parameter is mandatory.

Table 6 TargetInstanceBody

Parameter

Type

Description

id

String

Redis instance ID (mandatory in the target_instance parameter).

name

String

Redis instance name (specified in the target_instance parameter).

password

String

Redis password. If a password is set, this parameter is mandatory.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

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

Maximum: 1024

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

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

Maximum: 1024

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

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

Maximum: 1024

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

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

Maximum: 1024

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

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

Maximum: 1024

Example Requests

POST https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-task/2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca/stop

Example Responses

Status code: 200

Data migration task stopped successfully.

{
  "task_name" : "migration1",
  "task_id" : "a276c1ffa0a54c2597fc824b917db317",
  "status" : "TERMINATING",
  "migration_type" : "incremental_migration",
  "network_type" : "vpc",
  "source_instance" : {
    "addrs" : "192.168.1.2:6379"
  },
  "target_instance" : {
    "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927ee",
    "name" : "test-instance"
  },
  "created_at" : "2019/10/22 14:44:30",
  "updated_at" : "2019/10/22 18:00:00"
}

Status Codes

Status Code

Description

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.

Error Codes

See Error Codes.