# 获取RDS实例列表 - ListRds #### 功能介绍 功能介绍：获取RDS实例列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/sdg/asset/rds 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 每页数量限制 **约束限制：** 不涉及 **取值范围：** 0\~2147483647 **默认取值：** 10 | | offset | 否 | Integer | **参数解释：** 分页偏移 **约束限制：** 不涉及 **取值范围：** 0\~2147483647 **默认取值：** 0 | | name | 否 | String | **参数解释：** RDS实例名称 **约束限制：** 不涉及 **取值范围：** 1到256个字符 **默认取值：** 不涉及 | | owner_account_id | 否 | String | **参数解释：** 拥有者账号ID **约束限制：** 不涉及 **取值范围：** 1到256个字符 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instances | Array of [RdsInstance] objects | **参数解释：** 实例 **取值范围：** 不涉及 | | total_count | Integer | **参数解释：** 总数数量 **取值范围：** 不涉及 | 表5RdsInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 资源ID，唯一标识 **取值范围：** 不涉及 | | project_id | String | **参数解释：** 项目ID **取值范围：** 不涉及 | | source_type | String | **参数解释：** 来源类型 **取值范围：** 不涉及 | | status | String | **参数解释：** 操作结果状态 **取值范围：** 不涉及 | | name | String | **参数解释：** RDS实例名称 **取值范围：** 不涉及 | | port | Integer | **参数解释：** 连接端口 **取值范围：** 不涉及 | | region | String | **参数解释：** 区域 **取值范围：** 不涉及 | | datastore | [Datastore] object | **参数解释：** 数据存储 **取值范围：** 不涉及 | | private_ips | Array of strings | **参数解释：** 私有IP地址列表 **取值范围：** 不涉及 | | vpc_id | String | **参数解释：** 虚拟私有云ID **取值范围：** 不涉及 | | subnet_id | String | **参数解释：** 子网ID **取值范围：** 不涉及 | | security_group_id | String | **参数解释：** 安全组ID **取值范围：** 不涉及 | | public_ips | Array of strings | **参数解释：** 公共IP地址列表 **取值范围：** 不涉及 | | enable_ssl | Boolean | **参数解释：** 启用SSL **取值范围：** true-是，false-否 | | disk_encryption_id | String | **参数解释：** 磁盘加密ID **取值范围：** 不涉及 | | backup_strategy | Object | **参数解释：** 备份策略 **取值范围：** 不涉及 | | created | String | **参数解释：** 创建 **取值范围：** 不涉及 | | type | String | **参数解释：** 数据库实例类型 **取值范围：** 不涉及 | | deleted | Boolean | **参数解释：** 删除 **取值范围：** true-是，false-否 | 表6Datastore | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 数据存储类型 **取值范围：** 不涉及 | | version | String | **参数解释：** 存储版本 **取值范围：** 不涉及 | #### 请求示例 获取RDS实例列表 ``` /v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/sdg/asset/rds ``` #### 响应示例 **状态码：200** ``` { "instances" : [ { "id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d", "project_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46", "source_type" : "DATABASE", "status" : "ENABLE", "name" : "asset-resource-01", "port" : 3306, "region" : "cn-north-4", "datastore" : { "type" : "DATABASE", "version" : "1.0.0" }, "private_ips" : [ "192.168.1.10", "192.168.1.11" ], "vpc_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70", "subnet_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d", "security_group_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908", "public_ips" : [ "192.168.1.10", "192.168.1.11" ], "enable_ssl" : true, "disk_encryption_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d", "backup_strategy" : "asset-value-01", "created" : "asset-value-01", "type" : "DATABASE", "deleted" : true } ], "total_count" : 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。