首批通过分布式安全可靠测评，为关键业务系统打造
查询项目的组件信息
更新时间：2024-04-10 23:00:07
编辑
分享
本文为您介绍 OceanBase 迁移服务（OceanBase Migration Service，OMS）社区版提供的 OpenAPI：查询项目的组件信息 DescribeProjectComponents。
功能说明
本接口用于查询数据迁移或数据同步项目的组件信息。
调用说明
接口约束
本接口适用于 OMS 社区版 V4.1.1-CE 及之后版本。
请求路径
POST /api/v2?Action=DescribeProjectComponents
请求参数
| 参数 | 类型 | 描述 |
|---|---|---|
| id | string | 数据迁移或数据同步项目的 ID。 |
返回结果
| 参数 | 类型 | 描述 |
|---|---|---|
| success | boolean | 是否调用成功。 |
| errorDetail | object | 错误详情。 |
| code | string | 错误码。 |
| message | string | 描述信息。 |
| advice | string | 建议。 |
| requestId | string | 请求 ID。 |
| pageNumber | integer | 页序号，分页查询时生效。 |
| pageSize | integer | 页大小，分页查询时生效。 |
| totalCount | integer | 总数，分页查询时生效。 |
| cost | string | 请求耗时，单位为秒。 |
| data | string | 项目组件的相关信息，具体包含的信息请参见《data 数据结构》。 |
data 数据结构
参数 类型 描述 storeList array 增量拉取组件 Store。 ├─ name string Store 组件的名称。 ├─ ip string Store 组件所在的 IP 地址。 ├─ type string Store 组件的类型。 ├─ region string Store 组件所在的地域。 ├─ topic string Topic。 ├─ subtopic string Subtopic。 ├─ tps integer 每秒处理的事务数（Transactions Per Second，TPS）。 ├─ delay integer 延迟时间，单位为秒。 ├─ gmt integer 增量同步位点采集时间。 ├─ conn integer 连接数。 ├─ status string Store 组件的状态。 ├─ errorDetails array 错误详情。 ├─ toSwitch boolean 是否需要主备切换，供 HA 判断。 ├─ port integer 对外服务端口。 ├─ storePort integer Store 组件的端口。 ├─ beginCheckpoint string 开始安全位点。 ├─ endCheckpoint string 结束安全位点。 ├─ config map 配置信息。 ├─ errMsg string 当前错误信息。 ├─ gmtCreate string 创建时间，以 UTC + 0 时区的时间格式展示。 ├─ gmtModified string 更新时间，以 UTC + 0 时区的时间格式展示。 ├─ latelyHeartbeatTimeSec integer 最近一次心跳时间戳。 reverseStoreList array 反向增量拉取组件。 ├─ name string 反向增量拉取组件的名称。 ├─ ip string 反向增量拉取组件所在的 IP 地址。 ├─ type string 反向增量拉取组件的类型。 ├─ region string 反向增量拉取组件所在的地域。 ├─ topic string Topic。 ├─ subtopic string Subtopic。 ├─ tps integer 每秒处理的事务数（Transactions Per Second，TPS）。 ├─ delay integer 延迟时间。 ├─ gmt integer 增量同步位点采集时间。 ├─ conn integer 连接数。 ├─ status string 反向增量拉取组件的状态。 ├─ errorDetails array 错误详情。 ├─ toSwitch boolean 是否需要主备切换，供 HA 判断。 ├─ port integer 对外服务端口。 ├─ storePort integer Store 组件的端口。 ├─ beginCheckpoint string 开始安全位点。 ├─ endCheckpoint string 结束安全位点。 ├─ config map 配置信息。 ├─ errMsg string 当前错误信息。 ├─ gmtCreate string 创建时间，以 UTC + 0 时区的时间格式展示。 ├─ gmtModified string 更新时间，以 UTC + 0 时区的时间格式展示。 ├─ latelyHeartbeatTimeSec integer 最近一次心跳时间戳。 fullVerifyComponents array 全量校验组件 Full-Verification。 ├─ region string Full-Verification 组件所在的地域。 ├─ name string Full-Verification 组件的名称。 ├─ inconsistentQuantity integer 校验不一致的数量。 ├─ consistentQuantity integer 校验一致的数量。 ├─ progress string 表级别的进度。 ├─ recordProgress integer 记录级别的进度。 ├─ status string Full-Verification 组件的状态。 ├─ errorDetails array 错误详情。 ├─ ip string Full-Verification 组件所在的 IP。 ├─ taskId integer Full-Verification 组件的 ID。 ├─ config map 配置信息。 fullImportComponents array 全量导入组件 Full-Import。 ├─ region string Full-Import 组件所在的地域。 ├─ name string Full-Import 组件的名称。 ├─ ip string Full-Import 组件所在的 IP。 ├─ identity string 项目 ID。 ├─ type string Full-Import 组件的类型。 ├─ progress integer 进度。 ├─ status string Full-Import 组件的状态。 ├─ config map 配置信息。具体包含的信息请参见 《config 数据结构》。 ├─ gmtCreate string 创建时间，以 UTC + 0 时区的时间格式展示。 ├─ gmtModify string 修改时间，以 UTC + 0 时区的时间格式展示。 ├─ errorDetails array 错误详情。 incrSyncComponents array 增量同步组件 Incr-Sync。 ├─ region string Incr-Sync 组件所在的地域。 ├─ name string Incr-Sync 组件的名称。 ├─ ip string Incr-Sync 组件所在的 IP。 ├─ identity string 项目 ID。 ├─ type string Incr-Sync 组件的类型。 ├─ subtopics string Subtopic。 ├─ status string Incr-Sync 组件的状态。 ├─ checkpoint string 当前位点，以 UTC + 0 时区的时间格式展示。 ├─ tps integer 每秒处理的事务数（Transactions Per Second，TPS）。 ├─ delay integer 延迟时间，单位为秒。 ├─ checkpointSampleTimestamp integer 位点采集时间，单位为秒。 ├─ config map 配置信息。具体包含的信息请参见《config 数据结构》。 ├─ gmtCreate string 创建时间，以 UTC + 0 时区的时间格式展示。 ├─ gmtModify string 修改时间，以 UTC + 0 时区的时间格式展示。 ├─ errorDetails array 错误详情。 reverseIncrSyncComponents array 反向增量同步组件。 ├─ region string 反向增量同步组件所在的地域。 ├─ name string 反向增量同步组件的名称。 ├─ ip string 反向增量同步组件所在的 IP。 ├─ identity string 项目 ID。 ├─ type string 反向增量同步组件的类型。 ├─ subtopics string Subtopic。 ├─ status string 反向增量同步组件的状态。 ├─ checkpoint string 当前位点，以 UTC + 0 时区的时间格式展示。 ├─ tps integer 每秒处理的事务数（Transactions Per Second，TPS）。 ├─ delay integer 延迟时间，单位为秒。 ├─ checkpointSampleTimestamp integer 位点采集时间，单位为秒。 ├─ config map 配置信息。 ├─ gmtCreate string 创建时间，以 UTC + 0 时区的时间格式展示。 ├─ gmtModify string 修改时间，以 UTC + 0 时区的时间格式展示。 ├─ errorDetails array 错误详情。 config 数据结构
参数 类型 描述 coordinator map 详情请参见 Coordinator 组件参数说明。 condition map 详情请参见 Condition 组件参数说明。 source map 详情请参见 Source Plugin 组件参数说明。 sink map 详情请参见 Sink Plugin 组件参数说明。
示例
请求示例
{
"id":"np_4w3a****"
}
返回示例
{
"success":true,
"errorDetail":null,
"code":null,
"message":null,
"advice":null,
"requestId":"c58aa08a-****-****-9272-3a5605",
"pageNumber":null,
"pageSize":null,
"totalCount":null,
"cost":"2674 ms",
"data":{
"storeList":[
{
"name":"xxx.xxx.xxx.1-7100:MYSQL_np_4x****40_4xz45vk-1-0:0000000003",
"ip":"xxx.xxx.xxx.1",
"type":"MySQL",
"region":"default",
"topic":"MYSQL_np_4****40_4xz45vk",
"subtopic":"MYSQL_np_4xz****r40_4xzvk-1-0",
"tps":1,
"delay":0,
"gmt":1690880958,
"conn":1,
"status":"ACTIVE",
"errorDetails":null,
"toSwitch":false,
"port":17000,
"storePort":7100,
"beginCheckpoint":"2023-08-01T06:34:01",
"endCheckpoint":"2023-08-01T09:09:18",
"config":{
"mysql2store.metacenter.address":"",
"mysql2store.master.timestamp":"1690871644",
"mysql2store.master.host":"xxx.xxx.xxx.2",
"store.queue.threadPoolSize":"4",
"store.drcnet.threadPoolSize":"2",
"store.listeningPort":"17000",
"store.repStatus":"master",
"mysql2store.topic":"MYSQL_np_4x****40_4xz5vk",
"mysql2store.mysqld.metadata_builder":"./bin/metadata_builder.sh",
"mysql2store.drcServicePwd":"******",
"mysql2store.master.heartbeatperiod":"0.5",
"mysql2store.pipeline":"reset,read,parse|filter,consume",
"mysql2store.master.maxdumper":"200",
"mysql2store.mysqld.metadata_version":"0",
"mysql2store.master.readtimeout":"60",
"mysql2store.master.password":"******",
"mysql2store.master.charsetdir":"./share/charsets/",
"mysql2store.timeline.period":"80000",
"mysql2store.master.addr_list":"xxx.xxx.xxx.3:3310",
"mysql2store.rep.heartbeat.table":"heartbeat",
"mysql2store.parallelism":"1024",
"store.useThreadPool":"true",
"mysql2store.metabuilder.recovery":"false",
"mysql2store.store_bind_address":"xxx.xxx.xxx.1",
"mysql2store.master.errorretry":"86400",
"global.config.version":"3",
"mysql2store.filter.ddl":"create,drop,alter,grant,revoke,rename,truncate",
"mysql2store.master.binlog":"",
"mysql2store.master.uuid":"e3981206-****-28de5",
"mysql2store.error.level":"WARN",
"mysql2store.master.fuzzymatch":"false",
"mysql2store.master.mysql_type_list":"XCluster",
"store.drcnetListenPort":"17001",
"mysql2store.error.skipDDL":"true",
"store.writer.threshold":"1",
"mysql2store.metabuilder.filter":"false",
"mysql2store.master.fatalretry":"20",
"drc_frame.log4cpp_category":"log",
"mysql2store.metabuilder.localmysqldir":"/home/ds/alisql",
"mysql2store.master.serverid":"83****797",
"store.reader":"on",
"mysql2store.drcServiceAddr":"",
"mysql2store.metabuilder.source_metafile":".",
"mysql2store.master.timeoutretry":"20",
"mysql2store.filter.allowedtypes":"*",
"mysql2store.subId":"000****003",
"mysql2store.filter.conditions":"test.b|test.a",
"mysql2store.filter.delim":",",
"drc_frame.modules_path":"./lib64/reader/mysql-reader",
"mysql2store.filter.blacklist":"mysql.*|information_schema.*|performance_schema.*",
"mysql2store.metabuilder.log":"./meta.log",
"mysql2store.filter.ddlwhitelist":"*|{filter.conditions}",
"mysql2store.metabuilder.numOfThreads":"10",
"mysql2store.rep.heartbeat.db":"drc",
"mysql2store.master.enablestatmentmode":"false",
"mysql2store.filter.ddlblacklist":"{filter.blacklist}|test.sp:[CreateTable]",
"mysql2store.drcServiceUser":"drc",
"mysql2store.master.offset":"",
"mysql2store.subTopic":"MYSQL_np_4x****r40_4xz5vk-1-0",
"mysql2store.metabuilder.retrytype":"2003,2004,2006,2013",
"global.running.mode":"strict",
"mysql2store.master.port":"3310",
"mysql2store.metabuilder.expirestime":"504",
"store.writer.type":"message",
"drc_frame.log4cpp_cfg":"./conf/logger.conf",
"store.clearer.period":"3600",
"mysql2store.metabuilder.backupcycle":"12",
"mysql2store.mysqld.embedded_cnf":"./metadata/conf/my.cnf",
"store.client.wait":"43200",
"mysql2store.master.switchTime":"600",
"store.storesManager.port":"7100",
"mysql2store.master.check_server_id":"true",
"mysql2store.master.username":"root",
"store.connection.numLimit":"1000",
"mysql2store.mysqld.metadata_rootdir":"./metadata/meta",
"drc_frame.monitor_port":"0",
"store.clearer.outdated":"604800",
"drc_frame.modules_name":"mysql2store"
},
"errMsg":"[Tue Aug 1 14:44:17 2023] DRC_500:Store MYSQL_np_4x****r40_4xz4v5vk-1-0.0000003 started successfully\n",
"gmtCreate":"2023-08-01T06:44:06",
"gmtModified":"2023-08-01T09:09:41",
"latelyHeartbeatTimeSec":1690880980
}
],
"reverseStoreList":null,
"fullVerifyComponents":[
{
"region":"default",
"name":"xxx.xxx.xxx.1-9000:90216:0000000002",
"inconsistentQuantity":0,
"consistentQuantity":1,
"progress":"1.0",
"recordProgress":100,
"status":"DONE",
"errorDetails":null,
"ip":"xxx.xxx.xxx.1",
"taskId":90216,
"config":{
"condition.whiteCondition":"[{\"all\":false,\"sub\":[{\"name\":\"a\",\"map\":\"a\"},{\"name\":\"b\",\"map\":\"b\"}],\"name\":\"test\",\"map\":\"test\"}]",
"datasource.master.type":"MYSQL",
"datasource.timezone":"+08:00",
"rectifier.image.enable":"false",
"filter.master.blacklist":"",
"limitator.reviewer.time.max":"60",
"sampler.verify.ratio":"100",
"limitator.datasource.connections.max":"50",
"filter.master.whitelist":"*.*",
"limitator.reviewer.review.batch.max":"100",
"limitator.select.batch.max":"1200",
"datasource.master.address":"xxx.xxx.xxx.1:3310",
"datasource.image.username":"root@oms#ob_100****29.admin",
"task.type":"VERIFY",
"force.split.by.rowid":"false",
"limitator.resume.verify.fromkeys":"false",
"mapper.from_master_to_image.list":"",
"datasource.master.password":"******",
"limitator.reviewer.rounds.max":"20",
"limitator.table.diff.max":"10000",
"limitator.table.nonunique.max":"5000000",
"datasource.master.region":"",
"limitator.reviewer.period":"3",
"rectifier.image.operator.update":"false",
"rectifier.image.operator.insert":"false",
"datasource.image.address":"xxx.xxx.xxx.4:2888",
"limitator.datasource.image.ob10freememory.min":"20",
"rectifier.image.operator.delete":"false",
"limitator.platform.threads.number":"32",
"task.split.mode":"false",
"datasource.image.password":"******",
"datasource.image.type":"OB10",
"task.checker_jvm_param":"-server -Xms16g -Xmx16g -Xmn8g -Xss512k",
"datasource.image.region":"",
"datasource.master.username":"root"
}
}
],
"fullImportComponents":[
{
"region":"default",
"name":"xxx.xxx.xxx.1-9000:connector_v2:np_4xz****40-full_trans-1-0:0000000004",
"ip":"xxx.xxx.xxx.1",
"identity":"np_4x****",
"type":"FULL_TRANS",
"progress":100,
"status":"FINISHED",
"config":{
"coordinator":{
"enableMetricReportTask":false,
"taskIdentity":"np_4x*****",
"enableOmsConnectorV2Report":true,
"customizeClass":"com.oceanbase.oms.connector.fullcustomize.FullFrameworkCustomize",
"sourceType":"MYSQL",
"timezone":"+08:00",
"enableActiveReportTask":false,
"taskSubId":1,
"checkDstTableEmpty":true,
"sinkType":"OB_MYSQL",
"connectorJvmParam":"-server -Xms8g -Xmx8g -Xmn4g -Xss512k"
},
"condition":{
"whiteCondition":[
{
"all":false,
"sub":[
{
"name":"a",
"map":"a"
},
{
"name":"b",
"map":"b"
}
],
"name":"test",
"map":"test"
}
]
},
"source":{
"boosterClass":"com.oceanbase.oms.connector.source.dataflow.DataFlowSourceBooster",
"clients":[
{
"password":"******",
"clientId":"jdbc:mysql://xxx.xxx.xxx.2:3310?useUnicode=true&characterEncoding=utf8&allowLoadLocalInfile=false&autoDeserialize=false&allowLocalInfile=false&allowUrlInLocalInfile=false&useSSL=false&allowPublicKeyRetrieval=true",
"instance":"xxx.xxx.xxx.3:3310",
"username":"root"
}
],
"sliceBatchSize":600,
"sliceWorkerNum":8,
"timezone":"+08:00",
"filterTmpTable":true,
"dbType":"MYSQL",
"databaseMaxConnection":50,
"jar":"connector-dataflow.jar",
"workerNum":8,
"taskResume":false,
"type":"DATAFLOW_SOURCE"
},
"sink":{
"boosterClass":"com.oceanbase.oms.connector.jdbc.sink.obmysql.OBMySQLJDBCSinkBooster",
"enableNoUniqueConstraintTableReplicate":true,
"sysInstance":"xxx.xxx.xxx.5:2888",
"timezone":"+08:00",
"isPreLoadAllTableSchema":false,
"type":"JDBC_SINK_OB_MYSQL",
"password":"******",
"sysUsername":"root@sys#ob_10088109129.admin",
"jdbcUrl":"jdbc:mysql://xxx.xxx.xxx.5:2888?useUnicode=true&allowMultiQueries=true&socketTimeout=50000&characterEncoding=utf8&readOnlyPropagatesToServer=false",
"enablePartitionBucket":true,
"jar":"jdbc-sink-ob-mysql.jar",
"workerNum":8,
"sysPassword":"******",
"username":"root@oms#ob_100****29.admin"
}
},
"gmtCreate":"2023-08-01T06:45:14",
"gmtModify":"2023-08-01T06:45:32",
"errorDetails":null
}
],
"incrSyncComponents":[
{
"region":"default",
"name":"xxx.xxx.xxx.1-9000:connector_v2:np_4x*****sr-incr_trans-1-0:0000000005",
"ip":"xxx.xxx.xxx.1",
"identity":"np_4x*****sr",
"type":"INCR_TRANS",
"subtopics":[
"MYSQL_np_4x*****sr_4xz4z****k-1-0"
],
"status":"RUNNING",
"checkpoint":"2023-08-01T09:09:37",
"tps":0,
"delay":2,
"checkpointSampleTimestamp":1690880978,
"config":{
"coordinator":{
"enableMetricReportTask":false,
"taskIdentity":"np_4x*****sr",
"enableOmsConnectorV2Report":true,
"isCaseSensitive":false,
"sourceType":"MYSQL",
"mysqlExplicitDefaultsForTimestamp":"ON",
"timezone":"+08:00",
"enableActiveReportTask":false,
"sinkType":"OB_MYSQL",
"allowRecordTypes":null,
"mysqlVersion":"8.0.28",
"connectorJvmParam":"-Xms2048m -Xmx2048m -Xmn1024m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=128m -XX:+UseConcMarkSweepGC -XX:+UseParNewGC -XX:+CMSParallelRemarkEnabled -XX:+UseCMSInitiatingOccupancyOnly -XX:CMSInitiatingOccupancyFraction=70 -XX:+CMSClassUnloadingEnabled"
},
"condition":{
"blackCondition":[
{
"all":false,
"sub":[
{
"func":"fn",
"name":"DRC_TXN*"
},
{
"func":"fn",
"name":"drc_txn*"
}
],
"func":"fn",
"name":"test",
"map":"test"
}
],
"whiteCondition":[
{
"all":false,
"sub":[
{
"name":"a",
"map":"a"
},
{
"name":"b",
"map":"b"
}
],
"name":"test",
"map":"test"
}
]
},
"source":{
"checkpoint":{
"MYSQL_np_4x*****sr_4xz4z****k-1-0":"1690872244"
},
"boosterClass":"com.oceanbase.oms.connector.source.store.MultiStoreSourceBooster",
"password":"******",
"clients":[
{
"clientId":"MYSQL_np_4x*****sr_4xz4z****k-1-0",
"clusterManagerUrl":"http://xxx.xxx.xxx.1:8088",
"subtopic":"MYSQL_np_4x*****sr_4xz4z****k-1-0"
}
],
"dbVersion":"8.0.28",
"timezone":"+08:00",
"dbType":"MYSQL",
"jar":"connector-source-store.jar",
"type":"STORE_SOURCE",
"ignoreDdl":true,
"username":"RM_oms"
},
"sink":{
"boosterClass":"com.oceanbase.oms.connector.jdbc.sink.obmysql.OBMySQLJDBCSinkBooster",
"password":"******",
"enableNoUniqueConstraintTableReplicate":true,
"timezone":"+08:00",
"jdbcUrl":"jdbc:mysql://xxx.xxx.xxx.3:2888?useUnicode=true&allowMultiQueries=true&socketTimeout=50000&characterEncoding=utf8&readOnlyPropagatesToServer=false",
"jar":"jdbc-sink-ob-mysql.jar",
"isPreLoadAllTableSchema":false,
"workerNum":64,
"type":"JDBC_SINK_OB_MYSQL",
"username":"root@oms#ob_10****29.admin"
}
},
"gmtCreate":"2023-08-01T06:45:40",
"gmtModify":"2023-08-01T06:45:47",
"errorDetails":null
}
],
"reverseIncrSyncComponents":null
}
}
