跳转至

Oracle Agent Web API v3.0.12

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

管理参数配置,管理运行实例启停状态,迁移接口以及一些辅助工具

Base URLs:

Email: Support

export

控制运行实例

启动实例(可初始化Oracle节点信息)

POST /export/start

Body parameter

{
  "host": "10.0.10.169",
  "port": 1521,
  "database": "orcl",
  "username": "agent1",
  "password": "agent1",
  "dpToken": "9lK2YSFlp2XU/pfrdvWd4ublEKFTIM3qdAY/l47x69GawPZjH343e7mNU+86XcIkE0X4uoajqOidgEEjrUIN3g==",
  "oragentConfig": {
    "uniqueId": 10,
    "mode": "RAW",
    "host": "10.0.10.169",
    "port": 1521,
    "connectionString": "10.0.10.169:1521:+ASM",
    "asmUser": "agentasm",
    "asmPassword": 123456,
    "bigEndian": false
  }
}

Parameters

Name In Type Required Description
reset query string false 启动前重置, 读取起始点设置成 latest/earliest/timestamp 归档日志位置
time query string false 起始点时间戳
body body OracleNodeConfig false Oracle节点信息(包含许可证)
host body string(ip) false 地址
port body integer(int32) false 端口
database body string false 数据库
username body string false 用户名
password body string false 密码
dpToken body string false 许可证
oragentConfig body OragentConfig false agent配置
» uniqueId body integer(int32) false ID
» mode body string false 读取模式
» host body string(ip) false 地址
» port body integer(int32) false 端口
» connectionString body string false JDBC连接串
» asmUser body string false ASM用户
» asmPassword body string false ASM密码
» bigEndian body boolean false 大小端

Enumerated Values

Parameter Value
reset earliest
reset latest
reset time
» mode RAW
» mode DB
» mode ASM

Responses

Status Meaning Description Schema
200 OK 启动该实例 None
400 Bad Request 许可证过期 None
409 Conflict 实例已在运行中/发生错误 None
500 Internal Server Error 启动失败 None

停止实例

POST /export/stop

Responses

Status Meaning Description Schema
200 OK 停止成功 None
404 Not Found 无实例存在 None

清除运行数据

POST /export/clean

删除了中断点信息及残留本地缓存及程勋运行日志。必须要在实例停止的情况下运行。相当于运行 ./clean.sh.

Responses

Status Meaning Description Schema
200 OK 清除成功 None
409 Conflict 实例还在运行 None

获取Oracle节点信息

GET /export/config

Responses

Status Meaning Description Schema
200 OK 节点信息(包含许可证) None
404 Not Found 找不到对应配置 None

校验配置信息

GET /export/config/validation

Body parameter

{
  "host": "10.0.10.169",
  "port": 1521,
  "database": "orcl",
  "username": "agent1",
  "password": "agent1",
  "dpToken": "9lK2YSFlp2XU/pfrdvWd4ublEKFTIM3qdAY/l47x69GawPZjH343e7mNU+86XcIkE0X4uoajqOidgEEjrUIN3g==",
  "oragentConfig": {
    "uniqueId": 10,
    "mode": "RAW",
    "host": "10.0.10.169",
    "port": 1521,
    "connectionString": "10.0.10.169:1521:+ASM",
    "asmUser": "agentasm",
    "asmPassword": 123456,
    "bigEndian": false
  }
}

Parameters

Name In Type Required Description
privsOnly query boolean false 仅校验权限,不校验 Kafka 及 ASM 配置
body body OracleNodeConfig true Oracle节点信息
host body string(ip) false 地址
port body integer(int32) false 端口
database body string false 数据库
username body string false 用户名
password body string false 密码
dpToken body string false 许可证
oragentConfig body OragentConfig false agent配置
» uniqueId body integer(int32) false ID
» mode body string false 读取模式
» host body string(ip) false 地址
» port body integer(int32) false 端口
» connectionString body string false JDBC连接串
» asmUser body string false ASM用户
» asmPassword body string false ASM密码
» bigEndian body boolean false 大小端

Enumerated Values

Parameter Value
» mode RAW
» mode DB
» mode ASM

Responses

Status Meaning Description Schema
200 OK 校验通过 None
500 Internal Server Error 校验未通过 None

设置许可证

POST /export/license

Body parameter

