文档首页/数据库安全服务 DBSS/API参考/API说明/审计数据库/查询RDS数据库列表 - ListRdsDatabases
更新时间：2026-01-22 GMT+08:00
查看PDF
分享

查询RDS数据库列表 - ListRdsDatabases

功能介绍

查询RDS数据库列表

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可通过IAM服务[查询指定IAM用户的项目列表]接口获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-64。

默认取值：

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

db_type

是

String

参数解释：

数据库类型

约束限制：

区分大小写，只能传递取值范围内的值

取值范围：

  • MYSQL: Mysql

  • ORACLE: Oracle

  • POSTGRESQL: PostgreSQL

  • SQLSERVER: SQL Server

  • DAMENG: DAMENG

  • TAURUS: TaurusDB

  • DWS: GaussDB DWS

  • KINGBASE: KINGBASE

  • MARIADB: MariaDB

  • GAUSSDBOPENGAUSS: GaussDB/openGauss

默认取值：

不涉及

offset

否

String

参数解释：

分页偏移量，从第一条数据偏移offset条数据后开始查询

约束限制：

仅支持大于等于0的整数

取值范围：

大于等于0

默认取值：

默认值为0

limit

否

String

参数解释：

每页查询记录数。

约束限制：

仅支持大于0的整数

取值范围：

大于0小于等于100

默认取值：

默认值为100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

IAM服务查询用户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：MySql

  • ORACLE：Oracle

  • POSTGRESQL：PostgreSQL

  • SQLSERVER：SQL Server

  • DAMENG：DAMENG

  • TAURUS：TaurusDB

  • DWS：GaussDB DWS

  • KINGBASE：KINGBASE

  • MARIADB：MariaDB

  • GAUSSDBOPENGAUSS：GaussDB/openGauss

version

String

版本

is_supported

Boolean

是否支持免agent审计

enterprise_id

String

企业项目ID

状态码：400

表6 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表7 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：403

表8 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表9 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

状态码：500

表10 响应Body参数

参数

参数类型

描述

details

Array of DbssErrorDetail objects

PDP5鉴权异常信息

encoded_authorization_message

String

PDP5鉴权异常信息

error_code

String

错误码

error_msg

String

错误信息

表11 DbssErrorDetail

参数

参数类型

描述

error_code

String

错误码

error_msg

String

PDP5错误信息

请求示例

/v2/{project_id}/audit/databases/rds?db_type=MYSQL&offset=0&limit=10

响应示例

状态码：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
}

状态码

状态码

描述

200

成功

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码。

父主题：审计数据库