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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Offset, which is the position where the query starts. The value must be greater than or equal to 0. |
limit |
No |
Integer |
Number of items displayed on each page. |
name |
No |
String |
Name of the migration task. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Number of migration tasks. |
migration_tasks |
Array of MigrationTaskList objects |
Migration task list. |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Migration task ID. |
task_name |
String |
Migration task name. |
status |
String |
Migration status. Options: SUCCESS, FAILED, MIGRATING, TERMINATED. |
migration_type |
String |
Migration mode, which can be backup file import or online migration. |
migration_method |
String |
Type of the migration, which can be full migration or 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. |
data_source |
String |
Source Redis address, which is ip:port or a bucket name. |
source_instance_name |
String |
Name of the source instance. If the source Redis is self-hosted, this parameter is left blank. |
source_instance_id |
String |
ID of the source instance. If the source Redis is self-hosted, this parameter is left blank. |
target_instance_addrs |
String |
Target Redis address. The format is ip:port. |
target_instance_name |
String |
Target instance name. |
target_instance_id |
String |
Target instance ID. |
created_at |
String |
Time when the migration task is created. |
description |
String |
Description of the migration task. |
source_instance_status |
String |
Status of the source instance. If the source Redis is self-hosted, this parameter is left blank. |
target_instance_status |
String |
Status of the target instance. |
source_instance_subnet_id |
String |
ID of the source instance subnet. If the source Redis is self-hosted, this parameter is left blank. |
target_instance_subnet_id |
String |
ID of the target instance subnet. |
source_instance_spec_code |
String |
Specification code of the source instance. If the source Redis is self-hosted, this parameter is left blank. |
target_instance_spec_code |
String |
Specification code of the target instance. |
error_message |
String |
Error message. |
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. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
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" : [ ] } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ListMigrationTaskSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); ListMigrationTaskRequest request = new ListMigrationTaskRequest(); try { ListMigrationTaskResponse response = client.listMigrationTask(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListMigrationTaskRequest() response = client.list_migration_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListMigrationTaskRequest{} response, err := client.ListMigrationTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot