文档首页/ 数据库安全服务 DBSS/ API参考/ API/ 审计数据库/ 查询RDS数据库列表
更新时间：2024-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询RDS数据库列表

功能介绍

查询RDS数据库列表

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/audit/databases/rds

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

db_type

是

String

数据库类型

  • MYSQL
  • ORACLE
  • POSTGRESQL
  • SQLSERVER
  • DAMENG
  • TAURUS
  • DWS
  • KINGBASE
  • MARIADB
  • GAUSSDBOPENGAUSS

offset

否

String

偏移量，从第一条数据偏移offset条数据后开始查询，默认为0。

limit

否

String

查询记录数，默认为100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

databases

Array of databases objects

rds数据库列表

total_count

Integer

总数
表5 databases

参数

参数类型

描述

id

String

ID

db_name

String

数据库名称

status

String

实例状态。

  • BUILD：表示实例正在创建。
  • ACTIVE：表示实例正常。
  • FAILED：表示实例异常。
  • FROZEN：表示实例冻结。
  • MODIFYING：表示实例正在扩容。
  • REBOOTING：表示实例正在重启。
  • RESTORING：表示实例正在恢复。
  • MODIFYING INSTANCE TYPE：表示实例正在转主备。
  • SWITCHOVER：表示实例正在主备切换。
  • MIGRATING：表示实例正在迁移。
  • BACKING UP：表示实例正在进行备份。
  • MODIFYING DATABASE PORT：表示实例正在修改数据库端口。
  • STORAGE FULL：表示实例磁盘空间满。

port

String

数据库端口

ip

String

数据库IP

instance_name

String

rds实例名称

type

String

数据库类型

  • MYSQL
  • ORACLE
  • POSTGRESQL
  • SQLSERVER
  • DAMENG
  • TAURUS
  • DWS
  • KINGBASE
  • MARIADB
  • GAUSSDBOPENGAUSS

version

String

版本

is_supported

Boolean

是否支持免agent审计

enterprise_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

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

请求示例

无

响应示例

状态码： 200

成功

{
  "databases" : [ {
    "id" : "5a5c4ca8b10f4b00bc88e03866fe3fd4in01",
    "db_name" : "rds-cwx1216198",
    "status" : "ACTIVE",
    "port" : "3306",
    "ip" : "192.168.0.159",
    "instance_name" : "rds-cwx1216198",
    "type" : "MySQL",
    "version" : "5.7",
    "is_supported" : null,
    "enterprise_id" : "0"
  }, {
    "id" : "3f1cfaac552e42f1bb9855993586076cin01",
    "db_name" : "rds-5c25",
    "status" : "FROZEN",
    "port" : "3306",
    "ip" : "192.168.0.14",
    "instance_name" : "rds-5c25",
    "type" : "MySQL",
    "version" : "5.7",
    "is_supported" : null,
    "enterprise_id" : "0"
  } ],
  "total_count" : 2
}

状态码： 400

请求参数错误

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

状态码： 500

服务器内部错误

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

状态码

状态码

描述

200

成功

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码。

父主题： 审计数据库