Help Center/ Database Security Service/ API Reference/ API/ Auditing a Database/ Querying the Database List
Updated on 2025-06-19 GMT+08:00
View PDF

Querying the Database List

Function

This API is used to query the database list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/{instance_id}/dbss/audit/databases

Table 1 URI parameter

Parameter

Mandatory

Parameter Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID. You can obtain the value from the ID field in the API for querying the instance list.
Table 2 Query parameter

Parameter

Mandatory

Parameter Type

Description

status

No

String

Instance status.

  • ON
  • OFF

offset

No

String

Offset. The query starts after the first data record offsets the number of data records. The default value is 0.

limit

No

String

Number of query records. The default value of this parameter is 100.

Request Parameter

Table 3 Request header parameter

Parameter

Mandatory

Parameter Type

Description

X-Auth-Token

Yes

String

User token. The token can be queried by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Parameter Type

Description

databases

Array of DataBaseBean objects

Database list

total

Integer

Total number
Table 5 DataBaseBean

Parameter

Parameter Type

Description

database

DataBase object

Database Information
Table 6 Database

Parameter

Type

Description

id

String

Database ID.

name

String

Database Name

type

String

Type of the database to be added. The value can be:

  • MYSQL
  • ORACLE
  • POSTGRESQL
  • SQLSERVER
  • DAMENG
  • TAURUS
  • DWS
  • KINGBASE
  • GAUSSDBOPENGAUSS
  • GREENPLUM
  • HIGHGO
  • SHENTONG
  • GBASE8A
  • GBASE8S
  • GBASEXDM
  • MONGODB
  • DDS

version

String

DB version.

charset

String

Database character set

  • GBK
  • UTF8

ip

String

Database IP Address

port

String

Database Port

os

String

Database OS

status

String

Database status. The value can be:

  • ON: enabled
  • OFF: disabled

instance_name

String

DB instance name

audit_status

String

Database status. The value can be:

  • ACTIVE
  • SHUTOFF
  • ERROR

agent_url

Array of strings

Unique ID of an agent

db_classification

String

Database classification. The value can be:

  • RDS: RDS database
  • ECS: self-built database

rds_audit_switch_mismatch

Boolean

The audit switch status of the RDS instance does not match. When the database audit function is enabled and the log upload function on RDS is disabled, the value of this field is true.

rds_id

String

ID of the RDS database.

rds_obj_info

String

RDS database information.

dws_obj_info

String

GaussDB(DWS) database information.

clouddb_obj_info

String

Cloud database information. This field has been discarded.

Status code: 400

Table 7 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 9 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 10 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 11 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 12 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

/v1/{project_id}/{instance_id}/dbss/audit/databases

Example Response

Status code: 200

Succeeded

{
  "databases" : [ {
    "database" : {
      "id" : "zLKv83gBCwCqSg3BJt0m",
      "name" : "db01",
      "type" : "MYSQL",
      "version" : "5.0",
      "charset" : "UTF8",
      "ip" : "192.168.0.204",
      "port" : "3306",
      "os" : "LINUX64",
      "status" : "OFF",
      "instance_name" : "",
      "audit_status" : null,
      "agent_url" : [ "zrKw83gBCwCqSg3Bkt1P" ],
      "db_classification" : "ECS",
    }
  } ]
  "total": 1
}

Status code: 400

Incorrect request parameter.

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status code: 500

Internal server error.

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status Code

Status Code

Description

200

Succeeded

400

Incorrect request parameter.

403

Authentication failed.

500

Internal server error.

Error Codes

For details, see Error Codes.

Parent topic: Auditing a Database