停止数据迁移任务
功能介绍
停止数据迁移任务。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/migration-task/{task_id}/stop
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
task_id |
是 |
String |
任务ID |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
迁移任务ID。 |
task_name |
String |
迁移任务名称。 |
description |
String |
迁移任务描述。 |
status |
String |
迁移任务状态,这个字段的值包括:SUCCESS(成功), FAILED(失败), MIGRATING(迁移中),TERMINATED(已结束),TERMINATING(停止中),INCRMIGEATING(增量迁移中),FULLMIGRATING(全量迁移中),RUNNING(待配置),MIGRATION_FAILED(迁移失败),RELEASED(已释放)。 枚举值:
|
migration_type |
String |
迁移任务类型,包括备份文件导入和在线迁移两种类型。 枚举值:
|
migration_method |
String |
迁移方式,包括全量迁移和增量迁移两种类型。 枚举值:
|
ecs_tenant_private_ip |
String |
迁移机租户侧私有IP,与目的/源redis私有IP处于同VPC,可将此IP加入白名单。 |
backup_files |
BackupFilesBody object |
备份文件导入场景的备份文件列表。 |
network_type |
String |
网络类型,包括vpc和vpn两种类型。 枚举值:
|
source_instance |
SourceInstanceBody object |
源Redis信息。在线迁移场景需要填写。 |
target_instance |
TargetInstanceBody object |
目标Redis信息。 |
created_at |
String |
迁移任务创建时间。 |
updated_at |
String |
迁移任务完成时间。 |
released_at |
String |
迁移机释放时间。 |
version |
String |
版本。 |
resume_mode |
String |
操作模式,分为auto和manual。 |
supported_features |
Array of strings |
支持的特性。 |
tenant_vpc_id |
String |
租户VPC ID。 |
tenant_subnet_id |
String |
租户子网ID。 |
tenant_security_group_id |
String |
租户安全组ID。 |
bandwidth_limit_mb |
String |
带宽限制速度。 |
task_status |
String |
任务状态。 |
参数 |
参数类型 |
描述 |
---|---|---|
file_source |
String |
数据来源,包含OBS桶和备份记录两种类型。 枚举值:
|
bucket_name |
String |
OBS桶名。 |
files |
Array of Files objects |
导入的备份文件文件列表,数据来源为OBS桶时必须填写。 |
backup_id |
String |
备份记录ID,数据来源为备份记录时必须填写。 |
参数 |
参数类型 |
描述 |
---|---|---|
file_name |
String |
备份文件名。 |
size |
String |
文件大小(单位:Byte)。 |
update_at |
String |
文件最后修改时间(格式YYYY-MM-DD HH:MM:SS)。 |
参数 |
参数类型 |
描述 |
---|---|---|
addrs |
String |
Redis实例地址(source_instance信息中填写)。 |
password |
String |
Redis密码,如果设置了密码,则必须填写。 |
task_status |
String |
任务状态。 |
id |
String |
Redis实例ID。 |
ip |
String |
Redis IP地址。 |
port |
String |
Redis端口。 |
name |
String |
Redis名称。 |
proxy_multi_db |
Boolean |
proxy实例是否开启了多DB。 |
db |
String |
Redis数据库。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
Redis实例ID(target_instance信息中必须填写)。 |
name |
String |
Redis实例名称(target_instance信息中填写)。 |
password |
String |
Redis密码,如果设置了密码,则必须填写。 |
task_status |
String |
任务状态。 |
ip |
String |
Redis IP地址。 |
port |
String |
Redis端口。 |
addrs |
String |
Redis实例地址。 |
proxy_multi_db |
Boolean |
proxy实例是否开启了多DB。 |
db |
String |
Redis数据库。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信息(暂未使用,赋值为null)。 最大长度:1024 |
请求示例
POST https://{dcs_endpoint}/v2/666486c2d9b948c1bbea57e714d744fa/migration-task/2fb6b7e2-5eb8-4380-9d60-ce8d12b19aca/stop
响应示例
状态码: 200
停止数据迁移任务成功。
{ "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" }
SDK代码示例
SDK代码示例如下。
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 |
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 StopMigrationTaskSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); StopMigrationTaskRequest request = new StopMigrationTaskRequest(); try { StopMigrationTaskResponse response = client.stopMigrationTask(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 |
# 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"] credentials = BasicCredentials(ak, sk) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = StopMigrationTaskRequest() response = client.stop_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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.StopMigrationTaskRequest{} response, err := client.StopMigrationTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
停止数据迁移任务成功。 |
400 |
非法请求。 |
401 |
认证信息非法。 |
403 |
请求被拒绝访问。 |
404 |
所请求的资源不存在。 |
500 |
内部服务错误。 |
错误码
请参见错误码。