迁移任务管理

最近更新时间:2018-12-20 17:39:40

CreateTask 创建任务

创建迁移任务。

注意:当预检查全部通过时,才可以正式创建前一任务。

请求方法

GET

请求参数

英文名称 中文名称 类型 是否必填 备注
Action 调用接口名称 String 取固定值:CreateTask
Version API版本号 String 取固定值:2018-01-08
SourceType 数据迁移类型 String 为 公网迁移:"Public" 或 专线迁移:"SpecialLine" 或 RDS到RDS 迁移 "Krds"
TaskName 任务名称 String -
SubTask 迁移类型 String 结构迁移:SchemaMigration, 全量迁移:BackupRecovery, 增量迁移:RunReplication,多参数间使用‘,’分隔,后面的迁移类型依赖前面的迁移类型,具体用法可参见下方示例
PrecheckId 预检查ID String 完全成功的预检查ID

返回值

英文名称 中文名称 类型 备注
task_id 任务ID String 如创建失败则没有任务id

请求示例

http://dts.cn-shanghai-2.api.ksyun.com/?Action=CreateTask&Version=2018-01-08&PrecheckId=bcd408c7-c6ea-4c18-8977-e6dfa0046f68&SubTask=SchemaMigration,BackupRecovery,RunReplication&TaskName=test&SourceType=Krds

返回示例

{
    "Data": {
        "TaskId": "7bd9202b8c75497d"
    },
    "RequestId": "ca20f0b7-8485-4cbf-99bc-67e277fbb8a9"
}

DescribeTask 任务查询

查看已经创建好的任务。

请求方法

GET

请求参数

英文名称 中文名称 类型 是否必填 备注
Action 调用接口名称 String 取固定值:DescribeTask
Version API版本号 String 取固定值:2018-01-08
TaskId 数据迁移类型 String 若不传,则返回任务列表

返回值

英文名称 中文名称 类型 备注
TaskName 任务名称 String -
TaskId 任务ID String -
TaskStatus 任务状态 String 运行中:RUNNING 运行失败:ERROR 完成:FINISHED 失败:FAILED 暂停:PAUSED 删除:DELETED
Created 创建时间 String -
ConnConfigId 配置ID String 忽略
SourceType 迁移类型 String -
SourceHost 源实例地址 String -
SourcePort 源实例端口 String -
TargetInstanceId 目标实例ID String
SubTask 子任务任务类型 String -
SubTasks 子任务列表 String -

请求示例

http://dts.cn-shanghai-2.api.ksyun.com/?Action=DescribeTask&Version=2018-01-08&&TaskId=7bd9202b8c75497d

返回示例

{
    "Data": {
        "Tasks": [
            {
                "TaskName": "test",
                "TaskId": "7bd9202b8c75497d",
                "TaskStatus": "UNSTARTED",
                "Created": "Oct 15, 2018 7:28:35 PM",
                "ConnConfigId": "7cc8fe9f-ca8d-4129-9683-9e641f22f21d",
                "SourceType": "Krds",
                "SourceHost": "10.102.2.51",
                "SourcePort": 3306,
                "TargetInstanceId": "ce2e67fe-89f5-47fb-96f2-f190f1380314",
                "SubTask": "SchemaMigration,BackupRecovery,RunReplication",
                "SubTasks": [
                    {
                        "Id": "68adea68-f877-4c46-9c3d-65e3573a47b8",
                        "TaskId": "7bd9202b8c75497d",
                        "ConnConfigId": "7cc8fe9f-ca8d-4129-9683-9e641f22f21d",
                        "Name": "RunReplication",
                        "Status": "UNSTARTED",
                        "Judging": 0,
                        "Region": "cn-shanghai-2",
                        "Created": "Oct 15, 2018 7:28:35 PM",
                        "Updated": "Oct 15, 2018 7:28:35 PM",
                        "Deleted": 0,
                        "Progress": 0,
                        "AccountId": "73403574"
                    },
                    {
                        "Id": "6b0a63ed-df35-4232-aeb8-a0c025e177f6",
                        "TaskId": "7bd9202b8c75497d",
                        "ConnConfigId": "7cc8fe9f-ca8d-4129-9683-9e641f22f21d",
                        "Name": "BackupRecovery",
                        "Status": "UNSTARTED",
                        "Judging": 0,
                        "Region": "cn-shanghai-2",
                        "Created": "Oct 15, 2018 7:28:35 PM",
                        "Updated": "Oct 15, 2018 7:28:35 PM",
                        "Deleted": 0,
                        "Progress": 0,
                        "AccountId": "73403574"
                    },
                    {
                        "Id": "73a2b2be-dc8d-4d38-8e3d-ad531601f1c8",
                        "TaskId": "7bd9202b8c75497d",
                        "ConnConfigId": "7cc8fe9f-ca8d-4129-9683-9e641f22f21d",
                        "Name": "SchemaMigration",
                        "Status": "UNSTARTED",
                        "Judging": 0,
                        "Region": "cn-shanghai-2",
                        "Created": "Oct 15, 2018 7:28:35 PM",
                        "Updated": "Oct 15, 2018 7:28:35 PM",
                        "Deleted": 0,
                        "Progress": 0,
                        "AccountId": "73403574"
                    }
                ]
            }
        ]
    },
    "RequestId": "21cdd228-3a3d-40b8-8308-073a612a2a98"
}

OperateTask 操作任务

实现对任务状态的管理,包含:开始,暂停,停止,删除操作。

请求方法

GET

请求参数

英文名称 中文名称 类型 是否必填 备注
Action 调用接口名称 String 取固定值:DescribeTask
Version API版本号 String 取固定值:2018-01-08
TaskId 数据迁移类型 String -
ActionName 任务操作 String 开始:Start 暂停:Pause 停止:Stop 删除:Delete

返回值

若无错误,则无返回值。

请求示例

http://dts.cn-shanghai-2.api.ksyun.com/?Action=OperateTask&Version=2018-01-08&&TaskId=7bd9202b8c75497d&&ActionName=Start

返回示例

{
    "RequestId": "6fc99195-7cd6-45d2-ad38-41967e4a5ff8"
}

金山云,开启您的云计算之旅

立即注册