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

Querying Authorized Databases of a Database Instance in the Asset Center

Function

Query authorized databases of a database instance.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/asset-center/database/authorized-databases

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

Instance type.

limit

No

Integer

Maximum number of returned results.

offset

No

Integer

Offset of the returned result.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

databases

Array of DBResponse objects

Database information list, which contains all databases that meet the search criteria.

total

Integer

Total number of databases that meet the search criteria.

Table 4 DBResponse

Parameter

Type

Description

asset_name

String

Asset name.

auth_type

String

Authorization type, which indicates the access permission type of a database.

authorize_fail_reason

String

Authorization failure cause (in the case of an authorization failure).

authorized

Boolean

Whether the database has obtained the access permission.

create_time

Long

Timestamp when a database is created.

db_address

String

Network address of a database, which indicates the network location of the database.

db_authorized

String

Authorization status of a database.

db_name

String

Database name.

db_port

Integer

Network port of a database.

db_type

String

Database type. For example, Mysql indicates the MySQL database.

db_user

String

Database username, which is the username for accessing a database.

db_version

String

Database version, which indicates the software version of a database.

default

Boolean

Whether the database is the default database.

id

String

Unique identifier of the database.

ins_id

String

Unique identifier of the instance.

ins_name

String

Name of the instance.

ins_type

String

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

region

String

Region where the instance is located.

service_name

String

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

sid

String

Session ID, which identifies the session of the instance.

subnet_ids

Array of strings

Subnet ID list, which indicates the subnet identifiers of the database.

vpc_ids

Array of strings

VPC ID list, which indicates the VPC identifiers of the database.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

401

Unauthorized.

403

Access denied.

404

Not found.

Error Codes

See Error Codes.