文档首页/ 数据安全中心 DSC/ API参考/ API/ 基础设施查询/ 获取rds数据库列表 - ListAllRdsDatabases
更新时间:2026-10-20 GMT+08:00
分享

获取rds数据库列表 - ListAllRdsDatabases

功能介绍

功能介绍:获取rds数据库列表

路径参数:rds_id。

查询参数:source_type、refresh、asset_type、limit、offset(可选参数不传时使用默认值)。

响应:请求成功返回HTTP 200及响应体。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/sdg/asset/rds/{rds_id}/databases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取

约束限制:

满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字

取值范围:

长度为32个字符,只能由小写英文字母和数字组成

默认取值:

不涉及

rds_id

是

String

参数解释:

RDS实例ID

约束限制:

满足正则匹配"^[a-zA-Z0-9-]{10,64}$",10到64位英文字母、数字及中划线

取值范围:

10到64个字符,只能由英文字母、数字及中划线

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

source_type

否

String

参数解释:

来源类型

约束限制:

满足正则匹配"^[\u4E00-\u9FA5\uF900-\uFA2D()()-_\w-]{1,255}$",1到255位中文字符、英文字母、数字及下划线、连字符

取值范围:

不涉及

默认取值:

不涉及

refresh

否

Boolean

参数解释:

是否刷新

约束限制:

不涉及

取值范围:

true-是,false-否

默认取值:

不涉及

asset_type

否

String

参数解释:

资产类型

约束限制:

满足正则匹配"^[\u4E00-\u9FA5\uF900-\uFA2D()()-_\w-]{1,255}$",1到255位中文字符、英文字母、数字及下划线、连字符

取值范围:

不涉及

默认取值:

不涉及

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

0~2147483647

默认取值:

100

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

0~2147483647

默认取值:

1

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

databases

Array of Database objects

参数解释:

数据库列表,数组元素为DB对象,包含数据库的详细信息

取值范围:

不涉及

status

String

参数解释:

操作结果状态

取值范围:

不涉及

total_count

Long

参数解释:

总数数量

取值范围:

不涉及

表5 Database

参数

参数类型

描述

name

String

参数解释:

数据库名称

取值范围:

不涉及

请求示例

获取rds数据库列表

/v1/2b31ed5200000ebedb6e570000000000/sdg/asset/rds/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/databases

响应示例

状态码:200

{
  "databases" : [ {
    "name" : "asset-resource-01"
  } ],
  "status" : "ENABLE",
  "total_count" : 2
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档