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

Querying the Audit Instance List

Function

This API is used to query the audit instance list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/dbss/audit/instances

Table 1 URI parameter

Parameter

Mandatory

Parameter Type

Description

project_id

Yes

String

Project ID.
Table 2 Query parameter

Parameter

Mandatory

Parameter Type

Description

offset

No

String

Offset

limit

No

String

Number of query records.

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

servers

Array of AuditInstanceListBean objects

Querying the instance information list

total

Integer

Total number
Table 5 AuditInstanceListBean

Parameter

Parameter Type

Description

charge_model

String

Billing mode

  • Period
  • Demand

comment

String

Remarks

config_num

Integer

Total number of databases configured for the current instance.

connect_ip

String

IPv4 address of the tenant NIC attached to the instance.

connect_ipv6

String

IPv6 address of the tenant NIC attached to the instance.

cpu

Integer

CPUs

created

String

Creation time

database_limit

Integer

Number of supported databases

effect

Integer

Instance frozen status. The value can be:

  • 1: The instance is frozen and can be released.
  • 2: The instance is frozen and cannot be released.
  • 3: The instance is frozen and cannot be renewed.

expired

String

Expiration time.

id

String

ID

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 specification ID

scene

String

Scenario

security_group_id

String

Security Group

specification

String

Specification Type

status

String

Instance status.

  • SHUTOFF: The instance is shut down.
  • ACTIVE: The instance is running.
  • DELETING: The instance is being deleted. No operations are allowed.
  • BUILD: The instance is being created. No operations are allowed.
  • DELETED: The instance is deleted and does not need to be displayed.
  • ERROR: The instance is faulty. The instance can only be deleted. No other operations are allowed.
  • HAWAIT: The standby is being created. No operations are allowed.
  • FROZEN: The instance is frozen. Only renewal, binding, and unbinding operations 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

VPC

zone

String

AZ

Status code: 400

Table 6 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 7 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 8 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 9 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 10 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 11 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Example request

/v1/{project_id}/dbss/audit/instances

Example Response

Status code: 200

Succeeded

{
  "servers" : [ {
    "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 code: 400

Failed

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

Status Code

Status Code

Description

200

Success

400

Failed

403

Authentication failed.

500

Server error.

Error Codes

For details, see Error Codes.

Parent topic: Audit Instance