Help Center/ Database Security Service/ API Reference/ API Description/ Audit Instance/ Query the audit instance list.
Updated on 2026-04-20 GMT+08:00
View PDF
Share

Query the audit instance list.

Function

Query the audit instance list.

URI

GET /v2/{project_id}/audit/instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID You can obtain the value by calling the IAM API for querying the project list of a specified IAM user.

** Restrictions**:

N/A

Range:

The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters.

** Default value**:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

String

Definition:

Pagination offset. The query starts after the offset of the first data record.

Constraints

Only integers greater than or equal to 0 are supported.

Range:

Greater than or equal to 0

Default Value:

The default value is 0.

limit

No

String

Definition

Number of records queried on each page.

Constraints

Only integers greater than 0 are supported.

Range

Greater than 0 and less than or equal to 1000

Default Value

The default value is 100.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. The token can be queried by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

N/A

Value range:

You can obtain the value by calling the IAM API used to query a user token.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

instances

Array of AuditInstanceBean objects

Instance information list.

total

Integer

Total number.
Table 5 AuditInstanceBean

Parameter

Type

Description

charge_model

String

Billing mode. The options are as follows:

  • Period: yearly/monthly

  • Demand: on-demand.

comment

String

Remarks

config_num

Integer

Total number of configured databases.

connect_ip

String

Connection address.

connect_ipv6

String

IPv6 connection address.

cpu

Integer

CPUs

created

String

Creation time.

database_limit

Integer

Number of supported databases

effect

Integer

Instance result status. The value can be:

  • 1: The instance is frozen and can be released.

  • 2: frozen and cannot be released

  • 3: frozen and unrenewable

expired

String

Expiration time

id

String

ID

keep_days

String

Remaining period (days)

name

String

Instance alias.

new_version

String

If a value is returned, upgrade is required. If no value is returned, the value is null.

port_id

String

ID of the port to which the EIP is bound

ram

Integer

Memory

region

String

Region where the instance is located.

remain_days

String

Days to expiry

resource_id

String

Resource id

resource_spec_code

String

Instance Specifications

scene

String

Scene

security_group_id

String

Security Group

specification

String

Instance Specifications

status

String

Instance status.

  • SHUTOFF: disabled

  • ACTIVE: running. Any operation is allowed.

  • DELETING: The instance is being deleted. No operation is allowed.

  • BUILD: The instance is being created. No operation is allowed.

  • DELETED

  • ERROR: faulty. Only deletion is allowed.

  • HAWAIT: The standby is being created. No operation is allowed.

  • FROZEN: Frozen. Only renewal, binding, and unbinding are allowed.

  • UPGRADING: The instance is being upgraded. New upgrade operations are not allowed.

subnet_id

String

Subnet ID

task

String

Task status.

  • powering-on: The instance is being started and can be bound to or unbound.

  • powering-off: The instance is being shut down and can be bound to or unbound.

  • rebooting: The instance is being restarted and can be bound to or unbound.

  • delete_wait: The instance is waiting for deletion. No operations are allowed on the cluster or the instance.

  • NO_TASK: The task is not displayed.

version

String

Current instance version

vpc_id

String

Virtual Private Cloud

zone

String

Availability zone

supported_feature

Array of strings

Feature List

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.
Table 7 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.
Table 9 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.
Table 11 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v2/{project_id}/audit/instances

Example Responses

Status code: 200

Success

{
  "instances" : [ {
    "name" : "DBSS-Test",
    "comment" : "",
    "connect_ipv6" : null,
    "status" : "ACTIVE",
    "task" : "NO_TASK",
    "id" : "8c53ed03-8ed7-4ff2-ad97-7b2d6d1dd364",
    "specification" : "Low | 3 Proxy",
    "zone" : "cn-cmcc1a-01",
    "created" : "2021-04-21 04:37:54",
    "expired" : null,
    "subnet_id" : "97ef0bb5-3759-4db4-aa49-0d087ed49ce5",
    "cpu" : 4,
    "ram" : 16384,
    "region" : "cn-cmcc1",
    "version" : "21.04.16.164614",
    "charge_model" : "Demand",
    "remain_days" : null,
    "config_num" : 1,
    "effect" : null,
    "scene" : null,
    "connect_ip" : "192.168.0.229",
    "port_id" : "dc4bd420-e01c-4d12-a7ff-814f17c63079",
    "resource_id" : "062212d8-8e30-4783-9671-43f3f1f3bb1e",
    "vpc_id" : "76d98391-5abc-46ed-b8a8-f664202cb166",
    "security_group_id" : "f0fbec06-bcf6-4c7e-99fa-f0ddfbb1d9bd",
    "resource_spec_code" : "dbss.bypassaudit.low",
    "keep_days" : null,
    "new_version" : null,
    "database_limit" : 3
  } ],
  "total" : 1
}

Status Codes

Status Code

Description

200

Success

400

Failed

403

Authorization failed.

500

Server error.

Error Codes

See Error Codes.

Parent topic: Audit Instance