Help Center/ Data Security Center/ API Reference/ API Description/ Asset Management/ Querying Database Instances in the Asset Center
Updated on 2026-01-13 GMT+08:00

Querying Database Instances in the Asset Center

Function

This API is used to obtain the database instance list.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

project_id

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

instance_type

Yes

String

Database instance type.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

Total number of instances.

instance_list

Array of InstanceEntity objects

Basic information list of an instance.

instances

Array of DbInstanceInfo objects

List of instance details.

Table 4 InstanceEntity

Parameter

Type

Description

address

String

Network address of an instance, which is used to identify the instance location.

bind_database

Integer

Number of databases bound to an instance.

create_time

Long

Time when an instance is created.

db_type

String

Database type, which indicates the database type supported by an instance.

default_database

String

Default database name, which indicates the database used by the instance by default.

id

String

Unique identifier of an instance.

ins_id

String

Unique identifier of an instance.

ins_name

String

Name of an instance.

ins_status

String

Instance status. For example, ACTIVE indicates that the instance is running.

ins_type

String

Instance type. For example, PUB indicates a public instance.

ipv6_address

String

IPv6 address of an instance. It identifies the IPv6 network location of the instance.

is_external

Boolean

Whether an instance is an external instance, that is, whether the instance is located in an external network.

port

Integer

Network port of an instance.

project_id

String

Project ID, which uniquely identifies the project that an instance belongs to.

security_group_id

String

Security group ID, which uniquely identifies the security group that an instance belongs to.

service_name

String

Service name, which identifies the service that an instance belongs to.

sid

String

Session ID, which identifies the session of an instance.

subnet_id

String

Subnet ID, which uniquely identifies the subnet that an instance belongs to.

version

String

Instance version, which indicates the software version of an instance.

vpc_id

String

Unique identifier of the VPC that an instance belongs to.

Table 5 DbInstanceInfo

Parameter

Type

Description

bind_database

Integer

Number of databases bound to an instance.

create_time

String

Time when an instance is created.

datastore

Datastore object

Data storage object, which contains the data storage type and version.

ins_id

String

Unique identifier of an instance.

ins_name

String

Name of an instance.

kerberos_enabled

Boolean

Whether Kerberos authentication is enabled. It indicates whether the instance supports Kerberos authentication.

port

Integer

Network port of an instance.

private_ips

Array of strings

Private IP address list of an instance, which indicates the internal network addresses of the instance.

region

String

Region where an instance is located. It indicates the geographical location of the instance.

source_type

String

Source type of an instance, which indicates the creation source of the instance.

status

String

Instance status. For example, ACTIVE indicates that the instance is running.

type

String

Instance type, which indicates the instance category. For example, RDS indicates the Relational Database Service.

Table 6 Datastore

Parameter

Type

Description

type

String

Data storage type. For example, Mysql indicates the MySQL database.

version

String

Data storage version, which indicates the software version of data storage.

Example Requests

Query database instances in the asset center.

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

{
  "instance_type" : "RDS"
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

401

Unauthorized.

403

Access denied.

404

Not found.

Error Codes

See Error Codes.