文档首页/ 数据安全中心 DSC/ API参考/ API说明/ 资产管理/ 资产中心查询数据库类型实例 - ListDatabaseInstances
更新时间:2025-11-27 GMT+08:00
分享

资产中心查询数据库类型实例 - ListDatabaseInstances

功能介绍

查询数据库实例列表

调用方法

请参见如何调用API

授权信息

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

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

URI

GET /v1/{project_id}/asset-center/database/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

project_id

表2 Query参数

参数

是否必选

参数类型

描述

instance_type

String

数据库实例类型

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

count

Integer

实例的总数。

instance_list

Array of InstanceEntity objects

实例的基本信息列表。

instances

Array of DbInstanceInfo objects

实例的详细信息列表。

表4 InstanceEntity

参数

参数类型

描述

address

String

实例的网络地址,用于标识实例的位置。

bind_database

Integer

绑定的数据库数量,表示该实例关联的数据库数量。

create_time

Long

实例的创建时间,表示实例创建的时间戳。

db_type

String

数据库类型,表示实例支持的数据库种类。

default_database

String

默认数据库名称,表示实例默认使用的数据库。

id

String

实例的唯一标识符,用于唯一标识具体的实例。

ins_id

String

实例的唯一标识符,用于唯一标识具体的实例。

ins_name

String

实例的名称,用于标识实例的名称。

ins_status

String

实例的状态,表示实例的当前运行状态,如'ACTIVE'表示运行中。

ins_type

String

实例的类型,表示实例的分类,如'PUB'表示公共实例。

ipv6_address

String

实例的IPv6地址,用于标识实例的IPv6网络位置。

is_external

Boolean

是否为外部实例,表示实例是否位于外部网络。

port

Integer

实例的网络端口,用于标识实例的网络服务端口。

project_id

String

项目ID,用于唯一标识实例所属的项目。

security_group_id

String

安全组ID,用于唯一标识实例所属的安全组。

service_name

String

服务名称,用于标识实例所属的服务。

sid

String

会话ID,用于标识实例的会话信息。

subnet_id

String

子网ID,用于唯一标识实例所属的子网。

version

String

实例的版本,表示实例的软件版本信息。

vpc_id

String

虚拟私有云(VPC)的唯一标识符,用于唯一标识实例所属的VPC。

表5 DbInstanceInfo

参数

参数类型

描述

bind_database

Integer

绑定的数据库数量,表示该实例关联的数据库数量。

create_time

String

实例的创建时间,表示实例创建的时间戳。

datastore

Datastore object

数据存储对象,包含数据存储的类型和版本信息。

ins_id

String

实例的唯一标识符,用于唯一标识具体的实例。

ins_name

String

实例的名称,用于标识实例的名称。

kerberos_enabled

Boolean

是否启用Kerberos认证,表示实例是否支持Kerberos安全认证。

port

Integer

实例的网络端口,用于标识实例的网络服务端口。

private_ips

Array of strings

实例的私有IP地址列表,表示实例的内部网络地址。

region

String

实例所在的区域,表示实例的地理位置信息。

source_type

String

实例的来源类型,表示实例的创建来源。

status

String

实例的状态,表示实例的当前运行状态,如'ACTIVE'表示运行中。

type

String

实例的类型,表示实例的分类,如'RDS'表示关系型数据库服务。

表6 Datastore

参数

参数类型

描述

type

String

数据存储的类型,表示数据存储的种类,如'Mysql'表示MySQL数据库。

version

String

数据存储的版本,表示数据存储的软件版本信息。

请求示例

资产中心查询数据库类型实例

GET /v1/{project_id}/asset-center/database/instances

{
  "instance_type" : "RDS"
}

响应示例

状态码

状态码

描述

200

OK

401

未授权

403

禁止访问

404

未找到

错误码

请参见错误码

相关文档