全部产品
数据传输服务DTS

查看同步作业列表

更新时间:2017-08-18 13:59:57   分享:   

描述

通过这个接口可以查询调用账号下所有同步作业的状态及同步详情。

请求参数

参数名称 数据类型 是否必须 参数说明
Action String 系统默认参数,这个接口的接口定义,取值为:DescribeSynchronizationJobs
PageSize Integer 每页记录数,取值:30/50/100默认值:30
PageNum Integer 页码,大于0,且不超过Integer的最大值,默认值:1

返回参数

参数名称 数据类型 参数说明
PageNumber Integer 页码
TotalRecordCount Integer 总实例数
PageRecordCount Integer 本页同步实例数
SynchronizationInstances List 同步作业状态,其中 SynchronizationInstance的定义参考SynchronizationInstance参数定义

SynchronizationInstance 参数定义

参数名称 数据类型 参数说明
SynchronizationJobId String 同步实例ID
SynchronizationJobName String 同步实例名称
SynchronizationJobClass String 同步实例规格
PayType String 付费类型
ExpireTime String 到期时间,格式为:YYYY-MM-DDT hh:mm:ssZ,例如:2011-06-09T 12:11:11Z
SourceEndpoint SourceEndpoint 同步实例的源实例连接信息
DestinationEndpoint DestinationEndpoint 同步实例的目标实例连接信息
SynchronizationObjects List 同步对象
StructureInitialization String 是否进行结构初始化
DataInitialization String 是否进行全量数据初始化
Status String 同步实例状态,取值包括:
NotStarted:未启动
Prechecking: 预检查中
PrecheckFailed: 预检查失败
Initializating : 同步初始化
InitializeFailed: 同步初始化失败
Synchronizing : 同步中
Failed: 同步失败
Suspending: 暂停
Modifying: 同步中(同步对象变更中)
Finished: 完成
ErrorMessage String 同步失败原因
PrecheckStatus PrecheckStatus 预检查状态,其中 PrecheckStatus的定义参考 PrecheckStatus 参数定义
StructureInitializationStatus StructureInitializationStatus 结构初始化详情,其中 StructureInitializationStatus的定义参考StructureInitializationStatus参数定义
DataInitializationStatus DataInitializationStatus 全量数据初始化详情,其中 DataInitializationStatus的定义参考DataInitializationStatus参数定义
DataSynchronizationStatus DataSynchronizationStatus 增量初始化详情,其中 DataSynchronizationStatus的定义参考DataSynchronizationStatus参数定义
Delay String 同步延迟,单位为秒
Performance String 同步概况,其中 Performance的定义参考Performance参数定义

PrecheckStatus参数定义

参数名称 数据类型 参数说明
Status String 预检查状态
Percent String 预检查进度,单位为百分比
Detail List 各个预检查项的检查情况
CheckItem的定义详见CheckItem的参数定义
CheckItem的参数定义
参数名称 数据类型 参数说明
ItemName String 检查项名称
CheckStatus String 检查状态,取值包括
NotStarted : 未启动
Checking : 检查中
Failed : 检查失败
Finished : 检查成功
ErrorMessage String 失败原因
RepairMethod String 修复方法

StructureInitializationStatus参数定义

参数名称 数据类型 参数说明
Status String 迁移状态,取值包括:
NotStarted:未启动
Migrating : 迁移中
Failed :迁移失败
Finished: 迁移完成
ErrorMessage String 迁移失败原因
Percent String 迁移进度,单位为百分比
Progress String 已经完成迁移的表数量

DataInitializationStatus参数定义

参数名称 数据类型 参数说明
Status String 迁移状态,取值包括:
NotStarted:未启动
Migrating : 迁移中
Failed :迁移失败
Finished: 迁移完成
ErrorMessage String 迁移失败原因
Percent String 迁移进度,单位为百分比
Progress String 已经完成迁移的表数量

DataSynchronizationStatus参数定义

参数名称 数据类型 参数说明
Status String 迁移状态,取值包括:
NotStarted:未启动
Migrating : 迁移中
Failed :迁移失败
Finished: 迁移完成
ErrorMessage String 迁移失败原因
Percent String 迁移进度,单位为百分比
Delay String 迁移延迟,单位为秒

Performance 参数定义

参数名称 数据类型 参数说明
TPS String 每秒同步的记录数
Flow String 每秒同步的流量,单位为:MB/s

示例

