DescribeProjectComponents

This topic describes the DescribeProjectComponents API provided by OceanBase Migration Service (OMS).

Purpose

You can call this operation to query information about components in a data migration or synchronization task.

Call description

Limitations

This operation is supported in OMS V4.1.0 and later.

Request path

POST /api/v2?Action=DescribeProjectComponents

Request parameters

Response parameters

• Parameters in data

  Parameter	Type	Description
  storeList	array	The Store component.
  ├─ name	string	The name of the Store component.
  ├─ ip	string	The IP address of the server where the Store component resides.
  ├─ region	string	The region where the Store component resides.
  ├─ topic	string	The name of the message queue topic.
  ├─ subtopic	string	The name of the message queue subtopic.
  ├─ tps	integer	The transactions per second (TPS).
  ├─ delay	integer	The delay, in seconds.
  ├─ gmt	integer	The sampling time of the incremental synchronization timestamp.
  ├─ conn	integer	The number of connections.
  ├─ status	string	The status of the Store component.
  ├─ errorDetails	array	The error details.
  ├─ toSwitch	boolean	Indicates whether a primary/standby switchover is required for high availability (HA) judgment.
  ├─ port	integer	The external service port.
  ├─ storePort	integer	The port of the Store component.
  ├─ beginCheckpoint	string	The start security checkpoint.
  ├─ endCheckpoint	string	The end security checkpoint.
  ├─ config	map	The configuration information.
  ├─ errMsg	string	The error message.
  ├─ gmtCreate	string	The time when the component was created, which is presented in the UTC+0 time zone.
  ├─ gmtModified	string	The time when the component was updated, which is presented in the UTC+0 time zone.
  ├─ latelyHeartbeatTimeSec	integer	The last heartbeat timestamp.
  reverseStoreList	array	The reverse incremental pull component.
  ├─ name	string	The name of the reverse incremental pull component.
  ├─ ip	string	The IP address of the server where the reverse incremental pull component resides.
  ├─ region	string	The region where the reverse incremental pull component resides.
  ├─ topic	string	The name of the message queue topic.
  ├─ subtopic	string	The name of the message queue subtopic.
  ├─ tps	integer	The TPS.
  ├─ delay	integer	The delay.
  ├─ gmt	integer	The sampling time of the incremental synchronization timestamp.
  ├─ conn	integer	The number of connections.
  ├─ status	string	The status of the reverse incremental pull component.
  ├─ errorDetails	array	The error details.
  ├─ toSwitch	boolean	Indicates whether a primary/standby switchover is required for HA judgment.
  ├─ port	integer	The external service port.
  ├─ storePort	integer	The port of the Store component.
  ├─ beginCheckpoint	string	The start security checkpoint.
  ├─ endCheckpoint	string	The end security checkpoint.
  ├─ config	map	The configuration information.
  ├─ errMsg	string	The error message.
  ├─ gmtCreate	string	The time when the component was created, which is presented in the UTC+0 time zone.
  ├─ gmtModified	string	The time when the component was updated, which is presented in the UTC+0 time zone.
  ├─ latelyHeartbeatTimeSec	integer	The last heartbeat timestamp.
  fullVerifyComponents	array	The Full-Verification component.
  ├─ region	string	The region where the Full-Verification component resides.
  ├─ name	string	The name of the Full-Verification component.
  ├─ inconsistentQuantity	integer	The number of inconsistent data entries.
  ├─ consistentQuantity	integer	The number of consistent data entries.
  ├─ progress	string	The table-level verification progress.
  ├─ recordProgress	integer	The record-level verification progress.
  ├─ status	string	The status of the Full-Verification component.
  ├─ errorDetails	array	The error details.
  ├─ ip	string	The IP address of the server where the Full-Verification component resides.
  ├─ taskId	integer	The ID of the Full-Verification component.
  ├─ config	map	The configuration information.
  fullImportComponents	array	The Full-Import component.
  ├─ region	string	The region where the Full-Import component resides.
  ├─ name	string	The name of the Full-Import component.
  ├─ ip	string	The IP address of the server where the Full-Import component resides.
  ├─ identity	string	The task ID.
  ├─ progress	integer	The import progress.
  ├─ status	string	The status of the Full-Import component.
  ├─ config	map	The configuration information. For more information, see the "Parameters in config" section of this topic.
  ├─ gmtCreate	string	The time when the component was created, which is presented in the UTC+0 time zone.
  ├─ gmtModify	string	The time when the component was modified, which is presented in the UTC+0 time zone.
  ├─ errorDetails	array	The error details.
  incrSyncComponents	array	The Incr-Sync component.
  ├─ region	string	The region where the Incr-Sync component resides.
  ├─ name	string	The name of the Incr-Sync component.
  ├─ ip	string	The IP address of the server where the Incr-Sync component resides.
  ├─ identity	string	The task ID.
  ├─ subtopics	string	The name of the message queue subtopic.
  ├─ status	string	The status of the Incr-Sync component.
  ├─ checkpoint	string	The current timestamp, which is presented in the UTC+0 time zone.
  ├─ tps	integer	The TPS.
  ├─ delay	integer	The delay, in seconds.
  ├─ checkpointSampleTimestamp	integer	The checkpoint sampling time. The value is a timestamp in seconds.
  ├─ config	map	The configuration information. For more information, see the "Parameters in config" section of this topic.
  ├─ gmtCreate	string	The time when the component was created, which is presented in the UTC+0 time zone.
  ├─ gmtModify	string	The time when the component was modified, which is presented in the UTC+0 time zone.
  ├─ errorDetails	array	The error details.
  reverseIncrSyncComponents	array	The reverse incremental synchronization component.
  ├─ region	string	The region where the reverse incremental synchronization component resides.
  ├─ name	string	The name of the reverse incremental synchronization component.
  ├─ ip	string	The IP address of the server where the reverse incremental synchronization component resides.
  ├─ identity	string	The task ID.
  ├─ subtopics	string	The name of the message queue subtopic.
  ├─ status	string	The status of the reverse incremental synchronization component.
  ├─ checkpoint	string	The current timestamp, which is presented in the UTC+0 time zone.
  ├─ tps	integer	The TPS.
  ├─ delay	integer	The delay, in seconds.
  ├─ checkpointSampleTimestamp	integer	The checkpoint sampling time. The value is a timestamp in seconds.
  ├─ config	map	The configuration information.
  ├─ gmtCreate	string	The time when the component was created, which is presented in the UTC+0 time zone.
  ├─ gmtModify	string	The time when the component was modified, which is presented in the UTC+0 time zone.
  ├─ errorDetails	array	The error details.

