文档

ListProjects - 分页查询项目列表

更新时间:

本接口用于数据迁移或数据同步项目列表页面的分页查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
SearchKeystring

数据迁移或数据同步项目的名称/ID。

np_4w****
Typestring

项目的类型,包括 MIGRATION(表示数据迁移项目)和 SYNC(表示数据同步项目)。

MIGRATION
Statusarray

数据迁移或数据同步项目的状态集合,包括 INIT(未启动), RUNNING(运行中)、SUSPEND(已暂停)、FAILED(失败)、FINISHED(已完成)、RELEASING(释放中)、RELEASED(已释放)、DELETED(已删除)、RUNNING_MODIFYING(修改中)、RUNNING_MERGING(合并中)和 RUNNING_ALARMING(告警中)。

string

数据迁移或数据同步项目的状态。

RUNNING
LabelIdsarray

标签 ID 的集合,最多支持 5 个。

string

标签 ID。

l_dfe****
SourceEndpointTypesarray

源端数据源类型的集合。

string

源端数据源的类型。

枚举值:
  • POLARDB_X_1POLARDB_X_1
  • MYSQLMYSQL
  • TIDBTIDB
  • OB_ORACLEOB_ORACLE
  • OB_MYSQLOB_MYSQL
  • ORACLEORACLE
  • POLARDB_X_2POLARDB_X_2
MYSQL
SinkEndpointTypesarray

目标端数据源类型的集合。

string

目标端数据源的类型。

枚举值:
  • MYSQLMYSQL
  • OB_ORACLEOB_ORACLE
  • KAFKAKAFKA
  • ROCKETMQROCKETMQ
  • DATAHUBDATAHUB
  • OB_MYSQLOB_MYSQL
  • ORACLEORACLE
  • ADBADB
MYSQL
VisibleSubProjectboolean

是否展示子项目。

false
SortFieldstring

排序字段,包括 gmtCreategmtModified,默认值为 gmtCreate

gmtCreate
Orderstring

排列顺序,包括 asc(升序)和 descend(降序)。默认值为 descend

descend
NeedRelatedInfoboolean

是否需要查询项目关联信息(数据源连接信息、传输实例信息、项目步骤信息等),默认值为 true。

true
PageNumberinteger

页序号,分页查询时生效。

1
PageSizeinteger

页大小,分页查询时生效。

10

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

是否调用成功。

true
ErrorDetailobject

错误详情。

Codestring

错误码(新)。

CM-RESOAT1111
Levelstring

包括 FATAL、ERROR、WARNING 和 CRITICAL。

ERROR
Messagestring

错误描述(新)。

A system error occurred.
ExtraContextobject

用于填充 Message 中的占位符。

any

用于填充 Message 中的占位符。

null
MessageMcmsKeystring

错误信息的 Key。

null
MessageMcmsContextobject

用于填充 MessageMcmsKey 中的占位符。

string

用于填充 MessageMcmsKey 中的占位符。

null
Reasonstring

错误原因。

null
ReasonMcmsKeystring

错误原因的 Key。

null
ReasonMcmsContextobject

错误原因的上下文。

string

错误原因的上下文。

null
Proposalstring

建议(新)。

Contact the administrator.
ProposalMcmsKeystring

建议内容的 Key。

null
ProposalMcmsContextobject

建议内容的上下文。

string

建议内容的上下文。

null
UpstreamErrorDetailany

上游错误详情,用于处理 HTTP 请求。

null
Codestring

错误码(旧)。

INNER_ERROR
Messagestring

错误描述(旧)。

A system error occurred.
Advicestring

建议(旧)。

Contact the administrator.
RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumberinteger

页序号,分页查询时生效。

1
PageSizeinteger

页大小,分页查询时生效。

10
TotalCountlong

总数,分页查询时生效。

4
Coststring

请求耗时,单位为秒。

1
Dataarray<object>

项目列表的相关信息。

object
WorkerGradeIdstring

传输实例的 ID。

g_i4wa7***
WorkerGradeInfoobject

传输实例的详情。

Idstring

传输实例的 ID。

g_i4wa7***
Namestring

传输实例的别名。

i5fu***
Gradestring

传输实例的规格。

OMS_G2_MIGRATION_LARGE
Specstring

传输实例的规格大小。

LARGE
SpecNamestring

传输实例规格大小的名称。

LARGE
SourceTypestring

源端数据源的类型。

OB_MYSQL
SourceRegionstring

源端数据源所在的地域。

ap-southeast-1
DestTypestring

