文档首页/ 数据库安全服务 DBSS/ API参考 (巴黎、阿姆斯特丹区域) / API/ 数据库接口/ 查询数据库列表
更新时间：2024-01-15 GMT+08:00
查看PDF
分享

查询数据库列表

功能介绍

查询数据库列表

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

instance_id

是

String

实例ID
表2 Query参数

参数

是否必选

参数类型

描述

status

否

String

实例状态 ON ：开启 OFF ： 关闭

offset

否

String

偏移量

limit

否

String

查询记录数

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

databases

Array of DataBaseBean objects

数据库信息列表

total

Integer

总数
表5 DataBaseBean

参数

参数类型

描述

database

DataBase object

数据库信息
表6 DataBase

参数

参数类型

描述

id

String

数据库ID

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

数据库字符集

ip

String

数据库IP

port

String

数据库端口

os

String

数据库操作系统

status

String

开启状态（1：开启，0：关闭）

instance_name

String

数据库实例名

audit_status

String

数据库的运行状态 枚举值：  ACTIVE  SHUTOFF  ERROR

agent_url

Array of strings

agent的唯一ID

db_classification

String

数据库分类，取值范围： RDS（表示RDS数据库）和 ECS（自建数据库）

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表8 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

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

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表10 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

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

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。
表12 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

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

请求示例

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

响应示例

状态码： 200

成功

{
  "databases" : [ {
    "database" : {
      "id" : "zLKv83gBCwCqSg3BJt0m",
      "name" : "db01",
      "type" : "MYSQL",
      "version" : "5.0",
      "charset" : "UTF8",
      "ip" : "192.168.0.204",
      "port" : "3306",
      "os" : "LINUX64",
      "status" : "OFF",
      "instance_name" : "",
      "audit_status" : null,
      "agent_url" : [ "zrKw83gBCwCqSg3Bkt1P" ],
      "db_classification" : "ECS"
    }
  } ]
}

状态码： 400

请求参数错误

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

状态码： 500

服务器内部错误

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

状态码

状态码

描述

200

成功

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码。

父主题： 数据库接口