9lK2YSFlp2XU/pfrdvWd4ublEKFTIM3qdAY/l47x69GawPZjH343e7mNU+86XcIkE0X4uoajqOidgEEjrUIN3g==

Responses

Status Meaning Description Schema
200 OK 更新成功 None
400 Bad Request 非法许可证 None

实例健康状态

GET /export/health

Example responses

200 Response

{
  "status": "UP",
  "checks": [
    {
      "id": 1,
      "status": "string",
      "data": {
        "id": 1,
        "deployment-id": "58c67b73-ba1a-4a92-b229-9c42086a472a",
        "delay-sec": 2,
        "system": "string",
        "err": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK 返回健康状态 Health

设置起始点

POST /export/savepoint

Body parameter

[
  {
    "thr": 0,
    "seq": 0,
    "cbk": 0,
    "cbo": 0,
    "lwn_block_num": 0,
    "name": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK 成功更新起点 None
400 Bad Request 更新起点失败 None

当前起点

GET /export/savepoint

Example responses

200 Response

"RAC:1 SEQ:10709 BLK:8616 BKO:0 LBK:8616 LSC:1183982414"

Responses

Status Meaning Description Schema
200 OK 当前起点 string
404 Not Found 起点不存在 None

设置监听表

POST /export/tables

Body parameter

[
  "OWNER.TABLE"
]

Responses

Status Meaning Description Schema
200 OK 更新成功(无变化) None
201 Created 更新成功(有变化) None

获取监听表

GET /export/tables

Example responses

200 Response

"map:\n  ts: 1657356113010\n  map:\n  - table: OWNER.TABLE"

Responses

Status Meaning Description Schema
200 OK 监听表 string

依照给定的配置和进度信息恢复 Agent

POST /export/config/recover

Body parameter

{
  "mapConfig": {
    "map.ts": 1667269111284,
    "map.map": [
      {
        "table": "OWNER.TABLE"
      }
    ]
  },
  "srcConfig": {
    "src": {
      "id": 1,
      "login": "DP_TEST/123456@192.168.0.14:1521/orcl"
    },
    "dp_token": "8qQvIp26WZh05LcX+H8uDj5JLPCtkCAAa4apNb0dnXPqjikCA9NXwZmBF+pCAPvSyF+U6PQ+fUO1TQnGVzSKFS76ldmwPjOtOCvpXSQERb4=",
    "asm.login": "/as sysdba",
    "asm.oracle_home": "",
    "asm.oracle_sid": "",
    "asm.mode": "db",
    "asm.exadata": false,
    "asm.subAsm": []
  },
  "paramConfig": {
    "param.channel": "kafka",
    "param.kafka": {
      "bootstrap.servers": "kafkazc:9092",
      "schema.registry.url": "http://192.168.0.31:8081",
      "acks": "1"
    },
    "param.charset1": "gbk",
    "param.charset2": "utf-16",
    "param.charset_clob": "gbk",
    "param.port": 8998,
    "param.offmore": false,
    "param.change_interval_sec": 1,
    "param.map_update_timeout_sec": 300,
    "param.retry_backoff_ms": 10000,
    "param.print_objno": [],
    "param.print_level": 1,
    "param.print_detail_cooldown_ms": 3000,
    "param.print_cost": false,
    "param.print_merge": false,
    "param.print_large_tx_threshold": "10m",
    "param.min_diskspace": "10g",
    "param.delete_trans_if_low_diskspace": false,
    "param.out_mb": 20,
    "param.conv_parallelism": 0,
    "param.producer_num": 1,
    "param.cpu_limit": 0,
    "param.deal_byte_rate": 0,
    "param.conv_byte_rate": 0,
    "param.supplemental_all_only": false,
    "param.auto_reset_policy": "none",
    "param.filter_ahead": true,
    "param.direct_local": true,
    "param.legacy_view": false,
    "param.legacy_format": false,
    "param.skip_error": true,
    "param.ignore_255_update": false,
    "param.save_on_quit": false,
    "param.skip_merge_fail": true,
    "param.lag_barrier": -1,
    "param.local_mode": "none",
    "param.local_mode_all": true,
    "param.os": "linux",
    "param.lx": false,
    "param.aix_stat_size_off": -1,
    "param.record_head_len": -1
  },
  "safeScn": 1265702183
}

Parameters

Name In Type Required Description
body body RecoverConfig true none
mapConfig body object false none
srcConfig body object false none
paramConfig body object false none
safeScn body integer(int64) false none

Responses

Status Meaning Description Schema
200 OK 成功地恢复配置及进度,并重启 Agent 实例 None
500 Internal Server Error 恢复时遇到异常或未成功重启 Agent 实例 None

param

控制运行参数

获取单个参数值

GET /param/{key}

Parameters

Name In Type Required Description
key path string true 参数名

Example responses

200 Response

50

Responses

Status Meaning Description Schema
200 OK 值 string
404 Not Found 不存在 None

更新单个参数值

PUT /param/{key}

Body parameter

50

Parameters

Name In Type Required Description
key path string true 参数名

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK 更新成功 string
400 Bad Request 非法参数或值 None

获取(某类)参数

GET /params/{type}

Parameters

Name In Type Required Description
type path string true 参数类型

Enumerated Values

Parameter Value
type data-output
type logging
type environment
type resource-limit
type error-handling
type performance
type others

Example responses

200 Response

"{\n  \"cpu_limit\": 50,\n  \"memory_limit\": 50\n}"

Responses

Status Meaning Description Schema
200 OK 所有参数 properties 格式 string

更新(某类)参数

PUT /params/{type}

Body parameter

|-
{
  "cpu_limit": 50,
  "memory_limit": 50
}

Parameters

Name In Type Required Description
type path string true 参数类型

Enumerated Values

Parameter Value
type data-output
type logging
type environment
type resource-limit
type error-handling
type performance
type others

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK 更新成功 string
400 Bad Request 非法参数或值 None

tools

工具 API

重启运行时进程(JVM)

POST /tools/restart

Responses

Status Meaning Description Schema
200 OK 执行重启 None

查看 log/export.log 日志

GET /tools/view/log

Parameters

Name In Type Required Description
head query integer false 头几行
tail query integer false 尾几行
keyword query string false 关键字,支持 regex

Example responses

200 Response

"[{\"thr\":1,\"seq\":10728,\"name\":\"/u01/app/oracle/oradata/orcl/redo02.log\",\"resetlog_no\":1408558}]"

Responses

Status Meaning Description Schema
200 OK startScn 对应所在 Redo logs. string

升级 agent

POST /tools/upgrade/{secret}

Body parameter

file: string

Parameters

Name In Type Required Description
secret path string true 升级密钥
file body string(binary) true none

Responses

Status Meaning Description Schema
200 OK 升级成功 None
403 Forbidden 非法密钥 None
500 Internal Server Error 升级失败 None

回滚 agent

POST /tools/rollback/{secret}

Parameters

Name In Type Required Description
secret path string true 回滚密钥

Responses

Status Meaning Description Schema
200 OK 回滚成功 None
403 Forbidden 非法密钥 None
500 Internal Server Error 回滚失败 None

调整 root logger 打印级别

PUT /tools/loglevel/{level}

Parameters

Name In Type Required Description
level path string true 打印级别

Enumerated Values

Parameter Value
level INFO
level ERROR
level TRACE
level DEBUG
level WARN

Responses

Status Meaning Description Schema
200 OK 设置成功 None

获取 scn

GET /tools/scn

如果提供 time 参数,则返回该事件对应的 scn,否则返回当前 scn

Parameters

Name In Type Required Description
time query string false 该时间对应的scn

Example responses

200 Response

1186387875

Responses

Status Meaning Description Schema
200 OK scn integer

获取该 scn 对应所在 Redo logs.

GET /tools/logs

Parameters

Name In Type Required Description
startScn query integer true scn

Example responses

200 Response

"[{\"thr\":1,\"seq\":10728,\"name\":\"/u01/app/oracle/oradata/orcl/redo02.log\",\"resetlog_no\":1408558}]"

Responses

Status Meaning Description Schema
200 OK startScn 对应所在 Redo logs. string

打包下载 log(日志) 或者 dict(数据字典) 文件

POST /tools/download/{type}

Body parameter

{
  "wild": "*export.log.2022-10*",
  "start": "2022-10-10T10:10:10.000Z",
  "end": "2022-10-10T10:10:10.000Z",
  "tar": true
}

Parameters

Name In Type Required Description
type path string true 文件类型,只能是 log 或者 dict,代表日志和数据字典文件
body body FindFileRequest false 文件查找条件
wild body string false 文件名通配符,必须包含 .log 或者 .json
start body string(date-time) false 最小文件修改时间(ISO8601),默认为最小值
end body string(date-time) false 最大文件修改时间(ISO8601), 默认为最大值
tar body boolean false 是否打包,否的话只传第一个文件

Enumerated Values

Parameter Value
type log
type dict

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK 文件 string

migrate

迁移时获取旧 agent 的配置和进度等信息

根据给定的旧 agent 部署路径获取配置信息

GET /migrate/legacy/config

Parameters

Name In Type Required Description
path query string true 旧 agent 部署路径

Example responses

200 Response

{
  "src_id": "1",
  "src_login": "DP_TEST/123456@dn-oracle-source:1521/ORCL",
  "param_exadata": "0",
  "asm_login": "agentasm as sysdba/agentasm@//10.10.10.20:1521/+ASM",
  "asm_oracle_sid": "+ASM1",
  "asm_oracle_home": "/u01/app/19.0/grid",
  "asm_mode": "RAW",
  "asm_device_id": "1 , 2 , 3",
  "asm_disk": "/dev/asm-diskc , /dev/asm-diskd , /dev/asm-diske",
  "asm_dev": "/dev/sdb1 , /dev/sdb2 , /dev/sdb3"
}

Responses

Status Meaning Description Schema
200 OK 旧 agent 配置信息 LegacyConfig

根据给定的旧 agent 部署路径获取 Savepoint

GET /migrate/legacy/{srcId}/savepoint

Parameters

Name In Type Required Description
srcId path integer true none
path query string true 旧 agent 部署路径

Example responses

200 Response

[
  {
    "thr": 0,
    "seq": 0,
    "cbk": 0,
    "cbo": 0,
    "lwn_block_num": 0
  }
]

Responses

Status Meaning Description Schema
200 OK 旧 agent 的 Savepoint Inline

Response Schema

Status Code 200

各个 Thread 对应的 Savepoint

Name Type Required Restrictions Description
anonymous [Savepoint] false none 各个 Thread 对应的 Savepoint
» thr integer(int32) false none 线程 ID
» seq integer(int64) false none 日志文件号
» cbk integer(int64) false none 当前块号
» cbo integer false none 当前块偏移量
» lwn_block_num integer(int64) false none 下一个 lwn 的开始位置

根据给定的旧 agent 部署路径获取事务列表

GET /migrate/legacy/{srcId}/translist

Parameters

Name In Type Required Description
srcId path integer true none
path query string true 旧 agent 部署路径

Example responses

200 Response

[
  {
    "trans_id": 0,
    "scn_bgn0": 0,
    "scn_bgn": {
      "scn": 0,
      "scn_sub": 0,
      "len": 10
    },
    "scn": {
      "scn": 0,
      "scn_sub": 0,
      "len": 10
    },
    "scn_max": {
      "scn": 0,
      "scn_sub": 0,
      "len": 10
    },
    "scn_time_bgn": 0,
    "scn_time": {
      "value": 0
    },
    "scn_time_max": 0,
    "thread_id": 0,
    "uba": 0,
    "dba": 0,
    "slt": 0,
    "rba": 0,
    "is_ddl": 0,
    "is_cmted": true,
    "changed": 0,
    "cached_len": 0,
    "total_len": 0,
    "flag": 0,
    "cur_fno": 0,
    "max_fno": 0
  }
]

Responses

Status Meaning Description Schema
200 OK 旧 agent 的事务列表 Inline

Response Schema

Status Code 200

事务信息

Name Type Required Restrictions Description
anonymous [Trans] false none 事务信息
» trans_id integer(int64) false none 事务 ID
» scn_bgn0 integer(int64) false none 起始 SCN
» scn_bgn Scn false none none
»» scn integer(int64) false none none
»» scn_sub integer(short) false none none
»» len integer(int32) false none none
» scn Scn false none none
» scn_max Scn false none none
» scn_time_bgn integer(int64) false none 起始 SCN 时间
» scn_time object false none none
»» value integer(int64) false none SCN 时间值
» scn_time_max integer(int64) false none 最大 SCN 时间
» thread_id integer(int32) false none 线程 ID
» uba integer(int64) false none Undo 块地址
» dba integer(int64) false none 数据块地址
» slt integer(int32) false none none
» rba integer(int64) false none Redo 块地址
» is_ddl integer(int32) false none 是否是 DDL
» is_cmted boolean false none 是否 commit
» changed integer(int64) false none none
» cached_len integer(int64) false none 缓存长度
» total_len integer(int64) false none 总长度
» flag integer(int32) false none 标志位
» cur_fno integer(int32) false none 当前缓存文件序号
» max_fno integer(int32) false none 最大缓存文件序号

根据给定的旧 agent 部署路径获取事务的最早 SCN 值

GET /migrate/legacy/{srcId}/translist/scn

Parameters

Name In Type Required Description
srcId path integer true none
path query string true 旧 agent 部署路径

Example responses

200 Response

[
  0
]

Responses

Status Meaning Description Schema
200 OK 旧 agent 最早 SCN 值的列表 Inline

Response Schema

Status Code 200

最早 SCN 值

Name Type Required Restrictions Description

admin

管理员命令

获取 log 文件列表

GET /admin/logs

Example responses

200 Response

[
  "export.log.2022-10-10"
]

Responses

Status Meaning Description Schema
200 OK 文件列表 Inline

Response Schema

选择多个文件名并打包下载

POST /admin/logs/download

Body parameter

[
  "export.log.2022-10-10"
]

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK 日志打包文件 string

获取 log 文件内容

GET /admin/logs/{name}

Parameters

Name In Type Required Description
name path string true 文件名

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK 文件 string

metrics

获取agent的metric

GET /metrics

Parameters

Name In Type Required Description
format query string false metrics的格式

Example responses

200 Response

[
  {
    "name": "string",
    "help": "string",
    "type": "string",
    "unit": "string",
    "samples": [
      {
        "lables": [
          {
            "label": "string",
            "value": "string"
          }
        ],
        "value": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK agent metrics Inline

Response Schema

Status Code 200

agent metric

Name Type Required Restrictions Description
anonymous [Metric] false none agent metric
» name string false none name
» help string false none none
» type string false none none
» unit string false none none
» samples [any] false none none
»» lables [any] false none none
»»» label string false none none
»»» value string false none none
»» value string false none none

Schemas

OragentConfig

{
  "uniqueId": 10,
  "mode": "RAW",
  "host": "10.0.10.169",
  "port": 1521,
  "connectionString": "10.0.10.169:1521:+ASM",
  "asmUser": "agentasm",
  "asmPassword": 123456,
  "bigEndian": false
}

agent配置

Properties

Name Type Required Restrictions Description
uniqueId integer(int32) false none ID
mode string false none 读取模式
host string(ip) false none 地址
port integer(int32) false none 端口
connectionString string false none JDBC连接串
asmUser string false none ASM用户
asmPassword string false none ASM密码
bigEndian boolean false none 大小端

Enumerated Values

Property Value
mode RAW
mode DB
mode ASM

OracleNodeConfig

{
  "host": "10.0.10.169",
  "port": 1521,
  "database": "orcl",
  "username": "agent1",
  "password": "agent1",
  "dpToken": "9lK2YSFlp2XU/pfrdvWd4ublEKFTIM3qdAY/l47x69GawPZjH343e7mNU+86XcIkE0X4uoajqOidgEEjrUIN3g==",
  "oragentConfig": {
    "uniqueId": 10,
    "mode": "RAW",
    "host": "10.0.10.169",
    "port": 1521,
    "connectionString": "10.0.10.169:1521:+ASM",
    "asmUser": "agentasm",
    "asmPassword": 123456,
    "bigEndian": false
  }
}

Oracle节点配置

Properties

Name Type Required Restrictions Description
host string(ip) false none 地址
port integer(int32) false none 端口
database string false none 数据库
username string false none 用户名
password string false none 密码
dpToken string false none 许可证
oragentConfig OragentConfig false none agent配置

RedoLog

{
  "thr": 0,
  "seq": 0,
  "cbk": 0,
  "cbo": 0,
  "lwn_block_num": 0,
  "name": "string"
}

重做日志

Properties

Name Type Required Restrictions Description
thr integer false none 线程号
seq integer(int64) false none 序列号
cbk integer(int64) false none 当前块号
cbo integer false none 当前块偏移量
lwn_block_num integer(int64) false none 下一个 lwn 的开始位置
name string false none 日志名

Data

{
  "id": 1,
  "deployment-id": "58c67b73-ba1a-4a92-b229-9c42086a472a",
  "delay-sec": 2,
  "system": "string",
  "err": "string"
}

Properties

Name Type Required Restrictions Description
id string false none ID
deployment-id string false none 部署ID
delay-sec string false none 延迟(秒)
system string false none 系统检查项
err string false none 错误

Check

{
  "id": 1,
  "status": "string",
  "data": {
    "id": 1,
    "deployment-id": "58c67b73-ba1a-4a92-b229-9c42086a472a",
    "delay-sec": 2,
    "system": "string",
    "err": "string"
  }
}

Properties

Name Type Required Restrictions Description
id string false none 检查项
status string false none 状态
data Data false none none

Health

{
  "status": "UP",
  "checks": [
    {
      "id": 1,
      "status": "string",
      "data": {
        "id": 1,
        "deployment-id": "58c67b73-ba1a-4a92-b229-9c42086a472a",
        "delay-sec": 2,
        "system": "string",
        "err": "string"
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
status string false none 状态
checks [Check] false none 所有检查项

Enumerated Values

Property Value
status UP
status DOWN

FindFileRequest

{
  "wild": "*export.log.2022-10*",
  "start": "2022-10-10T10:10:10.000Z",
  "end": "2022-10-10T10:10:10.000Z",
  "tar": true
}

Properties

Name Type Required Restrictions Description
wild string false none 文件名通配符,必须包含 .log 或者 .json
start string(date-time) false none 最小文件修改时间(ISO8601),默认为最小值
end string(date-time) false none 最大文件修改时间(ISO8601), 默认为最大值
tar boolean false none 是否打包,否的话只传第一个文件

ApiResponse

{
  "code": 0,
  "type": "string",
  "message": "string"
}

Properties

Name Type Required Restrictions Description
code integer(int32) false none none
type string false none none
message string false none none

LegacyConfig

{
  "src_id": "1",
  "src_login": "DP_TEST/123456@dn-oracle-source:1521/ORCL",
  "param_exadata": "0",
  "asm_login": "agentasm as sysdba/agentasm@//10.10.10.20:1521/+ASM",
  "asm_oracle_sid": "+ASM1",
  "asm_oracle_home": "/u01/app/19.0/grid",
  "asm_mode": "RAW",
  "asm_device_id": "1 , 2 , 3",
  "asm_disk": "/dev/asm-diskc , /dev/asm-diskd , /dev/asm-diske",
  "asm_dev": "/dev/sdb1 , /dev/sdb2 , /dev/sdb3"
}

Properties

Name Type Required Restrictions Description
src_id string false none none
src_login string false none 数据库登录信息
param_exadata string false none 读取方式,小端为 0 ,大端为 1
asm_login string false none ASM 登录信息
asm_oracle_sid string false none ASM 对应 SID
asm_oracle_home string false none ASM 对应 ORACLE_HOME
asm_mode string false none 读取模式
asm_device_id string false none ASM 设备号
asm_disk string false none ASM 磁盘路径
asm_dev string false none ASM 磁盘信息

Enumerated Values

Property Value
param_exadata 0
param_exadata 1
asm_mode RAW
asm_mode DB
asm_mode ASM

Savepoint

{
  "thr": 0,
  "seq": 0,
  "cbk": 0,
  "cbo": 0,
  "lwn_block_num": 0
}

Properties

Name Type Required Restrictions Description
thr integer(int32) false none 线程 ID
seq integer(int64) false none 日志文件号
cbk integer(int64) false none 当前块号
cbo integer false none 当前块偏移量
lwn_block_num integer(int64) false none 下一个 lwn 的开始位置

Trans

{
  "trans_id": 0,
  "scn_bgn0": 0,
  "scn_bgn": {
    "scn": 0,
    "scn_sub": 0,
    "len": 10
  },
  "scn": {
    "scn": 0,
    "scn_sub": 0,
    "len": 10
  },
  "scn_max": {
    "scn": 0,
    "scn_sub": 0,
    "len": 10
  },
  "scn_time_bgn": 0,
  "scn_time": {
    "value": 0
  },
  "scn_time_max": 0,
  "thread_id": 0,
  "uba": 0,
  "dba": 0,
  "slt": 0,
  "rba": 0,
  "is_ddl": 0,
  "is_cmted": true,
  "changed": 0,
  "cached_len": 0,
  "total_len": 0,
  "flag": 0,
  "cur_fno": 0,
  "max_fno": 0
}

Properties

Name Type Required Restrictions Description
trans_id integer(int64) false none 事务 ID
scn_bgn0 integer(int64) false none 起始 SCN
scn_bgn Scn false none none
scn Scn false none none
scn_max Scn false none none
scn_time_bgn integer(int64) false none 起始 SCN 时间
scn_time object false none none
» value integer(int64) false none SCN 时间值
scn_time_max integer(int64) false none 最大 SCN 时间
thread_id integer(int32) false none 线程 ID
uba integer(int64) false none Undo 块地址
dba integer(int64) false none 数据块地址
slt integer(int32) false none none
rba integer(int64) false none Redo 块地址
is_ddl integer(int32) false none 是否是 DDL
is_cmted boolean false none 是否 commit
changed integer(int64) false none none
cached_len integer(int64) false none 缓存长度
total_len integer(int64) false none 总长度
flag integer(int32) false none 标志位
cur_fno integer(int32) false none 当前缓存文件序号
max_fno integer(int32) false none 最大缓存文件序号

Scn

{
  "scn": 0,
  "scn_sub": 0,
  "len": 10
}

Properties

Name Type Required Restrictions Description
scn integer(int64) false none none
scn_sub integer(short) false none none
len integer(int32) false none none

RecoverConfig

{
  "mapConfig": {
    "map.ts": 1667269111284,
    "map.map": [
      {
        "table": "OWNER.TABLE"
      }
    ]
  },
  "srcConfig": {
    "src": {
      "id": 1,
      "login": "DP_TEST/123456@192.168.0.14:1521/orcl"
    },
    "dp_token": "8qQvIp26WZh05LcX+H8uDj5JLPCtkCAAa4apNb0dnXPqjikCA9NXwZmBF+pCAPvSyF+U6PQ+fUO1TQnGVzSKFS76ldmwPjOtOCvpXSQERb4=",
    "asm.login": "/as sysdba",
    "asm.oracle_home": "",
    "asm.oracle_sid": "",
    "asm.mode": "db",
    "asm.exadata": false,
    "asm.subAsm": []
  },
  "paramConfig": {
    "param.channel": "kafka",
    "param.kafka": {
      "bootstrap.servers": "kafkazc:9092",
      "schema.registry.url": "http://192.168.0.31:8081",
      "acks": "1"
    },
    "param.charset1": "gbk",
    "param.charset2": "utf-16",
    "param.charset_clob": "gbk",
    "param.port": 8998,
    "param.offmore": false,
    "param.change_interval_sec": 1,
    "param.map_update_timeout_sec": 300,
    "param.retry_backoff_ms": 10000,
    "param.print_objno": [],
    "param.print_level": 1,
    "param.print_detail_cooldown_ms": 3000,
    "param.print_cost": false,
    "param.print_merge": false,
    "param.print_large_tx_threshold": "10m",
    "param.min_diskspace": "10g",
    "param.delete_trans_if_low_diskspace": false,
    "param.out_mb": 20,
    "param.conv_parallelism": 0,
    "param.producer_num": 1,
    "param.cpu_limit": 0,
    "param.deal_byte_rate": 0,
    "param.conv_byte_rate": 0,
    "param.supplemental_all_only": false,
    "param.auto_reset_policy": "none",
    "param.filter_ahead": true,
    "param.direct_local": true,
    "param.legacy_view": false,
    "param.legacy_format": false,
    "param.skip_error": true,
    "param.ignore_255_update": false,
    "param.save_on_quit": false,
    "param.skip_merge_fail": true,
    "param.lag_barrier": -1,
    "param.local_mode": "none",
    "param.local_mode_all": true,
    "param.os": "linux",
    "param.lx": false,
    "param.aix_stat_size_off": -1,
    "param.record_head_len": -1
  },
  "safeScn": 1265702183
}

Properties

Name Type Required Restrictions Description
mapConfig object false none none
srcConfig object false none none
paramConfig object false none none
safeScn integer(int64) false none none

Metric

{
  "name": "string",
  "help": "string",
  "type": "string",
  "unit": "string",
  "samples": [
    {
      "lables": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "value": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string false none name
help string false none none
type string false none none
unit string false none none
samples [any] false none none
» lables [any] false none none
»» label string false none none
»» value string false none none
» value string false none none