• 热门
  • 基础
  • 数据库
  • 安全
  • 大数据
  • 人工智能
  • 混合云
  • 开发与运维
  • 企业应用

应用服务

行业引擎

全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

迁移任务管理

最近更新时间:2024-05-08 15:03:19

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

主任务id

String

主任务id

TargetType

目标实例数据库类型

List<String>

范围:Krds Kcs ClusterKcs Kmgo Kpg  Ktidb

TaskType

任务类型

String

默认Transmission,若为数据迁移任务,可不传此参数,其他类型必传。范围:
数据迁移Transmission 数据同步Synchronous 数据订阅Subscription

TaskStatus

任务状态

List<String>

不传默认查询所有状态,范围:UNSTARTED RUNNING RELOADING PAUSED PAUSING STOPED FINISHED ERROR

TaskName

任务名称

String

任务名称

TargetInstanceId

目标库实例id

String

通过目标库实例id筛选符合条件的任务

SourceInstanceId

源库实例id

String

通过源库实例id筛选符合条件的任务 注:控制台不支持此参数,openapi支持

OrderByType

根据任务创建时间排序

String

默认DESC

Marker

当前查询开始行数

Integer

默认:0

MaxRecords

当前页最大行数

Integer

默认:10

SourceType

源端的实例数据库类型

List<String>

范围:Krds Kcs ClusterKcs Kmgo Kpg

返回值

英文名称

中文名称

类型

备注

TaskName

任务名称

String

-

TaskId

任务ID

String

-

TaskStatus

任务状态

String

运行中:RUNNING 运行失败:ERROR 完成:FINISHED 失败:FAILED 暂停:PAUSED 删除:DELETED

TaskType

任务类型

String

-

LatestConsistencyCheckStatus

最后一次一致性检查状态

String

MySQL,Redis支持一致性检查

Created

创建时间

String

-

ConnConfigId

配置ID

String

忽略

SourceType

迁移类型

String

-

SourceHost

源实例地址

String

-

SourcePort

源实例端口

String

-

TargetType

目标端迁移类型

String

-

TargetInstanceId

目标实例ID

String

SubTask

子任务任务类型

String

-

SubTasks

子任务列表

String

-

Marker

下次获取记录开始偏移量

Integer

-

MaxRecords

每页结果中包含的最大条数

Integer

-

TotalCount

记录总数

Integer

-

请求示例

https://dts.{{region}}.api.ksyun.com/?Action=DescribeTask&Version=2018-01-08&TaskId=******

返回示例

{
    "Data": {
        "Tasks": [
            {
                "TaskName": "dts_20240423163305", 
                "TaskId": "******",				 
                "TaskStatus": "RUNNING",		
                "taskType": "Transmission",		
                "LatestConsistencyCheckStatus": "FINISHED",				
                "Created": "Apr 23, 2024 4:33:51 PM",					
                "ConnConfigId": "7784e514-726d-4309-a7ce-17c752a7318e",	
                "SourceType": "ClusterKcs",								
                "SourceHost": "10.102.41.27,10.102.39.239,10.102.89.178",	
                "SourcePort": "6379,6379,6379",							
                "TargetType": "ClusterKcs",								
                "TargetInstanceId": "bba37486-c03e-44e9-926f-572c52ca5afd",	
                "SubTask": "FullSync",										
                "Message": "{\"ErrType\":\"TargetError\",\"ErrMessage\":\"writer thread[0] get connection failed, dial tcp 10.102.38.165:6379: connect: connection timed out\"}",
                "StartTime": "Apr 23, 2024 4:46:43 PM",						
                "EndTime": "Apr 25, 2024 10:06:29 AM",						
                "MeasureValue": 0.0,										
                "ServiceBeginTime": "Apr 23, 2024 4:33:51 PM",				
                "SubTasks": [											
                    {
                        "Id": "21c2ddb3-2c6b-4942-9f58-90284e309f89",
                        "TaskId": "cedd9a06-06e3-4159-8b76-11957d97eab4",
                        "ConnConfigId": "7784e514-726d-4309-a7ce-17c752a7318e",
                        "Name": "FullSync",
                        "ActionOn": "MonitorSubTaskAction",
                        "Status": "ERROR",
                        "agentStage": "NORMAL",
                        "Judging": 0,
                        "Message": "{\"ErrType\":\"TargetError\",\"ErrMessage\":\"writer thread[0] get connection failed, dial tcp 10.102.38.165:6379: connect: connection timed out\"}",
                        "Node": "http://10.96.0.85:9102",
                        "Region": "cn-shanghai-2",
                        "Created": "Apr 23, 2024 4:33:51 PM",
                        "Updated": "Apr 25, 2024 10:06:29 AM",
                        "Deleted": 0,
                        "Params": "",
                        "Progress": 0,
                        "Latency": 0,
                        "AccountId": "2000102274",
                        "StartTime": "Apr 23, 2024 4:46:43 PM",
                        "ReloadTimes": 3,
                        "FailureNum": 0,
                        "errSkip": 0
                    }
                ],
                "SubTasksForCheck": [								
                    {
                        "Id": "c6e84b83-1c0e-45af-8e8d-31297fcdeaf4",
                        "TaskId": "cedd9a06-06e3-4159-8b76-11957d97eab4",
                        "ConnConfigId": "7784e514-726d-4309-a7ce-17c752a7318e",
                        "Name": "RedisConsistencyCheck",
                        "ActionOn": "MonitorSubTaskAction",
                        "Status": "FINISHED",
                        "agentStage": "NONE",
                        "Judging": 0,
                        "Message": "{\"message\":\"success\",\"values\":{}}",
                        "Node": "http://10.96.0.85:9102",
                        "Region": "cn-shanghai-2",
                        "Created": "Apr 23, 2024 4:46:46 PM",
                        "Updated": "Apr 23, 2024 4:47:09 PM",
                        "Deleted": 0,
                        "Params": "",
                        "Progress": 100,
                        "Latency": 0,
                        "AccountId": "2000102274",
                        "RelientSubtaskId": "21c2ddb3-2c6b-4942-9f58-90284e309f89",
                        "StartTime": "Apr 23, 2024 4:46:47 PM",
                        "EndTime": "Apr 23, 2024 4:47:09 PM",
                        "ReloadTimes": 0,
                        "FailureNum": 0,
                        "ConsistencyCheckResult": "SUCCESS",
                        "errSkip": 0
                    }
                ]
            }
        ],
        "TotalCount": 1,
        "Marker": 1,
        "MaxRecords": 10
    },
    "RequestId": "128c3388-9a2b-4f0c-a38a-e0d657b660a2"
}

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"
}

纯净模式常规模式

纯净模式

点击可全屏预览文档内容

鼠标选中内容,快速反馈问题

如果在文档使用中出现问题,可选中有问题的部分进行快速反馈,我们将跟进处理。
不再提示
好的,我知道了

聆听反馈