查询用户DB实例列表 - ListAssetDatabasesInstances
功能介绍
功能介绍:查询用户DB实例列表
查询参数:instance_type、owner_account_id(可选参数不传时使用默认值)。
响应:请求成功返回HTTP 200及响应体。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/asset-center/database/instances
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 长度为32个字符,只能由小写英文字母和数字组成 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| instance_type | 否 | String | 参数解释: 实例类型 约束限制: 满足正则匹配"^[\u4E00-\u9FA5\uF900-\uFA2D()()-_\w-]{1,255}$",1到255位中文字符、英文字母、数字及下划线、连字符 取值范围: 默认取值: 不涉及 |
| 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 DbInstanceInfo objects | 参数解释: 实例列表,数组元素为实例实体对象 取值范围: 不涉及 |
| count | Integer | 参数解释: 查询结果总数量,表示查询结果返回的记录条数 取值范围: 不涉及 |
| instance_list | Array of InstanceEntity objects | 参数解释: 实例列表,数组元素为实例实体对象 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| port | Integer | 参数解释: 连接端口 取值范围: 0~65535 |
| status | String | 参数解释: 操作结果状态 取值范围: 0到1024个字符 |
| region | String | 参数解释: 区域 取值范围: 0到1024个字符 |
| datastore | Datastore object | 参数解释: 数据存储 取值范围: 不涉及 |
| type | String | 参数解释: 数据库实例类型 取值范围: 0到1024个字符 |
| ins_id | String | 参数解释: 数据库实例信息ID 取值范围: 0到1024个字符 |
| ins_name | String | 参数解释: 数据库租户的subnet 名称 取值范围: 0到1024个字符 |
| source_type | String | 参数解释: 来源类型 取值范围: 0到1024个字符 |
| private_ips | Array of strings | 参数解释: 私有IP列表 取值范围: 不涉及 |
| create_time | String | 参数解释: 创建时间 取值范围: 0到1024个字符 |
| bind_database | Integer | 参数解释: 绑定数据库 取值范围: 0~200 |
| kerberos_enabled | Boolean | 参数解释: Kerberos已启用 取值范围: true-是,false-否 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 0到1024个字符 |
| ins_id | String | 参数解释: 项目ID 取值范围: 0到1024个字符 |
| ins_type | String | 参数解释: 实例实体类型 取值范围: |
| ins_name | String | 参数解释: 实例实体名称 取值范围: 0到1024个字符 |
| project_id | String | 参数解释: 项目ID 取值范围: 0到1024个字符 |
| db_type | String | 参数解释: 数据库类型 取值范围: 0到1024个字符 |
| version | String | 参数解释: 实例版本 取值范围: 0到1024个字符 |
| address | String | 参数解释: 连接地址 取值范围: 0到1024个字符 |
| ipv6_address | String | 参数解释: IPv6地址 取值范围: 0到1024个字符 |
| port | Integer | 参数解释: 连接端口 取值范围: 0~65535 |
| vpc_id | String | 参数解释: 虚拟私有云ID 取值范围: 0到1024个字符 |
| subnet_id | String | 参数解释: 子网ID 取值范围: 0到1024个字符 |
| security_group_id | String | 参数解释: 安全组ID 取值范围: 0到1024个字符 |
| ins_status | String | 参数解释: 实例实体状态 取值范围: 0到1024个字符 |
| create_time | Long | 参数解释: 创建时间 取值范围: 0~200 |
| default_database | String | 参数解释: 默认数据库 取值范围: 0到1024个字符 |
| bind_database | Integer | 参数解释: 绑定数据库 取值范围: 0~200 |
| service_name | String | 参数解释: 实例实体名称 取值范围: 0到1024个字符 |
| sid | String | 参数解释: 会话ID 取值范围: 0到1024个字符 |
| is_external | Boolean | 参数解释: 是否外部 取值范围: true-是,false-否 |
| owner_account_id | String | 参数解释: 拥有者账号ID 取值范围: 0到1024个字符 |
| owner_project_id | String | 参数解释: 拥有者项目ID 取值范围: 0到1024个字符 |
请求示例
查询用户DB实例列表
/v1/2b31ed5200000ebedb6e570000000000/asset-center/database/instances
响应示例
状态码:200
{
"instances" : [ {
"port" : 3306,
"status" : "ACTIVE",
"region" : "cn-north-4",
"type" : "RDS",
"ins_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"ins_name" : "rds-instance-01",
"source_type" : "from_rds",
"private_ips" : [ "192.168.1.10" ],
"create_time" : 1700000000000,
"bind_database" : 2,
"kerberos_enabled" : false
} ],
"instance_list" : [ ],
"count" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。