All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeOmsOpenAPIProject

Last Updated:Feb 28, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
WorkerGradeIdstringNo

The ID of the migration instance. Generally, if you want to create a project on a public cloud, you must first purchase a migration instance.

g_abcdefj***
PageNumberintegerNo

The page number, which takes effect in a pagination query.

1
PageSizeintegerNo

The page size, which takes effect in a pagination query.

1
ProjectIdstringNo

The project ID.

p_abcdefj

Response parameters

ParameterTypeDescriptionExample
object

OmsApiReturnResult

Successboolean

Indicates whether the call is successful.

true
ErrorDetailobject

The error details.

Codestring

The error code (new).

CM-RESOAT111111
Levelstring

The error level. Valid values: CRITICAL, ERROR, and WARN.

ERROR
Messagestring

The error description (new).

A system error occurred.
Proposalstring

The suggestions (new).

Contact the administrator.
Codestring

The error code (old).

INNER_ERROR
Messagestring

The error description (old).

A system error occurred.
Advicestring

The suggestions (old).

Contact the administrator.
RequestIdstring

The request ID.

XCVSADGDFSGDFGFDGFDGDFGDFGDFGDFGDSGDS
PageNumberinteger

The page number, which takes effect in a pagination query.

1
PageSizeinteger

The page size, which takes effect in a pagination query.

1
TotalCountlong

The total count, which takes effect in a pagination query.

1
Coststring

The time spent in processing the request, in seconds.

1
Dataobject

The business data returned.

ProjectIdstring

The project ID.

p_gasdfdsfg
ProjectNamestring

The name of the project.

The name of the project.
ProjectOwnerstring

The project owner.

Zhang San
Labelsobject []

A collection of label IDs.

Idstring

The ID of a label.

abc
Namestring

The name of the label.

label_name
Creatorstring

The creator. This parameter value is returned only when you log on as the administrator.

Zhang San
Countinteger

The number of projects that use this label.

3
SourceConfigobject

The settings of the source data source.

EndpointTypestring

The type of the data source. Valid values: MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, and TIDB.

OB_MYSQL
EndpointIdstring

The ID of the data source.

e_abcdefj
PartitionModestring

The partitioning mode, which must be specified if the destination data source is a message queue system, such as Kafka, DataHub, or RocketMQ. Valid values: ONE, HASH, and TABLE.

HASH
Partitioninteger

The partitioned index, which must be specified if the destination data source is a message queue system, such as Kafka, DataHub, or RocketMQ, and the partitioning mode is set to ONE.

0
SerializerTypestring

The text serialization type, which must be specified if the destination data source is a message queue system, such as Kafka, DataHub, or RocketMQ. Valid values: Default, DefaultExtendColumnType, Canal, Dataworks, and SharePlex.

DEFAULT
TopicTypestring

The type of the topic to which the Post message belongs when the destination data source is DataHub. Valid values: Tuple and Blob.

TUPLE
SequenceEnableboolean

Indicates whether message sequencing is enabled when the destination data source is DataHub.

false
SequenceStartTimestamplong

The start time of the sequence, which must be specified if the destination data source is DataHub and message sequencing is enabled. The value is a timestamp in seconds.

1656510473
ProducerGroupstring

The producer group of the Post message when the destination data source is RocketMQ.

producer-group-1
MsgTagsstring

The tag of the Post message when the destination data source is RocketMQ.

tag1
EnableMsgTraceboolean

Indicates whether message tracing is enabled when the destination data source is RocketMQ.

false
SendMsgTimeoutlong

The timeout period in seconds for a single Post message when the destination data source is RocketMQ.

10
DestConfigobject

The settings of the destination data source.

EndpointTypestring

The type of the data source. Valid values: MYSQL, MARIADB, OB_MYSQL, OB_MYSQL_CE, OB_ORACLE, ORACLE, DB2_LUW, KAFKA, ROCKETMQ, DATAHUB, SYBASE, LOGPROXY, ADB, DBP_OP_ROUTE, DMS, IDB, and TIDB.

OB_MYSQL
EndpointIdstring

The ID of the data source.

e_abcdefj
PartitionModestring

The partitioning mode, which must be specified if the destination data source is a message queue system, such as Kafka, DataHub, or RocketMQ. Valid values: ONE, HASH, and TABLE.

HASH
Partitioninteger

The partitioned index, which must be specified if the destination data source is a message queue system, such as Kafka, DataHub, or RocketMQ, and the partitioning mode is set to ONE.

0
SerializerTypestring

