本接口用于数据迁移或数据同步任务列表页面的分页查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SearchKey | string | 否 | 数据迁移或数据同步任务的名称/ID。 | np_4w**** |
Type | string | 否 | 任务的类型,包括 | MIGRATION |
Status | array | 否 | 数据迁移或数据同步任务的状态集合,包括 INIT(未启动), RUNNING(运行中)、SUSPEND(已暂停)、FAILED(失败)、FINISHED(已完成)、RELEASING(释放中)、RELEASED(已释放)、DELETED(已删除)、RUNNING_MODIFYING(修改中)、RUNNING_MERGING(合并中)、RUNNING_ALARMING(告警中)和 UNCONFIGURED(待配置)。 | |
string | 否 | 数据迁移或数据同步任务的状态。 | RUNNING | |
LabelIds | array | 否 | 标签 ID 的集合,最多支持 5 个。 | |
string | 否 | 标签 ID。 | l_dfe**** | |
SourceEndpointTypes | array | 否 | 源端数据源类型的集合。 | |
string | 否 | 源端数据源的类型。 枚举值:
| MYSQL | |
SinkEndpointTypes | array | 否 | 目标端数据源类型的集合。 | |
string | 否 | 目标端数据源的类型。 枚举值:
| MYSQL | |
VisibleSubProject | boolean | 否 | 是否展示子任务。 | false |
SortField | string | 否 | 排序字段,包括 | gmtCreate |
Order | string | 否 | 排列顺序,包括 | descend |
NeedRelatedInfo | boolean | 否 | 是否需要查询任务关联信息(数据源连接信息、传输实例信息、任务步骤信息等),默认值为 true。 | true |
PageNumber | integer | 否 | 页序号,分页查询时生效。 | 1 |
PageSize | integer | 否 | 页大小,分页查询时生效。 | 10 |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | 返回结果。 | ||
Success | boolean | 是否调用成功。 | true |
ErrorDetail | object | 错误详情。 | |
Code | string | 错误码(新)。 | CM-RESOAT1111 |
Level | string | 错误等级,包括 FATAL、ERROR、WARNING 和 CRITICAL。 | ERROR |
Message | string | 错误描述(新)。 | A system error occurred. |
ExtraContext | object | 用于填充 Message 中的占位符。 | |
any | 用于填充 Message 中的占位符。 | null | |
MessageMcmsKey | string | 错误信息的 Key。 | null |
MessageMcmsContext | object | 用于填充 MessageMcmsKey 中的占位符。 | |
string | 用于填充 MessageMcmsKey 中的占位符。 | null | |
Reason | string | 错误原因。 | null |
ReasonMcmsKey | string | 错误原因的 Key。 | null |
ReasonMcmsContext | object | 错误原因的上下文。 | |
string | 错误原因的上下文。 | null | |
Proposal | string | 建议(新)。 | Contact the administrator. |
ProposalMcmsKey | string | 建议内容的 Key。 | null |
ProposalMcmsContext | object | 建议内容的上下文。 | |
string | 建议内容的上下文。 | null | |
UpstreamErrorDetail | any | 上游错误详情,用于处理 HTTP 请求。 | null |
Code | string | 错误码(旧)。 | INNER_ERROR |
Message | string | 错误描述(旧)。 | A system error occurred. |
Advice | string | 建议(旧)。 | Contact the administrator. |
RequestId | string | 请求 ID。 | EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C |
PageNumber | integer | 页序号,分页查询时生效。 | 1 |
PageSize | integer | 页大小,分页查询时生效。 | 10 |
TotalCount | long | 总数,分页查询时生效。 | 4 |
Cost | string | 请求耗时,单位为秒。 | 1 |
Data | array<object> | 任务列表的相关信息。 | |
Data | object | ||
WorkerGradeId | string | 传输实例的 ID。 | g_i4wa7*** |
WorkerGradeInfo | object | 传输实例的详情。 | |
Id | string | 传输实例的 ID。 | g_i4wa7*** |
Name | string | 传输实例的别名。 | i5fu*** |
Grade | string | 传输实例的规格。 | OMS_G2_MIGRATION_LARGE |
Spec | string | 传输实例的规格大小。 | LARGE |
SpecName | string | 传输实例规格大小的名称。 | LARGE |
SourceType | string | 源端数据源的类型。 | OB_MYSQL |
SourceRegion | string | 源端数据源所在的地域。 | ap-southeast-1 |
DestType | string | 目标端数据源的类型。 | OB_MYSQL |
DestRegion | string | 目标端数据源所在的地域。 | ap-southeast-1 |
ChargeType | string | 数据迁移或数据同步任务的计费类型。 | POSTPAY |
AutoRenewal | boolean | 是否开启自动续费。 | false |
Expired | boolean | 是否已到期。 | false |
EndTime | string | 到期时间。支持 UTC 时间,格式为 YYYY-MM-DDThh:mm:ss。 | 2024-01-28T15:07:44 |
GmtCreate | string | 创建时间。支持 UTC 时间,格式为 YYYY-MM-DDThh:mm:ss。 | 2024-01-28T14:07:44 |
Id | string | 数据迁移或数据同步任务的 ID。 | np_4w**** |
Type | string | 任务的类型,包括 | MIGRATION |
Name | string | 数据迁移或数据同步任务的名称。 | project_name |
Labels | array<object> | 标签的集合。 | |
Label | object | ||
Id | string | 标签 ID。 | l_dfe**** |
Name | string | 标签的名称。 | label_name |
Creator | string | 创建人(仅管理员视角下返回)。 | admin |
Type | integer | 标签的类型。1 表示用户标签,0 表示运维标签。 | 1 |
Count | integer | 使用该标签的任务数量。 | 2 |
Owner | string | 任务 Owner。 | admin |
Importance | string | 任务的告警等级,包括 | MEDIUM |
Status | string | 数据迁移或数据同步任务的状态,包括 INIT(未启动)、RUNNING(运行中)、SUSPEND(已暂停)、FAILED(失败)、FINISHED(已完成)、RELEASING(释放中)、RELEASED(已释放)、DELETED(已删除)、RUNNING_MODIFYING(修改中)和 RUNNING_MERGING(合并中)。 | RUNNING |
GmtCreate | string | 任务的创建时间,以 UTC + 0 时区的时间格式展示。 | 2023-07-13T06:26:15 |
GmtModified | string | 任务的更新时间,以 UTC + 0 时区的时间格式展示。 | 2023-07-13T07:01:27 |
GmtStart | string | 任务的开始运行时间。 | 2023-07-13T07:02:27 |
GmtFinish | string | 任务的结束运行时间。 | 2023-07-13T08:01:27 |
DestConnId | string | 任务的目标端连接信息 ID。 | null |
IsMerging | boolean | 任务是否处于合并中。 | false |
IsModifying | boolean | 任务是否处于修改中。 | false |
IsSubProject | boolean | 是否为子任务。 | false |
SourceEndpointType | string | 源端数据源的类型。 枚举值:
| MYSQL |
SinkEndpointType | string | 目标端数据源的类型。 枚举值:
| OB_MYSQL |
TransferMapping | object | 该参数已废弃,建议您调用 | |
Mode | string | 传输对象映射模式,包括 | SPECIFIC |
CommonTransferConfig | object | 该参数已废弃,建议您调用 | |
TableCategory | string | 支持的表类型。包括 ALL(所有表)、WITH_UNIQUE_ROW_ID(有唯一行标识的表)和 WITHOUT_UNIQUE_ROW_ID(无唯一行标识的表),默认值为 ALL。 | ALL |
ActiveActive | boolean | 是否为容灾双活场景。 | false |
MqSerializerType | string | 投递至消息队列时,数据 JSON 序列化类型。包括 DEFAULT、CANAL、DATAWORKS_V2、SHAREPLEX、DEFAULT_WITH_SCHEMA、DEBEZIUM、DEBEZIUMFLATTEN 和 DEBEZIUMSMT。 | DEFAULT |
MqPartitionMode | string | 投递至消息队列时,分区路由方式。包括 ONE(指定分区投递)、HASH(根据主键/分片列值进行 HASH 分区投递、TABLE(根据库表名进行 HASH 分区投递)。 | ONE |
MqPartition | integer | 当 partitionMode 为 ONE 时,该参数表示投递的分区在当前 Topic 下的位置。 | 0 |
DatahubTopicType | string | 投递至消息队列 DataHub 时,指定 Topic 的类型。 枚举值:
| TUPLE |
RocketMqProducerGroup | string | 指定生产组名(目标端为 ROCKETMQ 时生效),默认值为 OMS。 | OMS |
RocketMqMsgTags | string | 设置消息 tag(目标端为 ROCKETMQ 时生效),默认 default->default_tag。 | default_tag |
RocketMqEnableMsgTrace | boolean | 是否开启消息追踪(目标端为 ROCKETMQ 时生效)。 | false |
RocketMqSendMsgTimeout | long | 设置消息投递超时时间(目标端为 ROCKETMQ 时生效)。 | null |
DataWorksBusinessName | string | 业务系统标识(可选)。 | null |
EnableStructTransfer | boolean | 是否开启结构传输。 | true |
StructTransferConfig | object | 该参数已废弃,建议您调用 | |
ByteCharConvertStrategy | string | byte/char 转换方案,默认值为 枚举值:
| DO_NOTHING_IF_BYTE_USED |
DeferIndexCreation | boolean | 是否允许索引后置。 | false |
EnableFullTransfer | boolean | 是否开启全量传输。 | true |
EnableFullVerify | boolean | 是否开启全量校验。 | true |
FullTransferConfig | object | 该参数已废弃,建议您调用 | |
NonePkUkTruncateDstTable | boolean | 处理源端无唯一索引表的全量迁移时,是否清空目标表。 | false |
AllowDestTableNotEmpty | boolean | 目标端表对象存在记录时处理策略,包括 忽略 和 停止迁移。
| false |
FullTransferSpeedMode | string | 全量迁移并发速度,包括 STEADY、NORMAL 和 FAST。 | NORMAL |
FullVerifySpeedMode | string | 全量校验并发速度,包括 STEADY、NORMAL 和 FAST。 | NORMAL |
EnableIncrTransfer | boolean | 是否开启增量传输。 | true |
EnableIncrVerify | boolean | 是否开启增量校验。 | true |
EnableReverseIncrTransfer | boolean | 是否开启反向增量传输。 | true |
IncrTransferConfig | object | 该参数已废弃,建议您调用 | |
StartTimestamp | long | 增量同步起始位点,秒级时间戳。仅启用增量同步但未启用全量传输时,支持设置该参数。 | 1681004708 |
RecordTypeWhiteList | array | 有增量同步阶段时,同步的增量数据类型。 | |
RecordTypeWhiteList | string | 有增量同步阶段时,同步的增量数据类型。 枚举值:
| INSERT |
StoreLogKeptHour | integer | 有增量同步阶段且增量日志拉取组件为 Store 时,日志的保存时间。单位为小时,默认 7 天,最长支持 365 天。 | 24 |
EnableSequencingWithinTxn | boolean | 有增量同步阶段且增量日志拉取组件为 Store 时,是否开启事务内序号编排。 | true |
IncrSyncConcurrency | integer | 增量同步的线程数,默认值为 64。 | 64 |
EnableIncrSyncStatistics | boolean | 是否开启增量记录(DML、DDL)统计。 | true |
SourceConnectInfo | object | 源端节点的连接信息。 | |
Id | string | 连接信息的 ID。 | c_4w3aq**** |
EndpointName | string | 终端节点的名称。 | ration12****0obmysql4116892*** |
EndpointId | string | 终端节点的 ID。 | e_4w3al*** |
EndpointSide | string | 终端节点的类型,包括 | source |
DbEngine | string | 终端节点的数据库引擎。 | OB_MYSQL_PUBLIC |
ConnectionInfo | string | 终端节点的连接信息。 | null |
Username | string | 连接用户名。 | oms931mys** |
Version | string | 数据库的版本。 | 5.7.27 |
Timezone | string | 数据库的时区。 | UTC |
Charset | string | 字符编码。 | utf8mb4 |
NlsLengthSemantics | string | nlsLengthSemantics 属性,仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。 | null |
OperatingSystem | string | 操作系统(OceanBase 数据库无该参数)。 | Linux |
Region | string | 地域。 | cn-hangzhou |
OcpName | string | OCP 的名称。 | null |
ConnExtraAttributes | any | 连接额外属性。具体返回字段请参见《附录》模块的内容。 | null |
Owner | string | Owner。 | admin |
ResourceOwner | string | 资源所有者的 UID。 | 1325847*** |
Host | string | IP 地址。 | xxx.xxx.xxx.1 |
Port | integer | 端口。 | 2883 |
SinkConnectInfo | object | 目的端节点的连接信息。 | |
Id | string | 连接信息的 ID。 | c_4w3akx*** |
EndpointName | string | 终端节点的名称。 | ation129***9apimysql5616**** |
EndpointId | string | 终端节点的 ID。 | e_4w3aic*** |
EndpointSide | string | 终端节点的类型,包括 | sink |
DbEngine | string | 终端节点的数据库引擎。 | MYSQL_PUBLIC |
ConnectionInfo | string | 终端节点的连接信息。 | null |
Username | string | 连接用户名。 | oms**obmys** |
Version | string | 数据库的版本。 | 2.2.77 |
Timezone | string | 数据库的时区。 | +08:00 |
Charset | string | 字符编码。 | utf8mb4 |
NlsLengthSemantics | string | nlsLengthSemantics 属性,仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。 | null |
OperatingSystem | string | 操作系统(OceanBase 数据库无该参数)。 | Linux |
Region | string | 地域。 | cn-hangzhou |
OcpName | string | OCP 名称。 | null |
ConnExtraAttributes | any | 连接额外属性。具体返回字段请参见《附录》模块的内容。 | null |
Owner | string | Owner。 | admin |
ResourceOwner | string | 资源所有者的 UID。 | 1325847*** |
Host | string | IP 地址。 | xxx.xxx.xxx.1 |
Port | integer | 端口。 | 2883 |
Steps | array<object> | 步骤列表。 | |
Step | object | ||
Order | integer | 步骤的运行顺序。 | 1 |
Name | string | 步骤的名称。 | TRANSFER_PRECHECK |
Description | string | 步骤的描述(预检查/结构迁移/结构同步/全量迁移/全量同步/全量校验/索引迁移/增量日志拉取/增量同步/增量校验/正向切换)。 | 预检查 |
Status | string | 步骤的运行状态,包括 INIT(初始化)、RUNNING(运行中)、FAILED(失败)、 FINISHED(已完成)、 SUSPEND(已暂停)、MONITORING(持续监控状态,用于增量同步和增量校验的持续监控态)。 | RUNNING |
ExtraInfo | object | 补充信息(JSON)。 | |
ErrorDetails | array<object> | 错误详情。 | |
ErrorDetail | object | ||
Code | string | 错误码(新)。 | CM-RESOAT1111 |
Level | string | 错误等级,包括 FATAL、ERROR、WARNING 和 CRITICAL。 | ERROR |
Message | string | 错误描述(新)。 | A system error occurred. |
ExtraContext | object | 用于填充 Message 中的占位符。 | |
any | 用于填充 Message 中的占位符。 | null | |
MessageMcmsKey | string | 错误信息的 Key。 | null |
MessageMcmsContext | object | 用于填充 MessageMcmsKey 中的占位符。 | |
string | 用于填充 MessageMcmsKey 中的占位符。 | null | |
Reason | string | 错误原因。 | null |
ReasonMcmsKey | string | 错误原因的 Key。 | null |
ReasonMcmsContext | object | 错误原因的上下文。 | |
string | 错误原因的上下文。 | null | |
Proposal | string | 建议(新)。 | Contact the administrator. |
ProposalMcmsKey | string | 建议内容的 Key。 | null |
ProposalMcmsContext | object | 建议内容的上下文。 | |
string | 建议内容的上下文。 | null | |
UpstreamErrorDetail | any | 上游错误详情,用于处理 HTTP 请求。 | null |
ErrorCode | string | 错误码。 | INNER_ERROR |
ErrorMsg | string | 错误描述。 | A system error occurred. |
ErrorParam | object | 错误相关的参数。 | |
string | 错误相关的参数。 | null | |
FailedTime | string | 错误时间。 | null |
StartTime | string | 开始时间,以 UTC + 0 时区的时间格式展示。 | 2020-05-22T17:04:18 |
FinishTime | string | 结束时间,以 UTC + 0 时区的时间格式展示。 | 2020-05-22T17:05:18 |
Progress | integer | 步骤的运行进度。 | 100 |
StepInfo | object | 各步骤的运行详情。 | null |
ExtraInfo | object | 该参数已废弃,建议您调用 | |
RunningStep | string | 处于 RUNNING 状态的步骤。 | TRANSFER_PRECHECK |
RunningProgress | integer | 处于 RUNNING 状态的步骤的运行进度。 | 90 |
MonitoringIncr | boolean | 是否开始监控增量。 | true |
Subtopics | array | 任务关联 Store 的 Subtopics 列表。 | |
Subtopic | string | 任务关联 Store 的 Subtopic。 | null |
ReverseSubtopics | array | 任务关联反向 Store 的 Subtopics 列表。 | |
ReverseSubtopic | string | 任务关联反向 Store 的 Subtopic。 | null |
LogServiceStartCheckpoint | long | 起始位点。 | 1689214358 |
SourceStoreKeptHour | integer | 日志保存时间。 | 24 |
SyncDelay | long | 增量同步延迟时间。 | null |
SyncDelaySampleTimestamp | long | 同步延迟的采集时间戳,秒级别。 | 1689214358 |
AccessObSource | boolean | 是否能够直连源端 OceanBase 数据库。 | true |
OverwriteConfig | boolean | 是否允许完全覆盖更新配置。 | true |
IgnoreUnsupportDdl | boolean | 是否忽略不支持的 DDL。 | true |
SubDbs | object | 记录不同下游消费方的表配置,用于同步任务复用时的配置合并。 | |
array<object> | 记录不同下游消费方的表配置,用于同步任务复用时的配置合并。 | ||
Item | object | ||
ClusterName | string | 集群的名称。 | cluster_name |
TenantName | string | 租户的名称。 | tenant_name |
DatabaseId | string | 数据库的 ID。目前仅逻辑库才会具有 ID,可能存在在一个 Endpoint 中库名相同,但是 ID 不同。表示的是不同的 ID 情况。 | null |
DatabaseName | string | 数据库的名称。 | db_name |
MappingDatabaseName | string | 数据库的映射名称。 | mapped_db |
SourceClientId | string | 用于标识处理该 DatabaseName 的 Source Client。 | null |
Tables | array<object> | 待传输表的列表。 | |
Table | object | ||
TableId | string | 逻辑表的 ID。 | null |
Database | string | 数据库的名称。 | db_name |
TableName | string | 表的名称。 | table_name |
MappingTableName | string | 表的映射名称。 | mapped_name |
Instance | string | 传输实例的 ID。 | g_i4kat*** |
Columns | array<object> | 待传输列的列表。 | |
Column | object | ||
ColumnName | string | 列的名称。 | column_name |
Position | integer | 字段的位置。 | null |
ColumnType | string | 列的类型。 | null |
RecordFieldType | string | 列类型的引申。 | null |
RawColumnType | string | 数据库记录的列类型的原始字符串。 | null |
ColumnKey | string | 索引的类型。 | null |
Nullable | boolean | 是否可以为空。 | false |
DefaultValue | string | 默认值。 | null |
DataLength | long | 列的长度。 | null |
DataPrecision | integer | 列的精度。 | 64 |
DataScale | integer | 小数点。 | null |
Encoding | string | 列的字符编码。 | utf8 |
ColumnComment | string | 列的注释。 | comments |
IsGenerateField | boolean | 是否为隐藏列。 | false |
SubConds | object | 同步 DataWorks 场景,记录不同下游消费方的表配置,用于同步任务复用时的配置合并。 | |
array<object> | 同步 DataWorks 场景,记录不同下游消费方的表配置,用于同步任务复用时的配置合并。 | ||
Item | object | ||
TenantName | string | 源端租户的名称。 | tenant_name |
Database | string | 源端数据库的名称。 | db_name |
DestDatabase | string | 目标端数据库的名称。 | dest_db |
TableName | string | 源端表的名称。 | table_name |
DestName | string | 目标端表的名称。 | dest_name |
WhereClause | string | 标准的 SQL 语句中的 | id>1 |
FilterColumns | array | 过滤列集合。 | |
FilterColumn | string | 过滤列。 | col |
ShardColumns | array | 分片列集合。 | |
ShardColumn | string | 分片列。 | col |
LogicTableId | string | 针对逻辑表下,逻辑表的 ID。 | null |
SourceEndpointId | string | 针对物理表下传递 endpointId。 | null |
SourceClientId | string | Connector Client 的 ID。 | null |
SubIds | object | 配置对象的 ID 列表。 | |
string | 配置对象的 ID。 | null | |
MaxConnectorCount | integer | Connector 的最大数量,-1 表示不限制。 | -1 |
StoreIncr | boolean | 是否保存增量。 | true |
IncrSyncTimestamp | long | 增量同步的当前位点,单位为秒级时间戳。 | 1689244596 |
AlarmStats | object | 告警统计信息。 | |