文档首页/ 数据库安全服务 DBSS/ API参考/ API/ 审计数据库/ 添加自建数据库
更新时间：2024-12-16 GMT+08:00
在线调试
CLI示例
查看PDF
分享

添加自建数据库

功能介绍

添加自建数据库

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/{instance_id}/audit/databases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

instance_id

是

String

实例ID。可在查询实例列表接口的ID字段获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

database

是

database object

数据库信息
表4 database

参数

是否必选

参数类型

描述

db_classification

是

String

数据库分类

ECS：自建数据库

name

是

String

数据库名称

type

是

String

数据库类型

  • MYSQL
  • ORACLE
  • POSTGRESQL
  • SQLSERVER
  • DAMENG
  • TAURUS
  • DWS
  • KINGBASE
  • GAUSSDBOPENGAUSS
  • GREENPLUM
  • HIGHGO
  • SHENTONG
  • GBASE8A
  • GBASE8S
  • GBASEXDM
  • MONGODB
  • DDS

version

是

String

数据库版本

charset

是

String

字符集，默认设置UTF8。

  • GBK
  • UTF8

ip

是

String

数据库IP

port

是

String

数据库端口

os

是

String

数据库操作系统

  • LINUX64
  • WINDOWS64
  • UNIX

instance_name

否

String

数据库实例名称

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

id

String

数据库ID

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表7 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表9 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表11 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

请求示例

/v1/{project_id}/{instance_id}/audit/databases

{
  "database" : {
    "name" : "test",
    "type" : "POSTGRESQL",
    "version" : "7.4",
    "charset" : "UTF8",
    "ip" : "1.1.1.1",
    "port" : "66",
    "instance_name" : "testaaa",
    "os" : "LINUX64",
    "db_classification" : "ECS"
  }
}

响应示例

状态码： 200

成功

{
  "id" : "Fadq-Y4B51p4J06sRc4F"
}

状态码： 400

失败

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码

状态码

描述

200

成功

400

失败

403

认证失败

500

服务端错误

错误码

请参见错误码。

父主题： 审计数据库