The text serialization type, which must be specified if the destination data source is a message queue system, such as Kafka, DataHub, or RocketMQ. Valid values: Default, DefaultExtendColumnType, Canal, Dataworks, and SharePlex.

DEFAULT
TopicTypestring

The type of the topic to which the Post message belongs when the destination data source is DataHub. Valid values: Tuple and Blob.

TUPLE
SequenceEnableboolean

Indicates whether message sequencing is enabled when the destination data source is DataHub.

false
SequenceStartTimestamplong

The start time of the sequence, which must be specified if the destination data source is DataHub and message sequencing is enabled. The value is a timestamp in seconds.

1656510473
ProducerGroupstring

The producer group of the Post message when the destination data source is RocketMQ.

producer-group-1
MsgTagsstring

The tag of the Post message when the destination data source is RocketMQ.

tag1
EnableMsgTraceboolean

Indicates whether message tracing is enabled when the destination data source is RocketMQ.

false
SendMsgTimeoutlong

The timeout period in seconds for a single Post message when the destination data source is RocketMQ.

10
TransferMappingobject

The mappings for the synchronization objects.

Modestring

The mapping type. Valid values: 'NORMAL' and 'WHITE_AND_BLACK_LIST'.

NORMAL
Databasesobject []

The table mapping in the source data source, which is a conventional mapping scheme and takes effect only when Mode is set to NORMAL.

TenantNamestring

The mapped-to tenant. This parameter takes effect when the source data source is OceanBase Database.

tenant
MappedNamestring

The mapped-to database. This parameter takes effect when the destination data source is a database.

mapped_db
DatabaseIdstring

The ID of the database. This parameter takes effect when the source data source is IDB.

db_id1
DatabaseNamestring

The name of the database.

db1
Tablesobject []

The settings for the target table objects in the current database.

MappedNamestring

The name of the mapped-to table or topic. If the destination data source is a database, this parameter specifies the name of the mapped-to table. If the destination data source is a message queue system, this parameter specifies the name of the mapped-to topic.

mapped_table
TableIdstring

The ID of the table. This parameter takes effect when the source data source is IDB.

table_id
TableNamestring

The name of the table.

table
WhereClausestring

The row filter conditions.

id > 1
FilterColumnsarray

The list of filter columns, which are the columns to be synchronized.

string

The filter columns.

col
ShardColumnsarray

The list of sharding key columns. This parameter applies to scenarios where the destination data source is a message queue system.

string

The sharding key column.

col1
AdbTableSchemaobject

The schema of the ADB table. If the destination data source is ADB, you need to configure additional information for schema synchronization.

PrimaryKeysarray

The list of primary key columns.

string

The primary key column.

pk
DistributedKeysarray

The list of distribution key columns.

string

The distribution key column.

col2
PartitionStatementstring

The partitioning expression.

PARTITION BY VALUE('id')
PartitionLifeCycleinteger

The lifecycle of the table.

30
Typestring

Valid values: DATABASE and TABLE.

DATABASE
Typestring

Valid values: DATABASE and TABLE.

DATABASE
TransferStepConfigobject

The settings of synchronization steps

EnableStructSyncboolean

Indicates whether schema synchronization is enabled.

false
EnableFullSyncboolean

Indicates whether full migration is enabled.

false
EnableIncrSyncboolean

Indicates whether incremental synchronization is enabled.

false
IncrSyncStepTransferConfigobject

The settings of incremental synchronization steps.

StartTimestamplong

The start time for incremental synchronization. The value is a timestamp in seconds.

1656644154
RecordTypeListarray

The list of data types of incremental data synchronized in incremental synchronization.

string

The data type of incremental data synchronized in incremental synchronization.

INT
StoreLogKeptHourlong

The retention time of logs when incremental synchronization is enabled and the incremental log pull component is Store.

1
StoreTransactionEnabledboolean

Indicates whether intra-transaction sequencing is enabled when incremental synchronization is enabled and the incremental log pull component is Store.

false
TransferStepTypestring

Valid values: STRUCT, FULL, and INCR.

STRUCT
BusinessNamestring

The business system identifier, which is optional and is a specific field of the Post message.

OMS_TEST
Stepsobject []

The detailed project steps.

StepOrderinteger

The sequence of steps.

1
StepNamestring

The step name. Valid values: 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, or CONNECTOR_INCR_SYNC.

structmigration
StepDescriptionstring

The description of the step, for example, schema migration, full migration, full verification, incremental log pull, incremental synchronization, or incremental verification.

Schema migration
StepStatusstring

