Listing Migration Tasks
Function
This API is used to query the migration task list.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
dcs:migrationTask:list
List
-
-
-
-
URI
GET /v2/{project_id}/migration-tasks
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| offset | No | Integer | Definition Offset, which indicates that the generated list is displayed from this offset. For example, if the offset is 3, the generated list is displayed from the fourth record. Constraints N/A Range The value is greater than or equal to 0. Default Value 0 |
| limit | No | Integer | Definition Number of records displayed per page. Constraints N/A Range 1-1000 Default Value 10 |
| name | No | String | Definition Migration task name. Constraints N/A Range N/A Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| count | Integer | Definition Number of migration tasks. Range N/A |
| migration_tasks | Array of MigrationTaskList objects | Definition Migration task list. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | Definition Migration task ID. Range N/A |
| task_name | String | Definition Migration task name. Range N/A |
| status | String | Definition Status of the migration task. Range |
| migration_type | String | Definition Migration task type. Range |
| migration_method | String | Definition Migration type. Range |
| 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 |
| data_source | String | Definition Source Redis address, which is ip:port or a bucket name. Range N/A |
| source_instance_name | String | Definition Source instance name. If the source instance is a self-hosted Redis instance, this parameter is left empty. Range N/A |
| source_instance_id | String | Definition Source instance ID. If the source instance is a self-hosted Redis instance, this parameter is left empty. Range N/A |
| target_instance_addrs | String | Definition Target Redis address. The format is ip:port. Range N/A |
| target_instance_name | String | Definition Target instance name. Range N/A |
| target_instance_id | String | Definition Target instance ID. Range N/A |
| created_at | String | Definition Time when the migration task is created. Range N/A |
| description | String | Definition Description of the migration task. Range N/A |
| source_instance_status | String | Definition Source instance status. If the source instance is a self-hosted Redis instance, this parameter is left empty. Range N/A |
| target_instance_status | String | Definition Status of the target instance. Range For details, see DCS Instance Statuses. |
| source_instance_subnet_id | String | Definition Source instance subnet ID. If the source instance is a self-hosted Redis instance, this parameter is left empty. Range N/A |
| target_instance_subnet_id | String | Definition ID of the target instance subnet. Range N/A |
| source_instance_spec_code | String | Definition Source instance specification code. If the source instance is a self-hosted Redis instance, this parameter is left empty. Range N/A |
| target_instance_spec_code | String | Definition Specification code of the target instance. Range N/A |
| error_message | String | Definition Error information. Range N/A |
| released_at | String | Definition Time when the migration ECS is released. Range N/A |
| version | String | Definition Migration task version. Range N/A |
| resume_mode | String | Definition Reconnection mode of the migration tasks. Range |
| supported_features | Array of strings | Definition Supported features. Range N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Definition Error information. Range N/A |
| error_code | String | Definition Error code. Range For details, see Error Codes. |
| error_ext_msg | String | Definition Extended error information. This parameter is not used currently and is set to null. Range N/A |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Definition Error information. Range N/A |
| error_code | String | Definition Error code. Range For details, see Error Codes. |
| error_ext_msg | String | Definition Extended error information. This parameter is not used currently and is set to null. Range N/A |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Definition Error information. Range N/A |
| error_code | String | Definition Error code. Range For details, see Error Codes. |
| error_ext_msg | String | Definition Extended error information. This parameter is not used currently and is set to null. Range N/A |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Definition Error information. Range N/A |
| error_code | String | Definition Error code. Range For details, see Error Codes. |
| error_ext_msg | String | Definition Extended error information. This parameter is not used currently and is set to null. Range N/A |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Definition Error information. Range N/A |
| error_code | String | Definition Error code. Range For details, see Error Codes. |
| error_ext_msg | String | Definition Extended error information. This parameter is not used currently and is set to null. 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",
"ecs_tenant_private_ip" : "192.168.6.44",
"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" : "2024-04-01T10:57:00.000Z",
"version" : "6.0.21",
"resume_mode" : "auto",
"supported_features" : [ ]
} ]
} SDK Sample Code
The SDK sample code is as follows.
Java
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()); } } } |
Python
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) |
Go
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 48 49 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) request := &model.ListMigrationTaskRequest{} response, err := client.ListMigrationTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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.
What is your overall rating for this page?
Thank 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