调用SearchOmsOpenAPIProjects模糊搜索项目_云数据库 OceanBase-阿里云帮助中心

模糊搜索项目。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
WorkerGradeId	string	否	传输实例的 ID。通常公有云上创建项目，需要先购买传输实例。	g_abcdefj***
PageNumber	integer	否	页序号，分页查询时生效。	1
PageSize	integer	否	页大小，分页查询时生效。	1
SearchKey	string	否	模糊查询关键字。根据项目 ID 和项目名称进行模糊搜索。	projectName
SourceDbTypes	array	否	源端类型列表。
	string	否	指定源端类型。	mysql
DestDbTypes	array	否	目标端类型列表。
	string	否	指定目标端类型。	oceanbase
LabelIds	array	否	标签列表。
	string	否	指定标签。	test
StatusList	array	否	项目状态列表。
	string	否	指定项目状态。	running

返回参数

名称	类型	描述	示例值
	object	OmsApiReturnResult。
Success	boolean	是否调用成功。	true
ErrorDetail	object	错误详情。
Code	string	错误码（新）。	CM-RESOAT111111
Level	string	错误等级，包括 CRITICAL、ERROR 和 WARN。	ERROR
Message	string	错误描述（新）。	A system error occurred.
Proposal	string	建议（新）。	Contact the administrator.
Code	string	错误码（旧）。	INNER_ERROR
Message	string	错误描述（旧）。	A system error occurred.
Advice	string	建议（旧）。	Contact the administrator.
RequestId	string	请求 ID。	XCVSADGDFSGDFGFDGFDGDFGDFGDFGDFGDSGDS
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	1
TotalCount	long	总数，分页查询时生效。	1
Cost	string	请求耗时，单位为秒。	1
Data	object []	返回的业务数据列表信息。
ProjectId	string	项目 ID。	p_gasdfdsfg
ProjectName	string	项目名称。	p_gasdfdsfg
ProjectOwner	string	项目 Owner。	Zhang San
Labels	object []	标签 ID 的集合。
Id	string	标签 ID。	abc
Name	string	标签名称。	test
Creator	string	创建人（只有在管理员视角下才进行返回）。	admin
Count	integer	使用该标签的项目数量。	3
SourceConfig	object	源端传输配置。
EndpointType	string	数据源类型，包括 `MYSQL`、`MARIADB`、`OB_MYSQL`、`OB_MYSQL_CE`、`OB_ORACLE`、`ORACLE`、`DB2_LUW`、`KAFKA`、`ROCKETMQ`、`DATAHUB`、`SYBASE`、`LOGPROXY`、`ADB`、`DBP_OP_ROUTE`、`DMS`、`IDB` 和 `TIDB`。	OB_MYSQL
EndpointId	string	指定数据源 ID。	e_abcdefj
PartitionMode	string	目标端为消息队列（Kafka/DataHub/RocketMQ）时，选择分区模式（包括 ONE、HASH 和 TABLE）。	HASH
Partition	integer	目标端为消息队列（Kafka/DataHub/RocketMQ）时，如果 `partitionMode` 为 ONE 模式，该参数表示分区索引。	0
SerializerType	string	目标端为消息队列（Kafka/DataHub/RocketMQ）时，选择文本序列化类型（Default、DefaultExtendColumnType、Canal、Dataworks 和 SharePlex）。	DEFAULT
TopicType	string	目标端为 DataHub 时，投递消息所属 topic 的类型（TUPLE, BLOB）。	TUPLE
SequenceEnable	boolean	目标端为 DataHub 时，该参数表示是否开启消息序列。	false
SequenceStartTimestamp	long	目标端为 DataHub 时，若开启消息序列，设置序列起始时间，单位为秒级时间戳。	1656510473
ProducerGroup	string	目标端为 RocketMQ 时，指定投递消息的生产者组。	producer-group-1
MsgTags	string	目标端为 RocketMQ 时，设置投递消息的 tag（标签）。	tag1
EnableMsgTrace	boolean	目标端为 RocketMQ 时，此参数表示是否开启消息追踪。	false
SendMsgTimeout	long	目标端为 RocketMQ 时，设置单次投递消息的超时时间，单位为秒。	10
DestConfig	object	目标端传输配置。
EndpointType	string	数据源类型 (MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, TIDB)。	OB_MYSQL
EndpointId	string	指定数据源 id。	e_abcdefj
PartitionMode	string	目标端为消息队列（Kafka/DataHub/RocketMQ）时，选择分区模式（ONE, HASH, TABLE）。	HASH
Partition	integer	目标端为消息队列（Kafka/DataHub/RocketMQ）时，若 partitionMode 为 ONE 模式，此参数表示分区索引。	0
SerializerType	string	目标端为消息队列（Kafka/DataHub/RocketMQ）时，选择文本序列化类型（Default、DefaultExtendColumnType、Canal、Dataworks 和 SharePlex）。	DEFAULT
TopicType	string	目标端为 DataHub 时，投递消息所属 topic 的类型（TUPLE, BLOB）。	TUPLE
SequenceEnable	boolean	目标端为 DataHub 时，该参数表示是否开启消息序列。	false
SequenceStartTimestamp	long	目标端为 DataHub 时，如果开启消息序列，设置序列起始时间，单位为秒级时间戳。	1656510473
ProducerGroup	string	目标端为 RocketMQ 时，指定投递消息的生产者组。	producer-group-1
MsgTags	string	目标端为 RocketMQ 时，设置投递消息的 tag（标签）。	tag1
EnableMsgTrace	boolean	目标端为 RocketMQ 时，此参数表示是否开启消息追踪。	false
SendMsgTimeout	long	目标端为 RocketMQ 时，设置单次投递消息的超时时间，单位为秒。	10
TransferMapping	object	传输对象的映射关系。
Mode	string	映射类型，包括 `NORMAL` 和 `WHITE_AND_BLACK_LIST`。	NORMAL
Databases	object []	传统映射（源端库表映射）列表信息，当且仅当 mode 为 NORMAL 是生效。
TenantName	string	映射对象租户，源端为 OceanBase 时生效。	tenant
MappedName	string	映射对象 database，目标端为数据库时生效。	mapped_db
DatabaseId	string	数据库 ID，源端为逻辑数据源 IDB 时生效。	db_id1
DatabaseName	string	数据库的名称。	db1
Tables	object []	当前库下的传输表列表信息。
MappedName	string	映射对象 table/topic，目的端为数据库时，此参数为映射表名，目的端为消息队列时，此参数为映射 topic。	mapped_table
TableId	string	表 ID，源端为逻辑数据源 IDB 时生效。	table_id
TableName	string	表名。	table
WhereClause	string	行过滤条件。	id > 1
FilterColumns	array	过滤列列表，即指定同步哪些列。
	string	过滤列。	col