The step status. Valid values: INIT, RUNNING, FAILED, FINISHED, SUSPEND, and MONITORING. The value MONITORING indicates the continuous monitoring of incremental synchronization and incremental verification.

INT
StepProgressinteger

The step progress.

10
StepInfoobject

The step details. The value is a JSON string.

JobIdstring

The job ID.

abcd
IncrTimestampCheckpointlong

The checkpoint in incremental synchronization. The value is a unix timestamp in seconds.

1
Checkpointstring

The checkpoint. The value is a unix timestamp in seconds.

1
Gmtlong

The checkpoint collection time. The value is a unix timestamp in seconds.

1
ConnectorFullProgressOverviewobject

The full synchronization progress.

EstimatedTotalCountlong

The estimated amount of data to migrate.

100
FinishedCountlong

The amount of data migrated.

50
Progressinteger

finishedCount / estimatedTotalCount

1120
EstimatedRemainingTimeOfSeclong

The estimated maximum time remained, in seconds.

100
Validatedboolean

A sub-status that indicates whether the checker has completed full verification.

true
Skippedboolean

A sub-status that indicates whether this step is skipped.

true
Inconsistencieslong

The amount of inconsistent data found during full verification.

1
DeployIdstring

The resource deployment ID.

abcd
ProcessedRecordslong

The number of migrated rows.

6
Capacitylong

The estimated total number of rows.

10
SrcRpslong

The read requests per second (RPS) of the source data source.

1
SrcRtlong

The read response time (RT) per record of the source data source, in ms.

1
SrcIopslong

The read throughput of the source data source, in bytes per second.

1
DstRpslong

The read/write RPS of the destination data source.

1
DstRtlong

The read/write RT per record of the destination data source, in ms.

1
DstIopslong

The read/write throughput of the destination data source, in bytes per second.

1
SrcRpsReflong

The read RPS baseline of the source data source.

1
SrcRtReflong

The read RT baseline of the source data source.

1
DstRpsReflong

The read/write RPS baseline of the destination data source.

1
DstRtReflong

The read/write RT baseline of the destination data source.

1
SrcIopsReflong

The read throughput baseline of the source data source.

1
ExtraInfoobject

The additional information. The value is a JSON string.

ErrorDetailsobject []

The error details.

Codestring

The error code.

200
Levelstring

Valid values: CRITICAL, ERROR, and WARN.

CRITICAL
Messagestring

The error message.

A system error occurred.
Proposalstring

The suggestions (new).

Contact the administrator.
ErrorCodestring

The error code, such as 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_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, and WORKER_INSTANCE_NOT_FOUND_FOR_USER_ERROR.

PARAMERROR
ErrorMsgstring

The error message.

A system error occurred.
ErrorParamobject

The error related parameters.

string

The error parameters.

FailedTime
FailedTimestring

The time when the error occurred.

2020-05-22T17:04:18
StartTimestring

The start time, in the format of "2020-05-22T17:04:18".

2020-05-22T17:04:18
EstimatedRemainingSecondslong

The estimated time remained.

100
FinishTimestring

The end time, in the format of "2020-05-22T17:04:18".

2020-05-22T17:04:18
Interactiveboolean

Indicates whether the current step must be confirmed by the user, rather than scheduled in the backend.

true

Examples

Sample success responses

JSONformat

{
  "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": "The name of the project.",
    "ProjectOwner": "Zhang San",
    "Labels": [
      {
        "Id": "abc",
        "Name": "label_name",
        "Creator": "Zhang San",
        "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": "INT",
        "StepProgress": 10,
        "StepInfo": {
          "JobId": "abcd",
          "IncrTimestampCheckpoint": 1,
          "Checkpoint": "1",
          "Gmt": 1,
          "ConnectorFullProgressOverview": {
            "EstimatedTotalCount": 100,
            "FinishedCount": 50,
            "Progress": 1120,
            "EstimatedRemainingTimeOfSec": 100
          },
          "Validated": true,
          "Skipped": true,
          "Inconsistencies": 1,
          "DeployId": "abcd",
          "ProcessedRecords": 6,
          "Capacity": 10,
          "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": "PARAMERROR",
          "ErrorMsg": "A system error occurred.",
          "ErrorParam": {
            "key": "FailedTime"
          },
          "FailedTime": "2020-05-22T17:04:18"
        },
        "StartTime": "2020-05-22T17:04:18",
        "EstimatedRemainingSeconds": 100,
        "FinishTime": "2020-05-22T17:04:18",
        "Interactive": true
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-02The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2022-08-19Add Operationsee changesets