Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Scalable File Service Turbo
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying Details of a Data Migration Task

Function

This API is used to query migration task details.

URI

GET /v2/{project_id}/migration-task/{task_id}

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.

released_at

String

Time when the migration ECS is released.

version

String

Version.

resume_mode

String

Operation mode, which can be auto or manual.

supported_features

Array of strings

Supported features.

tenant_vpc_id

String

VPC ID.

tenant_subnet_id

String

Subnet ID.

tenant_security_group_id

String

Security group ID.

bandwidth_limit_mb

String

Maximum bandwidth.

task_status

String

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

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.

task_status

String

Task status.

id

String

Redis instance ID.

ip

String

Redis IP address.

port

String

Redis port.

name

String

Redis name.

proxy_multi_db

Boolean

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

db

String

Redis database.

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.

task_status

String

Task status.

ip

String

Redis IP address.

port

String

Redis port.

addrs

String

Redis instance address.

proxy_multi_db

Boolean

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

db

String

Redis database.

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

GET https://{dcs_endpoint}/v2/254d2280acb74d36a8b839746bcd7352 /migration-task/a276c1ffa0a54c2597fc824b917db317

Example Responses

Status code: 200

Details of a data migration task queried successfully.

{
  "task_name" : "migration1",
  "task_id" : "a276c1ffa0a54c2597fc824b917db317",
  "status" : "TERMINATING",
  "migration_type" : "incremental_migration",
  "network_type" : "vpc",
  "source_instance" : {
    "addrs" : "192.168.1.2:6379",
    "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927e1",
    "name" : "dcs-test",
    "ip" : "192.168.1.2",
    "port" : "6379",
    "proxy_multi_db" : false,
    "password" : "DCStest123",
    "task_status" : "RUNNING",
    "db" : "0"
  },
  "target_instance" : {
    "addrs" : "192.168.1.2:6379",
    "id" : "86157b69-8a62-47f9-8c55-fa6ddc8927ee",
    "name" : "test-instance",
    "ip" : "192.168.1.2",
    "port" : "6379",
    "proxy_multi_db" : false,
    "password" : "DCStest123",
    "task_status" : "RUNNING",
    "db" : "0"
  },
  "created_at" : "2019/10/22 14:44:30",
  "updated_at" : "2019/10/22 18:00:00"
}

Status Codes

Status Code

Description

200

Details of a data migration task queried 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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback