获取RDS实例列表 - ListRds
功能介绍
功能介绍:获取RDS实例列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/asset/rds
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 长度为32个字符,只能由小写英文字母和数字组成 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页数量限制 约束限制: 不涉及 取值范围: 不涉及 默认取值: 10 |
| offset | 否 | Integer | 参数解释: 分页偏移 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
| name | 否 | String | 参数解释: 资产名称,用于按名称筛选或查询数据资产 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| owner_account_id | 否 | String | 参数解释: 拥有者账号ID,标识数据资产所属的华为云账号,可通过IAM服务或控制台获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instances | Array of RdsInstance objects | 参数解释: RDS实例信息列表,数组元素为RdsInstance对象,包含实例ID、名称、状态等信息 取值范围: 不涉及 |
| total_count | Integer | 参数解释: 总数数量 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| status | String | 参数解释: RDS实例运行状态,标识RDS实例当前的运行状态 取值范围: 不涉及 |
| 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 | 参数解释: 备份策略,说明RDS实例的备份配置方式 取值范围: 不涉及 |
| created | String | 参数解释: 创建时间,用于标识记录或实例的创建时间 取值范围: 不涉及 |
| type | String | 参数解释: 数据库实例类型 取值范围: 不涉及 |
| deleted | Boolean | 参数解释: 是否已删除,用于标识资源是否被删除 取值范围: true-已删除,false-未删除 |
| projectId | String | 参数解释: 项目ID 取值范围: 不涉及 |
| sourceType | String | 参数解释: 来源类型,标识RDS实例的创建来源类型 取值范围: 不涉及 |
请求示例
获取rds实例列表
/v1/2b31ed5200000ebedb6e570000000000/sdg/asset/rds
响应示例
状态码:200
{
"instances" : [ {
"id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"projectId" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"sourceType" : "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" ],
"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" ],
"enable_ssl" : true,
"disk_encryption_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"backup_strategy" : { },
"created" : "asset-value-01",
"type" : "DATABASE",
"deleted" : true
} ],
"total_count" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。