i2UP接口文档

# 数据库节点管理

# 数据库列表

# URL

//active/db

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
page Number 否 1
limit Number 否 10
search_field String 否 用于搜索的键
search_value String 否 用于搜索的值
type String 否 all 数据库节点的类型： 源端节点1； 备端节点：2 ，不传默认为全部

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  total Number 否 20
  message String 否
  info_list Array 否 2
    db_name String 是 @name 数据库节点名称
    db_uuid String 是 3D7dFcd9-C176-d9ee-4FFB-f22bbd554926
    node_name String 是 @name
    db_type String 是 oracle 数据库类型：oracle,kafka,mysql,postgres,vertica,greenplum
    username String 是 @name
    deploy_mode String 是 0 oracle 部署方式：single（单机） cluster（集群）
    log_read_type String 是 file oracle : 日志读取方式：file(文件系统)，logical（裸设备），asm_insatnce（asm实例），asm_device（asm块设备）
    file_open_type String 是 normal oracle: 日志打开方式 normal(普通方式) ，DIRECT
    node_type String 否 11000
    db_mode String 否 cdb 数据库模式
    can_up Number 否 1
    can_op Number 否 1
    can_del Number 否 1
    is_biz_admin Number 否 1

# 修改数据库节点

# URL

//active/db/:uuid([A-F0-9-]+)

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
db_name String 否 @name
db_uuid String 否 @guid
node_uuid String 否 @guid
db_type String 否 oracle
file_open_type String 否 0
deploy_mode String 否 0
log_read_type String 否 file
random_str String 否
config Object 否
  username String 否 @name
  password String 否
  server_name String 否
  port Number 否 1
  log_read Object 否
    os_auth Number 否 1
    asm_instance String 否
    asm_username String 否
    asm_port Number 否 1
    asm_password String 否 12323131
  filter_session Number 否 1
  relay Object 否
    enable Number 否 1
    relay_node_uuid String 否
  remote_file_agent Object 否
    enable Number 否 1
    port Number 否 1
    compress String 否 no
  db_list Array 否
    ip String 否
    thread String 否
  producer_host String 否 @ip
  producer_port Number 否 1
  broker_server Array 否
    ip String 否 @ip
    port Number 否 1

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 operate success

# 测试数据库连接

# URL

//active/db/db_check

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
db_name String 否 @name
node_uuid String 否 @guid
db_type String 否 oracle
file_open_type String 否 DIRECT
deploy_mode String 否 single
log_read_type String 否 file
config Object 否
  username String 否 @name
  password String 否
  server_name String 否
  port Number 否 1
  log_read Object 否
    os_auth Number 否 1
    asm_instance String 否
    asm_username String 否
    asm_port Number 否 1
    asm_password String 否 12323131
  filter_session Number 否 1
  relay Object 否
    enable Number 否 1
    relay_node_uuid String 否
  remote_file_agent Object 否
    enable Number 否 1
    port Number 否 1
    compress String 否 none
  db_list Array 否
    ip String 否
    thread String 否
    disable String 否
  producer_host String 否 @ip
  producer_port Number 否 1
  broker_server Array 否
    ip String 否 @ip
    port Number 否 1
db_uuid String 否 @guid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 connect success

# 新建数据库节点

# URL

//active/db

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
db_uuid String 否 @guid 数据库节点的uuid,为空的话，则表明是创建，不为空则为修改
db_name String 否 @name
node_uuid String 否 @guid
db_type String 否 oracle 数据库类型：oracle,kafka,mysql,postgres,vertica,greenplum
file_open_type String 否 0 normal:普通方式，DIRECT：DIRECT
deploy_mode String 否 0 oracle：部署方式：single:单机 cluster:集群
log_read_type String 否 file
config Object 否
  username String 否 @name oracle
  password String 否 oracle
  server_name String 否 oracle
  port Number 否 1 oracle
  relay Object 否 oracle
    enable Number 否 1 是否有中继节点
    relay_node_uuid String 否 中继节点uuid
  log_read Object 否 oracle
    os_auth Number 否 1 asm asm_device: 是否os认证 1：认证 0：不认证
    asm_instance String 否 asm asm_device: asm 实例
    asm_username String 否 asm asm_device: ASM用户名
    asm_port Number 否 1 asm asm_device: asm 端口号
    asm_password String 否 12323131
  filter_session Number 否 1 1:过滤 0：不过滤
  remote_file_agent Object 否 oracle:远程文件代理
    enable Number 否 1 是否启用
    port Number 否 1 端口
    compress String 否 no 压缩类型：no（不压缩） lzo，zip
  db_list Array 否 oracle
    ip String 否
    thread String 否
    disable Number 否 0 0-1
  producer_host String 否 @ip kafka: Producer 主机
  producer_port Number 否 1 kafka: Producer 端口
  broker_server Array 否 kafka
    port Number 否 1
    ip String 否 @ip 端口
  authentication String 否 none kafka: none,Kerberos,username 认证方式
  principal String 否 kafka
  keytabfile String 否 kafka
  kafka_auth_type String 否 none sasl_gssapi sasl_plain(用户名和密码)
  kerberos_keytab_path String 否 principal
  kerberos_principal String 否 keytab路径
  kerberos_service_name String 否 kafka 服务名
  sasl_plain_user String 否 用户名
  sasl_plain_pass String 否 密码
  sqlserver Object 否
    ip String 否
    port Number 否
    usr String 否
    pwd String 否
    db String 否
    dacport String 否
db_mode String 否 normal,cdb,pdb
cdb String 否 @guid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 operate success

# 删除数据库

# URL

//active/db

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
uuids Array 否 @guid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 Delete success

# 数据库状态

# URL

//active/db/status

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
uuids Array 否 @guid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否
  status Array 否 2
    db_uuid String 否 3D7dFcd9-C176-d9ee-4FFB-f22bbd554926
    status String 否 ONLINE ONLINE, OFFLINE
    version String 否 7.2.0.32522

# 数据库健康信息

# URL

//active/db/health_info

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
uuid String 否 @guid 数据库节点uuid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  info Object 否
    connect String 否 127.0.0.1 connect ok
    tablespace String 否
    asm_disk String 否
    headroom String 否 Date_Time Headroom 2019/05/16 17:14:14 11671.695902
    lock_db String 否
    gragh Array 否
      cloud Array 否
        spend String 否 1000
      txn Array 否
        scn_time String 否
        irp String 否
        urp String 否
        drp String 否
        qmi String 否
        txn String 否
      log_thd Array 否
        id String 否
        scn_time String 否

# 表空间查询接口

# URL

//active/db/space_query

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
uuid String 否 @guid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 operate success

# 获取单个数据库节点信息

点击修改数据库的信息

# URL

//active/db/:uuid([A-F0-9-]+)

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success
  active_db Object 否
    username String 否 admin
    id String 否 4
    create_time String 否 1560328411
    db_uuid String 否 3E2EBF85-7261-3FA2-9A6C-23AC0C2174E8
    random_str String 否 1B826A2D-7373-C3A7-0695-ADB854EC08BA
    user_uuid String 否 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    db_name String 否 db31
    node_uuid String 否 3E2EBF85-8261-3FA2-9A6C-23AC0C2174E8
    db_type String 否 oracle
    file_open_type String 否 normal
    deploy_mode String 否 single
    log_read_type String 否 asm
    config Object 否
      username String 否 root
      password String 否 xxxxxx
      server_name String 否 server1
      port Number 否 1
      log_read Object 否
        os_auth Number 否 1
        asm_instance String 否
        asm_username String 否
        asm_port Number 否 1
        asm_password String 否 12323131
      filter_session Number 否 1
      relay Object 否
        enable Number 否 1
        relay_nodeuuid String 否
      remote_file_agent Object 否
        enable Number 否 1
        port Number 否 1
        compress String 否 none
      db_list Array 否
        ip String 否
        thread String 否
      producer_host String 否 8.8.8.8
      producer_port Number 否 1
      broker_server Array 否
        ip String 否 8.8.4.4
        port Number 否 1
    db_mode String 否 pdb
    cdb String 否 @uuid
Last Updated: 5/13/2020, 3:56:32 AM