• Parameters in config

  Parameter	Type	Description
  Coordinator	map	The configuration path of the Coordinator is conf/coordinator.json.
  condition	map	The configuration path of the Condition module is conf/condition.json.
  source	map	The configuration path of source plug-ins is conf/source.json. Each configuration class has a config key.
  sink	map	The configuration path of sink plug-ins is conf/sink.json. Each configuration class has a config key.

Examples

Sample request

{
    "id":"np_4w3a****"
}

Sample response

{
    "success":true,
    "errorDetail":null,
    "code":null,
    "message":null,
    "advice":null,
    "requestId":"a7b57****",
    "pageNumber":null,
    "pageSize":null,
    "totalCount":null,
    "cost":"27 ms",
    "data":{
        "storeList":[
            {
                "name":"xxx.xxx.xxx.1-7145:OB_ORACLE_np_4w3r***_4w:0000***97",
                "ip":"xxx.xxx.xxx.1",
                "region":"cn-anhui",
                "topic":"OB_ORACLE_np_4w3r29c_4w3****",
                "subtopic":"OB_ORACLE_np_4w3***c_4w3**-0",
                "tps":0,
                "delay":1,
                "gmt":1689250049,
                "conn":1,
                "status":"ACTIVE",
                "errorDetails":null,
                "toSwitch":false,
                "port":2883,
                "storePort":2882,
                "beginCheckpoint":"2023-07-13T09:19:53",
                "endCheckpoint":"2023-07-13T12:07:27",
                "config":null,
                "errMsg":null,
                "gmtCreate":"2023-07-13T17:29:54",
                "gmtModified":"2023-07-13T20:07:51",
                "latelyHeartbeatTimeSec":1689250071
            }
        ],
        "reverseStoreList":null,
        "fullVerifyComponents":null,
        "fullImportComponents":[
            {
                "region":"cn-anhui",
                "name":"xxx.xxx.xxx.1-9000:connector_v2:np_4w***6io-full_trans-1-0:0000002860",
                "ip":"xxx.xxx.xxx.1",
                "identity":"np_4w3r****",
                "progress":100,
                "status":"FINISHED",
                "config":{
                    "coordinator":{
                        "enableMetricReportTask": false,
                        "taskIdentity": "np_4wl****o",
                        "enableOmsConnectorV2Report": true,
                        "customizeClass": "com.oceanbase.oms.connector.fullcustomize.FullFrameworkCustomize",
                        "sourceType": "OB_MYSQL",
                        "timezone": "+08:00",
                        "enableActiveReportTask": false,
                        "taskSubId": 1,
                        "checkDstTableEmpty": false,
                        "sinkType": "DB2_LUW",
                        "connectorJvmParam": "-server -Xms8g -Xmx8g -Xmn4g -Xss512k"
                    },
                    "condition":{
                        "whiteCondition": [
                            {
                                "all": false,
                                "sub": [
                                    {
                                        "name": "aatest",
                                        "map": "aatest_"
                                    },
                                    {
                                        "name": "act_re_procdef",
                                        "map": "act_re_procdef_"
                                    }
                                ],
                                "name": "oms_mysql.tion****77",
                                "map": "GRATIO*****F115"
                            }
                        ]
                    },
                    "source":{
                        "boosterClass": "com.oceanbase.oms.connector.source.dataflow.DataFlowSourceBooster",
                        "clients": [
                            {
                                "cluster": "ob_10088109129.admin",
                                "password": "******",
                                "clientId": "jdbc:oceanbase://xxx.xxx.xxx.1:2883?useUnicode=true&characterEncoding=utf8&sendConnectionAttributes=false&allowLoadLocalInfile=false&autoDeserialize=false&allowLocalInfile=false&allowUrlInLocalInfile=false&useSSL=false&allowPublicKeyRetrieval=true-ob_100***9129.admin-oms_mysql",
                                "instance": "xxx.xxx.xxx.1:2883",
                                "tenant": "oms_mysql",
                                "username": "oms3***obmysql@oms_mysql#ob_100881****9.admin"
                            }
                        ],
                        "sliceBatchSize": 600,
                        "sliceWorkerNum": 8,
                        "timezone": "+08:00",
                        "filterTmpTable": true,
                        "dbType": "OB_MYSQL",
                        "databaseMaxConnection": 50,
                        "jar": "connector-dataflow.jar",
                        "workerNum": 8,
                        "taskResume": false,
                    },
                    "sink":{
                        "boosterClass": "com.oceanbase.oms.connector.jdbc.sink.db2.DB2JDBCSinkBooster",
                        "password": "******",
                        "enableNoUniqueConstraintTableReplicate": false,
                        "timezone": "+08:00",
                        "jdbcUrl": "jdbc:db2://xxx.xxx.xxx.1:2883/omsdb",
                        "jar": "jdbc-sink-db2.jar",
                        "workerNum": 8,
                        "username": "username"
                    }
                },
                "gmtCreate":"2023-07-13T17:31:29",
                "gmtModify":"2023-07-13T18:04:36",
                "errorDetails":null
            }
        ],
        "incrSyncComponents":null,
        "reverseIncrSyncComponents":null
    }
}