目标端数据源的类型。

OB_MYSQL
DestRegionstring

目标端数据源所在的地域。

ap-southeast-1
ChargeTypestring

数据迁移或数据同步项目的计费类型。

POSTPAY
AutoRenewalboolean

是否开启自动续费。

false
Expiredboolean

是否已到期。

false
EndTimestring

到期时间。支持 UTC 时间,格式为 YYYY-MM-DDThh:mm:ss。

2024-01-28T15:07:44
GmtCreatestring

创建时间。支持 UTC 时间,格式为 YYYY-MM-DDThh:mm:ss。

2024-01-28T14:07:44
Idstring

数据迁移或数据同步项目的 ID。

np_4w****
Typestring

项目的类型,包括 MIGRATION(表示数据迁移项目)和 SYNC(表示数据同步项目)。

MIGRATION
Namestring

数据迁移或数据同步项目的名称。

project_name
Labelsarray<object>

标签的集合。

object
Idstring

标签 ID。

l_dfe****
Namestring

标签的名称。

label_name
Creatorstring

创建人(仅管理员视角下返回)。

admin
Typeinteger

标签的类型。1 表示用户标签,0 表示运维标签。

1
Countinteger

使用该标签的项目数量。

2
Ownerstring

项目 Owner。

admin
Importancestring

项目的告警等级,包括 HIGH(高保护状态)、MEDIUM(中保护状态)、LOW(低保护状态)和 IGNORE(无保护状态)。

MEDIUM
Statusstring

数据迁移或数据同步项目的状态,包括 INIT(未启动)、RUNNING(运行中)、SUSPEND(已暂停)、FAILED(失败)、FINISHED(已完成)、RELEASING(释放中)、RELEASED(已释放)、DELETED(已删除)、RUNNING_MODIFYING(修改中)和 RUNNING_MERGING(合并中)。

RUNNING
GmtCreatestring

项目的创建时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T06:26:15
GmtModifiedstring

项目的更新时间,以 UTC + 0 时区的时间格式展示。

2023-07-13T07:01:27
GmtStartstring

项目的开始运行时间。

2023-07-13T07:02:27
GmtFinishstring

项目的结束运行时间。

2023-07-13T08:01:27
DestConnIdstring

项目的目标端连接信息 ID。

null
IsMergingboolean

项目是否处于合并中。

false
IsModifyingboolean

项目是否处于修改中。

false
IsSubProjectboolean

是否为子项目。

false
SourceEndpointTypestring

源端数据源的类型。

枚举值:
  • POLARDB_X_1POLARDB_X_1
  • MYSQLMYSQL
  • TIDBTIDB
  • OB_ORACLEOB_ORACLE
  • OB_MYSQLOB_MYSQL
  • ORACLEORACLE
  • POLARDB_X_2POLARDB_X_2
MYSQL
SinkEndpointTypestring

目标端数据源的类型。

枚举值:
  • MYSQLMYSQL
  • OB_ORACLEOB_ORACLE
  • KAFKAKAFKA
  • ROCKETMQROCKETMQ
  • DATAHUBDATAHUB
  • OB_MYSQLOB_MYSQL
  • ORACLEORACLE
  • ADBADB
OB_MYSQL
TransferMappingobject

该参数已废弃,建议您调用 DescribeProject 接口。

Modestring

传输对象映射模式,包括 SPECIFIC(表示指定对象)和 WILDCARD(表示匹配规则)。

SPECIFIC
CommonTransferConfigobject

通用的传输配置。

TableCategorystring

支持的表类型。包括 ALL(所有表)、WITH_UNIQUE_ROW_ID(有唯一行标识的表)和 WITHOUT_UNIQUE_ROW_ID(无唯一行标识的表),默认值为 ALL。

ALL
ActiveActiveboolean

是否为容灾双活场景。

false
MqSerializerTypestring

投递至消息队列时,数据 JSON 序列化类型。包括 DEFAULT、CANAL、DATAWORKS_V2、SHAREPLEX、DEFAULT_WITH_SCHEMA、DEBEZIUM、DEBEZIUMFLATTEN 和 DEBEZIUMSMT。

DEFAULT
MqPartitionModestring