下面简单演示通过JAVA SDK 查询同步任务列表的示例:

  1. public void descSyncJobs(DefaultAcsClient client) {
  2. DescribeSynchronizationJobsRequest request = new DescribeSynchronizationJobsRequest();
  3. DescribeSynchronizationJobsResponse response = new DescribeSynchronizationJobsResponse();
  4. try {
  5. response = client.getAcsResponse(request);
  6. System.out.println("Describe all Synchronization Jobs Succeed!");
  7. List<SynchronizationInstance> syncInstances=response.getSynchronizationInstances();
  8. System.out.println("Total num of Synchronization Jobs:"+syncInstances.size());
  9. for (SynchronizationInstance syncInstance : syncInstances) {
  10. System.out.println("SyncJobId:"+syncInstance.getSynchronizationJobId()
  11. +"; SyncJobName:"+syncInstance.getSynchronizationJobName()
  12. +"; PayType:"+syncInstance.getPayType()
  13. +"; InstanceClass:"+syncInstance.getSynchronizationJobClass()
  14. +"; StrucInit:"+syncInstance.getStructureInitialization()
  15. +"; DataInit:"+syncInstance.getDataInitialization()
  16. +"; Status:"+syncInstance.getStatus()
  17. +"; ErrMSG:"+syncInstance.getErrorMessage()
  18. +"; Delay:"+syncInstance.getDelay());
  19. System.out.println("SourceEndpointInstanceType:"+syncInstance.getSourceEndpoint().getInstanceType()
  20. +"SourceEnpointInstanceId:"+syncInstance.getSourceEndpoint().getInstanceId());
  21. System.out.println("DestEndpointInstanceType:"+syncInstance.getDestinationEndpoint().getInstanceType()
  22. +"DestEndpointInstanceId:"+syncInstance.getDestinationEndpoint().getInstanceId());
  23. // Get Precheck Status
  24. try {
  25. com.aliyuncs.dts.model.v20160801.DescribeSynchronizationJobsResponse.SynchronizationInstance.PrecheckStatus precheckStatus = syncInstance.getPrecheckStatus();
  26. System.out.println("Get Precheck Status for Sync Job Succeed");
  27. System.out.println("Precheck Status:"+syncInstance.getPrecheckStatus().getStatus()
  28. +"Precheck Percent:"+syncInstance.getPrecheckStatus().getPercent());
  29. for (int j = 0; j < syncInstance.getPrecheckStatus().getDetail().size(); j++) {
  30. System.out.println("CheckItem:"+syncInstance.getPrecheckStatus().getDetail().get(j).getCheckStatus()
  31. +"; ErrorMSG:"+syncInstance.getPrecheckStatus().getDetail().get(j).getErrorMessage()
  32. +"; RepairMethod:"+syncInstance.getPrecheckStatus().getDetail().get(j).getRepairMethod());
  33. }
  34. } catch (Exception e) {
  35. // TODO: handle exception
  36. System.out.println("Get Precheck Status for Sync Job Failed");
  37. }
  38. // Get Structure Initialization Status
  39. try {
  40. System.out.println("Get Structure Initialization Status Succeed!");
  41. System.out.println("Structure Init Status:"+syncInstance.getStructureInitializationStatus().getStatus()
  42. +"; Percent:"+syncInstance.getStructureInitializationStatus().getPercent()
  43. +"; Progress:"+syncInstance.getStructureInitializationStatus().getProgress()
  44. +"; ErrMSG:"+syncInstance.getStructureInitializationStatus().getErrorMessage());
  45. } catch (Exception e) {
  46. // TODO: handle exception
  47. System.out.println("Get Structure Initialization Status Failed!");
  48. }
  49. // Get Data Initialization Status
  50. try {
  51. System.out.println("Get Data Init Status Succeed!");
  52. System.out.println("Data Init Status:"+syncInstance.getDataInitializationStatus().getStatus()
  53. +"; Percent:"+syncInstance.getDataInitializationStatus().getPercent()
  54. +"; Progress:"+syncInstance.getDataInitializationStatus().getProgress()
  55. +"; ErrMSG:"+syncInstance.getDataInitializationStatus().getErrorMessage());
  56. } catch (Exception e) {
  57. // TODO: handle exception
  58. System.out.println("Get Data Init Status Failed!");
  59. System.out.println(e.toString());
  60. }
  61. //Get Data Synchronization Status
  62. try {
  63. System.out.println("Get Data Synchronization Status Succeed!");
  64. System.out.println("Data Sync Status:"+syncInstance.getDataSynchronizationStatus().getStatus()
  65. +"; Percent:"+syncInstance.getDataSynchronizationStatus().getPercent()
  66. +"; Delay:"+syncInstance.getDataSynchronizationStatus().getDelay()
  67. +"; ErrMSG:"+syncInstance.getDataSynchronizationStatus().getErrorMessage());
  68. } catch (Exception e) {
  69. // TODO: handle exception
  70. System.out.println("Get Data Sync Status Failed!");
  71. System.out.println(e.toString());
  72. }
  73. }
  74. } catch (Exception e) {
  75. // TODO: handle exception
  76. System.out.println("Desc all Sync Jobs Failed!");
  77. System.out.println(e.toString());
  78. }
  79. }
本文导读目录
本文导读目录
以上内容是否对您有帮助?