ShardColumns	array	分片键列列表，用于目标端为消息队列的场景。
	string	分片键列。	col1
AdbTableSchema	object	ADB table schema，目标端为 ADB 时，额外配置信息，用于结构同步。
PrimaryKeys	array	主键列列表。
	string	主键列。	pk
DistributedKeys	array	分布键列列表。
	string	分布键列。	col2
PartitionStatement	string	分区表达式。	PARTITION BY VALUE('id')
PartitionLifeCycle	integer	表的生命周期。	30
Type	string	DATABASE, TABLE。	DATABASE
Type	string	DATABASE, TABLE。	DATABASE
TransferStepConfig	object	传输步骤配置。
EnableStructSync	boolean	是否开启结构同步。	false
EnableFullSync	boolean	是否开启全量迁移。	false
EnableIncrSync	boolean	是否开启增量同步。	false
IncrSyncStepTransferConfig	object	增量同步步骤配置。
StartTimestamp	long	有增量同步阶段时，增量起始位点，秒级时间戳。	1656644154
RecordTypeList	array	有增量同步阶段时，同步的增量数据类型列表。
	string	有增量同步阶段时，同步的增量数据类型。	INT
StoreLogKeptHour	long	有增量同步阶段，且增量日志拉取组件为 Store 时，日志保存时间。	1
StoreTransactionEnabled	boolean	有增量同步阶段时，且增量日志拉取组件为 Store 时，是否开启事务内序号编排。	false
TransferStepType	string	STRUCT, FULL, INCR。	STRUCT
BusinessName	string	业务系统标识（可选），投递消息带上的特定字段。	OMS_TEST
Steps	object []	项目步骤详情列表信息。
StepOrder	integer	步骤顺序。	1
StepName	string	步骤名（struct_migration/full_migration/full_validation/incr_log_pull/incr_sync/incr_validation） (PRE_CHECK, PREPARE, STRUCT_MIGRATION, INDEX_MIGRATION, STRUCT_SYNC, FULL_MIGRATION, APP_SWITCH, REVERSE_INCR_SYNC, FULL_VALIDATION, INCR_LOG_PULL, INCR_SYNC, INCR_VALIDATION, SYNC_PREPARE, SYNC_INCR_LOG_PULL, CONNECTOR_FULL_SYNC, CONNECTOR_INCR_SYNC）。	structmigration
StepDescription	string	步骤描述（结构迁移/全量迁移/全量校验/增量日志拉取/增量同步/增量校验）。	Schema migration
StepStatus	string	步骤状态。 INIT：初始化 RUNNING：运行中 FAILED：失败 FINISHED：已完成 SUSPEND：暂停中 MONITORING：持续监控状态，用于增量同步和增量校验的持续监控态	INIT
StepProgress	integer	步骤进度。	10
StepInfo	object	步骤详情（json）。
JobId	string	步骤的当前子 job id。	j_dfasefsd
IncrTimestampCheckpoint	long	如果是增量场景，会是位点时间，unix timestamp，单位秒。	1
Checkpoint	string	位点时间，unix timestamp，单位秒。	1
Gmt	long	位点采集时间，unix timestamp，单位秒。	1
ConnectorFullProgressOverview	object	同步全量进度。
EstimatedTotalCount	long	预估迁移数据量（SUM）。	100
FinishedCount	long	已完成迁移数据量（SUM）。	50
Progress	integer	finishedCount / estimatedTotalCount。	1120
EstimatedRemainingTimeOfSec	long	预计剩余时间，秒单位（MAX）。	100
Validated	boolean	子状态，validated 标识全量校验 checker 是否已完成。	false
Skipped	boolean	子状态，skipped 标识这一步骤是否跳过。	false
Inconsistencies	long	全量校验不一致的数量。	1
DeployId	string	资源部署 ID。	ewtfqwt
ProcessedRecords	long	已完成迁移行数/实际行数。	10
Capacity	long	预估总行数。	10000
SrcRps	long	源端读取 rps，单位：记录数/秒。	1
SrcRt	long	源端读取 rt，单位：毫秒/条。	1
SrcIops	long	源端读取流量，单位：字节数/秒。	1
DstRps	long	目标端读取/写入 rps，单位：记录数/秒。	1
DstRt	long	目标端读取/写入 rt，单位：毫秒/条。	1
DstIops	long	目标端读取/写入流量，单位：字节数/秒。	1
SrcRpsRef	long	源端读取 rps 基准值。	1
SrcRtRef	long	源端读取 rt 基准值。	1
DstRpsRef	long	目标端读取/写入 rps 基准值。	1
DstRtRef	long	目标端读取/写入 rt 基准值。	1
SrcIopsRef	long	源端读取流量，基准值。	1
ExtraInfo	object	补充信息（json）。
ErrorDetails	object []	错误详情列表信息。
Code	string	错误码。	200
Level	string	包括 CRITICAL、ERROR 和 WARN。	CRITICAL
Message	string	错误信息。	A system error occurred.
Proposal	string	建议。	Contact the administrator.
ErrorCode	string	错误码（AUTHENTICATION_ERROR, PARAM_ERROR, PARAM_ERROR_MESSAGE, NOT_IMPLEMENTED_ERROR, SHARD_COLUMNS_CONFLICT_MESSAGE, FAILED_PARSE_TOKEN_MESSAGE, CONNECT_CHECK_ERROR, NOT_SUPPORT_ERROR, CE_NOT_SUPPORT_ERROR, NOT_FOUND_ERROR, SHARDING_COLUMN_NOT_INCLUDED_ERROR, INNER_ERROR, DB_QUERY_ERROR, DATAHUB_QUERY_ERROR, USER_LACK_SYS_PRIV_ERROR, USER_LACK_TABLE_PRIV_ERROR, RM_API_ERROR, RM_TASK_ERROR, CM_API_ERROR, CM_API_NOT_SUCCESS, BAGUALU_API_ERROR, IDB_API_ERROR, SUPERVISOR_API_ERROR, OCP_API_ERROR, OCP_SERVICE_ERROR, OCP_QUERY_VERSION_FAILED, OCP_VERSION_INCORRECT_ERROR, OCP_VERSION_NOT_SUPPORTED_ERROR, OCP_API_USER_PASSWORD_INCORRECT_ERROR, OBSCHEMA_ERROR, EXECUTOR_THREAD_POOL_BUSY, NO_TABLE_SELECTED, NO_VIEW_SELECTED, SOURCE_CRAWLER_START_FAILED, SOURCE_CRAWLER_START_FAILED_DATA_EXPIRED, SOURCE_CRAWLER_START_TIMEOUT, DEST_WRITER_START_FAILED, WRITER_UNKNOWN_STATUS, DRC_TOPIC_EXISTS_ERROR, TOPIC_EMPTY_ERROR, REACH_WRITER_LIMIT_ERROR, FOUND_NO_FEASIBLE_STORE_ERROR, TOO_MANY_STORES_FOR_SUBTOPIC, TIMEOUT_EXCEPTION, KIPP_API_ERROR: KIPP 相关错误信息, KIPP_API_RESOURCE_NOT_FOUND, KIPP_API_INVALID_PARAM, KIPP_API_UNKNOWN_ERROR, KIPP_API_INTERNAL_ERROR, KIPP_API_SERVICE_UNAVAILABLE, OMS_AGENT_API_ERROR, KMS_API_ERROR, OMS_ENCRYPT_API_ERROR, OMS_DECRYPT_API_ERROR, ALIYUN_SDK_ERROR, YAOCHI_API_ERROR, RESOURCE_WITHOUT_STOCK_ERROR, RESOURCE_NO_AVAILABLE_ZONE, CM_SDK_ERROR, MIGRATION_PROJECT_STEP_PRECHECK_FAILED, PRE_CHECK_ERROR, FAILURES_CORRECT_ERROR, EXECUTE_DDL_FAILURE, EXECUTE_DDL_UNSUPPORTED_OR_FAILURE, STRUCT_RECORD_DDL_NOT_FOUND, STRUCT_RECORD_INDEX_NOT_FOUND, STRUCT_RECORD_NOT_FOUND, STRUCT_RECORD_NOT_FOUND_IN_DBCAT, SCHEMA_OBJECT_TYPE_NOT_SUPPORT_ERROR, POLAR_MYSQL_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_NETWORK_TYPE_NOT_SUPPORT_ERROR, RDS_VPC_NETWORK_NOT_SUPPORT_ERROR, DB_TYPE_NOT_SUPPORT_ERROR, SYNC_TYPE_NOT_SUPPORT_ERROR, SLAVE_OPERATION_STEP_NOT_SUPPORT_ERROR, BYTE_USED_TYPE_NOT_SUPPORT_ERROR, MANY_TO_ONE_SCHEMA_TABLE_REVERSE_INCR_NOT_SUPPORT_ERROR, DUPLICATE_SCHEMA_TABLE_ERROR, OMS_STEP_NOT_SUPPORT_ERROR, ORACLE_DATABASE_ROLE_NOT_SUPPORT_ERROR, OLD_PRE_CHECK_NOT_SUPPORT_ERROR, SCHEMA_ONE_TO_MANY_NOT_SUPPORT_ERROR, PROJECT_NOT_FOUND_ERROR, ENDPOINT_NOT_FOUND_ERROR, ENDPOINT_NAME_ALREADY_EXIST_ERROR, ENDPOINT_QUERY_ERROR, ENDPOINT_SQL_QUERY_ERROR, PROJECT_NAME_ALREADY_EXIST_ERROR, CHECKER_NOT_FOUND_ERROR, CHECKER_FAILED_ERROR, CHECKER_STATUS_UNEXPECTED_ERROR, CHECKER_NO_TASK_TYPE_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR, WORKER_INSTANCE_ALLOCATING_ERROR, LOG_SERVICE_TOPIC_NOT_FOUND_ERROR, CLUSTER_NOT_FOUND_ERROR, TENANT_NOT_FOUND_ERROR, DATABASE_NOT_FOUND_ERROR, TABLE_NOT_FOUND_ERROR, COLUMN_NOT_FOUND_ERROR, TABLE_META_NOT_FOUND_ERROR, SYBASE_CHARSET_NOT_FOUND_ERROR, OCP_NOT_FOUND_ERROR, REGION_NOT_FOUND_ERROR, OCP_ALREADY_EXIST_ERROR, ALARM_CHANNEL_NAME_ALREADY_EXIST_ERROR, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_RESPONSE, SEND_MARKDOWN_TEXT_TO_WEBHOOK_FAILED_EXCEPTION_STATUS, LABEL_ALREADY_EXIST_ERROR, LABEL_NOT_EXIST_ERROR, OCP_ALREADY_USED_ERROR, REGION_INFO_INCONSISTENT_ERROR, OCP_NAME_EMPTY_ERROR, MASTER_SLAVE_ENDPOINT_NAME_INCONSISTENT_ERROR, LOG_FILE_NOT_FOUND_ERROR, OPERATION_NOT_ALLOWED_ERROR, PROJECT_OPERATION_NOT_ALLOWED_ERROR, PROJECT_RELEASE_FAILED, STRUCT_MIGRATION_RETRY_NOT_ALLOWED_ERROR, WORKER_INSTANCE_OPERATION_NOT_ALLOWED_ERROR, USER_OPERATION_NOT_ALLOWED_ERROR, OCP_NAME_OR_REGION_NOT_ALLOWED_UPDATE, UPDATE_CONFIG_WITH_NEWLINE_NOT_ALLOWED, EXIST_UNRELEASED_PROJECT_ERROR, EXIST_UNRELEASED_TOPIC_ERROR, LABEL_CREATE_NOT_ALLOWED_ERROR, LABEL_UPDATE_NOT_ALLOWED_ERROR, LABEL_DELETE_NOT_ALLOWED_ERROR, TOPIC_NAME_INVALID_ERROR, INVALID_STATUS_ERROR, INVALID_CSV_HEAD_ERROR, INVALID_CSV_BODY_ERROR, DUPLICATE_SCHEMA_TABLE_SETTING_ERROR, PROJECT_INVALID_STATUS_ERROR, PROJECT_INVALID_CONNECTOR_COUNT_ERROR, WORKER_INSTANCE_INVALID_STATUS_ERROR, LOG_SERVICE_INVALID_STATUS_ERROR, STEP_INVALID_STATUS_ERROR, UPDATE_ALLOW_DEST_TABLE_NOT_EMPTY_NOT_ALLOWED_ERROR, EXIST_INCONSISTENCY_ERROR, OMS_SWITCH_SUBSTEP_FAILED_ERROR, ENDPOINT_ID_INVALID_ERROR, DB_QUERY_VERSION_EMPTY_ERROR, ENDPOINT_NAME_INVALID_ERROR, ENDPOINT_SCHEMA_NOT_ALLOWED_ERROR, ENDPOINT_SCHEMA_CHAR_NOT_ALLOWED_ERROR, NAME_HAS_SPACE_EXCEPTION, CONFIG_CONVERT_VALUE_ERROR, CONFIG_VALUE_EXCEEDS_LIMIT_ERROR, CONFIG_KEY_NOT_FOUND_KEY_ERROR, CONFIG_VALUE_NOT_EMPTY_ERROR, SCHEMA_HAS_CONVERT_INFO, TIME_SERIES_QUERY_SERVICE_ERROR, ETL_VERIFY_ERROR, ETL_SYNTAX_UNSUPPORTED, ETL_FIELD_NOTFOUND, ETL_FAILED_PARSE_SQL, ETL_VAL_TYPE_ERROR, NOT_SUPPORT_GENERATE_COLUMNS, NOT_SUPPORT_UPDATE_ETL, LOCK_FAILED, OMS_USER_EXIST_ERROR, OMS_USER_NOT_FOUND_ERROR, OMS_USER_NAME_LENGTH_CONSTRAINT, OMS_USER_PASSWORD_ERROR, USER_NAME_OR_PASSWORD_ERROR, OMS_USER_PASSWORD_VALIDATION_ERROR, OMS_USER_PASSWORD_DEFAULT_ERROR, OMS_USER_PERMISSION_DENIED_ERROR, OMS_USER_EDIT_ADMIN_ROLE_INFO_PERMISSION_DENIED_ERROR, OMS_USER_ILLEGAL_DELETED_ERROR, CONNECTOR_TASK_NOT_FOUND_ERROR, CONNECTOR_TASK_NUM_LIMIT_ERROR, CONNECTOR_TASK_DELETE_ERROR, METRIC_SERVICE_ERROR, SYNC_PROJECT_TYPE_INVALID_ERROR, SYNC_SHARDING_COLUMNS_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_INVALID_ERROR, SYNC_PROJECT_PRODUCER_GROUP_LIMIT_EXCEEDS_ERROR, SYNC_PROJECT_COMPLEMENT_CONFIG_ERROR, META_SCHEMA_CREATE_FAILED, RESUME_STEP_FAILED, SCHEMA_INCONSISTENCY, SCHEMA_CASCADE_MAPPING_NOT_SUPPORT_ERROR, SCHEMA_NOT_EXISTED, SCHEMA_EXISTED, SCHEMA_NOT_EXIST, BLACK_LIST_MATCH_ALL, BLACK_LIST_CONTAIN_NON_WHITE_SCHEMA, BLACK_WHITE_LIST_PARAM_INVALID_ERROR, OPERATOR_ERROR, OPERATOR_DIMENSION_NOT_SUPPORT, OPERATOR_PULL_LOG_ERROR, OPERATOR_UPDATE_CONFIG_NOT_SUPPORT, KAFKA_CREATE_TOPIC_ERROR, KAFKA_QUERY_TOPIC_ERROR, KAFKA_BUILD_PROPERTIES_ERROR, ROCKETMQ_CREATE_TOPIC_ERROR, ROCKETMQ_QUERY_TOPIC_ERROR, SYNC_OBJECT_EMPTY_ERROR, WRITER_NUMBER_NOT_UNIQUE, WRITER_NOT_ACTIVE, PROJECT_NAME_DUPLICATE_ERROR, EMPTY_FAILED_STRUCT_MIGRATION_TABLES_ERROR, LOGIC_TABLE_NOT_SUPPORT_UPDATE_OBJECT_ERROR, LOGIC_REQUEST_ERROR, LOGIC_DTO_BUILD_ERROR, UNEXPECTED_REMOTE_API_RESULT, OCEANBASE_USER_UNEXPECTED, STORE_CREATE_FAILED_ERROR, STORE_START_FAILED, STORE_NOT_PULL_LOG_ERROR, ALL_HOSTS_STATUS_ERROR, WORKER_ECS_NOT_FOUND_ERROR, WORKER_ECS_NOT_FOUND_FOR_USER_ERROR, WORKER_POD_NOT_FOUND_ERROR, WORKER_POD_NOT_FOUND_FOR_USER_ERROR, WORKER_INSTANCE_NOT_FOUND_ERROR_V2, WORKER_INSTANCE_NOT_FOUND_FOR_USER_ERROR）。	INNER_ERROR
ErrorMsg	string	错误消息。	A system error occurred.
ErrorParam	object	错误相关参数。
	string	错误相关参数。	FailedTime
FailedTime	string	错误时间。	2020-05-22T17:04:18
StartTime	string	开始时间，格式："2020-05-22T17:04:18"。	2020-05-22T17:04:18
EstimatedRemainingSeconds	long	预计剩余时间。	2020-05-22T17:04:18
FinishTime	string	结束时间，格式："2020-05-22T17:04:18"。	2020-05-22T17:05:18
Interactive	boolean	是否需要用户确认执行，不由后台调度推进。	false

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "CM-RESOAT111111",
    "Level": "ERROR",
    "Message": "A system error occurred.",
    "Proposal": "Contact the administrator. "
  },
  "Code": "INNER_ERROR",
  "Message": "A system error occurred.",
  "Advice": "Contact the administrator. ",
  "RequestId": "XCVSADGDFSGDFGFDGFDGDFGDFGDFGDFGDSGDS",
  "PageNumber": 1,
  "PageSize": 1,
  "TotalCount": 1,
  "Cost": "1",
  "Data": [
    {
      "ProjectId": "p_gasdfdsfg",
      "ProjectName": "p_gasdfdsfg",
      "ProjectOwner": "Zhang San",
      "Labels": [
        {
          "Id": " abc",
          "Name": " test",
          "Creator": "admin",
          "Count": 3
        }
      ],
      "SourceConfig": {
        "EndpointType": "OB_MYSQL",
        "EndpointId": "e_abcdefj",
        "PartitionMode": "HASH",
        "Partition": 0,
        "SerializerType": "DEFAULT",
        "TopicType": "TUPLE",
        "SequenceEnable": false,
        "SequenceStartTimestamp": 1656510473,
        "ProducerGroup": "producer-group-1",
        "MsgTags": "tag1",
        "EnableMsgTrace": false,
        "SendMsgTimeout": 10
      },
      "DestConfig": {
        "EndpointType": "OB_MYSQL",
        "EndpointId": "e_abcdefj",
        "PartitionMode": "HASH",
        "Partition": 0,
        "SerializerType": "DEFAULT",
        "TopicType": "TUPLE",
        "SequenceEnable": false,
        "SequenceStartTimestamp": 1656510473,
        "ProducerGroup": "producer-group-1",
        "MsgTags": "tag1",
        "EnableMsgTrace": false,
        "SendMsgTimeout": 10
      },
      "TransferMapping": {
        "Mode": "NORMAL",
        "Databases": [
          {
            "TenantName": "tenant",
            "MappedName": "mapped_db",
            "DatabaseId": "db_id1",
            "DatabaseName": "db1",
            "Tables": [
              {
                "MappedName": "mapped_table",
                "TableId": "table_id",
                "TableName": "table",
                "WhereClause": "id > 1",
                "FilterColumns": [
                  "col"
                ],
                "ShardColumns": [
                  "col1"
                ],
                "AdbTableSchema": {
                  "PrimaryKeys": [
                    "pk"
                  ],
                  "DistributedKeys": [
                    "col2"
                  ],
                  "PartitionStatement": "PARTITION BY VALUE('id')",
                  "PartitionLifeCycle": 30
                },
                "Type": "DATABASE"
              }
            ],
            "Type": "DATABASE"
          }
        ]
      },
      "TransferStepConfig": {
        "EnableStructSync": false,
        "EnableFullSync": false,
        "EnableIncrSync": false,
        "IncrSyncStepTransferConfig": {
          "StartTimestamp": 1656644154,
          "RecordTypeList": [
            "INT"
          ],
          "StoreLogKeptHour": 1,
          "StoreTransactionEnabled": false,
          "TransferStepType": "STRUCT"
        }
      },
      "BusinessName": "OMS_TEST",
      "Steps": [
        {
          "StepOrder": 1,
          "StepName": " structmigration",
          "StepDescription": "Schema migration",
          "StepStatus": " INIT",
          "StepProgress": 10,
          "StepInfo": {
            "JobId": "j_dfasefsd",
            "IncrTimestampCheckpoint": 1,
            "Checkpoint": " 1",
            "Gmt": 1,
            "ConnectorFullProgressOverview": {
              "EstimatedTotalCount": 100,
              "FinishedCount": 50,
              "Progress": 1120,
              "EstimatedRemainingTimeOfSec": 100
            },
            "Validated": false,
            "Skipped": false,
            "Inconsistencies": 1,
            "DeployId": "ewtfqwt",
            "ProcessedRecords": 10,
            "Capacity": 10000,
            "SrcRps": 1,
            "SrcRt": 1,
            "SrcIops": 1,
            "DstRps": 1,
            "DstRt": 1,
            "DstIops": 1,
            "SrcRpsRef": 1,
            "SrcRtRef": 1,
            "DstRpsRef": 1,
            "DstRtRef": 1,
            "SrcIopsRef": 1
          },
          "ExtraInfo": {
            "ErrorDetails": [
              {
                "Code": "200",
                "Level": "CRITICAL",
                "Message": "A system error occurred.",
                "Proposal": "Contact the administrator. "
              }
            ],
            "ErrorCode": "INNER_ERROR",
            "ErrorMsg": "A system error occurred.",
            "ErrorParam": {
              "key": "FailedTime"
            },
            "FailedTime": "2020-05-22T17:04:18"
          },
          "StartTime": "2020-05-22T17:04:18",
          "EstimatedRemainingSeconds": 0,
          "FinishTime": "2020-05-22T17:05:18",
          "Interactive": false
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2022-08-19	新增 OpenAPI	看变更集