投递至消息队列时,分区路由方式。包括 ONE(指定分区投递)、HASH(根据主键/分片列值进行 HASH 分区投递、TABLE(根据库表名进行 HASH 分区投递)。

ONE
MqPartitioninteger

当 partitionMode 为 ONE 时,该参数表示投递的分区在当前 Topic 下的位置。

0
DatahubTopicTypestring

投递至消息队列 DataHub 时,指定 Topic 的类型。

枚举值:
  • BLOBBLOB
  • TUPLETUPLE
TUPLE
RocketMqProducerGroupstring

指定生产组名(目标端为 ROCKETMQ 时生效),默认值为 OMS。

OMS
RocketMqMsgTagsstring

设置消息 tag(目标端为 ROCKETMQ 时生效),默认 default->default_tag。

default_tag
RocketMqEnableMsgTraceboolean

是否开启消息追踪(目标端为 ROCKETMQ 时生效)。

false
RocketMqSendMsgTimeoutlong

设置消息投递超时时间(目标端为 ROCKETMQ 时生效)。

null
DataWorksBusinessNamestring

业务系统标识(可选)。

null
EnableStructTransferboolean

是否开启结构传输。

true
StructTransferConfigobject

结构传输的配置。

ByteCharConvertStrategystring

byte/char 转换方案,默认值为 DO_NOTHING_IF_BYTE_USED

枚举值:
  • IGNORE_BYTE_IF_BYTE_USEDIGNORE_BYTE_IF_BYTE_USED
  • FORCE_CHAR_IF_BYTE_USEDFORCE_CHAR_IF_BYTE_USED
  • DO_NOTHING_IF_BYTE_USEDDO_NOTHING_IF_BYTE_USED
  • EXPAND_LEN_IF_BYTE_USEDEXPAND_LEN_IF_BYTE_USED
DO_NOTHING_IF_BYTE_USED
DeferIndexCreationboolean

是否允许索引后置。

false
EnableFullTransferboolean

是否开启全量传输。

true
EnableFullVerifyboolean

是否开启全量校验。

true
FullTransferConfigobject

全量传输的配置。

NonePkUkTruncateDstTableboolean

处理源端无唯一索引表的全量迁移时,是否清空目标表。

false
AllowDestTableNotEmptyboolean

目标端表对象存在记录时处理策略,包括 忽略停止迁移

  • 设置为 true,表示选择忽略:当目标端表对象存在数据时,如果原数据与写入数据冲突,数据传输采用将冲突数据记录日志,保留原数据不变的策略进行数据写入。
    注意 选择忽略,全量校验将使用 IN 模式拉取数据,无法校验目标端多数据的场景,并且校验性能存在一定程度降级。
  • 设置为 false,表示选择停止迁移:当目标端表对象存在数据时,全量迁移会报错不允许迁移,请处理好目标端数据后再继续迁移。
    注意 如果出错后单击恢复,数据传输将忽略该配置选项,继续迁移表数据,请谨慎操作。
false
FullTransferSpeedModestring

全量迁移并发速度,包括 STEADY、NORMAL 和 FAST。

NORMAL
FullVerifySpeedModestring

全量校验并发速度,包括 STEADY、NORMAL 和 FAST。

NORMAL
EnableIncrTransferboolean

是否开启增量传输。

true
EnableIncrVerifyboolean

是否开启增量校验。

true
EnableReverseIncrTransferboolean

是否开启反向增量传输。

true
IncrTransferConfigobject

增量同步的配置。

StartTimestamplong

增量同步起始位点,秒级时间戳。仅启用增量同步但未启用全量传输时,支持设置该参数。

1681004708
RecordTypeWhiteListarray

有增量同步阶段时,同步的增量数据类型。

string

有增量同步阶段时,同步的增量数据类型。

枚举值:
  • DELETEDELETE
  • COMMITCOMMIT
  • INSERTINSERT
  • UPDATEUPDATE
  • BEGINBEGIN
  • ROWROW
  • HEARTBEATHEARTBEAT
  • DDLDDL
  • ROLLBACKROLLBACK
INSERT
StoreLogKeptHourinteger

有增量同步阶段且增量日志拉取组件为 Store 时,日志的保存时间。单位为小时,默认 7 天,最长支持 365 天。

24
EnableSequencingWithinTxnboolean

有增量同步阶段且增量日志拉取组件为 Store 时,是否开启事务内序号编排。

true
IncrSyncConcurrencyinteger

增量同步的线程数,默认值为 64。

64
EnableIncrSyncStatisticsboolean

是否开启增量记录(DML、DDL)统计。

true
SourceConnectInfoobject

源端节点的连接信息。

Idstring

连接信息的 ID。

c_4w3aq****
EndpointNamestring

终端节点的名称。

ration12****0obmysql4116892***
EndpointIdstring

终端节点的 ID。

e_4w3al***
EndpointSidestring

终端节点的类型,包括 source(源端)和 dest(目标端)。

source
DbEnginestring

终端节点的数据库引擎。

OB_MYSQL_PUBLIC
ConnectionInfostring

终端节点的连接信息。

null
Usernamestring

连接用户名。

oms931mys**
Versionstring

数据库的版本。

5.7.27
Timezonestring

数据库的时区。

UTC
Charsetstring

字符编码。

utf8mb4
NlsLengthSemanticsstring

nlsLengthSemantics 属性,仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。

null
OperatingSystemstring

操作系统(OceanBase 数据库无该参数)。

Linux
Regionstring

地域。

cn-hangzhou
OcpNamestring

OCP 的名称。

null
ConnExtraAttributesany

连接额外属性。具体返回字段请参见《附录》模块的内容。

null
Ownerstring

Owner。

admin
ResourceOwnerstring

资源所有者的 UID。

1325847***
Hoststring

IP 地址。

xxx.xxx.xxx.1
Portinteger

端口。

2883
SinkConnectInfoobject

目的端节点的连接信息。

Idstring

连接信息的 ID。

c_4w3akx***
EndpointNamestring

终端节点的名称。

ation129***9apimysql5616****
EndpointIdstring

终端节点的 ID。

e_4w3aic***
EndpointSidestring

终端节点的类型,包括 source(源端)和 dest(目标端)。

sink
DbEnginestring

终端节点的数据库引擎。

MYSQL_PUBLIC
ConnectionInfostring

终端节点的连接信息。

null
Usernamestring

连接用户名。

oms**obmys**
Versionstring

数据库的版本。

2.2.77
Timezonestring

数据库的时区。

+08:00
Charsetstring

字符编码。

utf8mb4
NlsLengthSemanticsstring

nlsLengthSemantics 属性,仅针对 Oracle 和 OceanBase 数据库 Oracle 租户数据源。

null
OperatingSystemstring

操作系统(OceanBase 数据库无该参数)。

Linux
Regionstring

地域。

cn-hangzhou
OcpNamestring

OCP 名称。

null
ConnExtraAttributesany

连接额外属性。具体返回字段请参见《附录》模块的内容。

null
Ownerstring

Owner。

admin
ResourceOwnerstring

资源所有者的 UID。

1325847***
Hoststring

IP 地址。

xxx.xxx.xxx.1
Portinteger

端口。

2883
Stepsarray<object>

步骤列表。

object
Orderinteger

步骤的运行顺序。

1
Namestring

步骤的名称。

TRANSFER_PRECHECK
Descriptionstring

步骤的描述(预检查/结构迁移/结构同步/全量迁移/全量同步/全量校验/索引迁移/增量日志拉取/增量同步/增量校验/正向切换)。

预检查
Statusstring

步骤的运行状态,包括 INIT(初始化)、RUNNING(运行中)、FAILED(失败)、 FINISHED(已完成)、 SUSPEND(已暂停)、MONITORING(持续监控状态,用于增量同步和增量校验的持续监控态)。

RUNNING
ExtraInfoobject

补充信息(JSON)。

ErrorDetailsarray<object>

错误详情。

object
Codestring

错误码(新)。

CM-RESOAT1111
Levelstring

包括 FATAL、ERROR、WARNING 和 CRITICAL。

ERROR
Messagestring

错误描述(新)。

A system error occurred.
ExtraContextobject

用于填充 Message 中的占位符。

any

用于填充 Message 中的占位符。

null
MessageMcmsKeystring

错误信息的 Key。

null
MessageMcmsContextobject

用于填充 MessageMcmsKey 中的占位符。

string

用于填充 MessageMcmsKey 中的占位符。

null
Reasonstring

错误原因。

null
ReasonMcmsKeystring

错误原因的 Key。

null
ReasonMcmsContextobject

错误原因的上下文。

string

错误原因的上下文。

null
Proposalstring

建议(新)。

Contact the administrator.
ProposalMcmsKeystring

建议内容的 Key。

null
ProposalMcmsContextobject

建议内容的上下文。

string

建议内容的上下文。

null
UpstreamErrorDetailany

上游错误详情,用于处理 HTTP 请求。

null
ErrorCodestring

错误码。

INNER_ERROR
ErrorMsgstring

错误描述。

A system error occurred.
ErrorParamobject

错误相关的参数。

string

错误相关的参数。

null
FailedTimestring

错误时间。

null
StartTimestring

开始时间,以 UTC + 0 时区的时间格式展示。

2020-05-22T17:04:18
FinishTimestring

结束时间,以 UTC + 0 时区的时间格式展示。

2020-05-22T17:05:18
Progressinteger

步骤的运行进度。

100
StepInfoobject

各步骤的运行详情。

null
ExtraInfoobject

错误信息等补充信息。

RunningStepstring

处于 RUNNING 状态的步骤。

TRANSFER_PRECHECK
RunningProgressinteger

处于 RUNNING 状态的步骤的运行进度。

90
MonitoringIncrboolean

是否开始监控增量。

true
Subtopicsarray

任务关联 Store 的 Subtopics 列表。

string

任务关联 Store 的 Subtopic。

null
ReverseSubtopicsarray

任务关联反向 Store 的 Subtopics 列表。

string

任务关联反向 Store 的 Subtopic。

null
LogServiceStartCheckpointlong

起始位点。

1689214358
SourceStoreKeptHourinteger

日志保存时间。

24
SyncDelaylong

增量同步延迟时间。

null
SyncDelaySampleTimestamplong

同步延迟的采集时间戳,秒级别。

1689214358
AccessObSourceboolean

是否能够直连源端 OceanBase 数据库。

true
OverwriteConfigboolean

是否允许完全覆盖更新配置。

true
IgnoreUnsupportDdlboolean

是否忽略不支持的 DDL。

true
SubDbsobject

记录不同下游消费方的表配置,用于同步任务复用时的配置合并。

array<object>

记录不同下游消费方的表配置,用于同步任务复用时的配置合并。

object
ClusterNamestring

集群的名称。

cluster_name
TenantNamestring

租户的名称。

tenant_name
DatabaseIdstring

数据库的 ID。目前仅逻辑库才会具有 ID,可能存在在一个 Endpoint 中库名相同,但是 ID 不同。表示的是不同的 ID 情况。

null
DatabaseNamestring

数据库的名称。

db_name
MappingDatabaseNamestring

数据库的映射名称。

mapped_db
SourceClientIdstring

用于标识处理该 DatabaseName 的 Source Client。

null
Tablesarray<object>

待传输表的列表。

object
TableIdstring

逻辑表的 ID。

null
Databasestring

数据库的名称。

db_name
TableNamestring

表的名称。

table_name
MappingTableNamestring

表的映射名称。

mapped_name
Instancestring

传输实例的 ID。

g_i4kat***
Columnsarray<object>

待传输列的列表。

object
ColumnNamestring

列的名称。

column_name
Positioninteger

字段的位置。

null
ColumnTypestring

列的类型。

null
RecordFieldTypestring

列类型的引申。

null
RawColumnTypestring

数据库记录的列类型的原始字符串。

null
ColumnKeystring

索引的类型。

null
Nullableboolean

是否可以为空。

false
DefaultValuestring

默认值。

null
DataLengthlong

列的长度。

null
DataPrecisioninteger

列的精度。

64
DataScaleinteger

小数点。

null
Encodingstring

列的字符编码。

utf8
ColumnCommentstring

列的注释。

comments
IsGenerateFieldboolean

是否为隐藏列。

false
SubCondsobject

同步 DataWorks 场景,记录不同下游消费方的表配置,用于同步任务复用时的配置合并。

array<object>

同步 DataWorks 场景,记录不同下游消费方的表配置,用于同步任务复用时的配置合并。

object
TenantNamestring

源端租户的名称。

tenant_name
Databasestring

源端数据库的名称。

db_name
DestDatabasestring

目标端数据库的名称。

dest_db
TableNamestring

源端表的名称。

table_name
DestNamestring

目标端表的名称。

dest_name
WhereClausestring

标准的 SQL 语句中的 WHERE 子句,用于配置行过滤。

id>1
FilterColumnsarray

过滤列集合。

string

过滤列。

col
ShardColumnsarray

分片列集合。

string

分片列。

col
LogicTableIdstring

针对逻辑表下,逻辑表的 ID。

null
SourceEndpointIdstring

针对物理表下传递 endpointId。

null
SourceClientIdstring

Connector Client 的 ID。

null
SubIdsobject

配置对象的 ID 列表。

string

配置对象的 ID。

null
MaxConnectorCountinteger

Connector 的最大数量,-1 表示不限制。

-1
StoreIncrboolean

是否保存增量。

true
IncrSyncTimestamplong

增量同步的当前位点,单位为秒级时间戳。

1689244596
AlarmStatsobject

告警统计信息。

Targetstring