Querying the Audit Instance List

Function

Query the audit instance list.

URI

GET /v1/{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]. Constraints N/A Range The value is determined by the value of the IAM API. 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 10000 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. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header. Constraints N/A Range Determined by the value of the IAM API used for querying user tokens. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
servers	Array of AuditInstanceListBean objects	Instance information list.
total	Integer	Total number of license files

**Table 5** AuditInstanceListBean
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 options are as follows: 1: frozen and can be released 2: frozen and cannot be released 3: Frozen accounts cannot be renewed.
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 specification ID
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 resource is being deleted. No operation is allowed. BUILD: The VM is being created. No operation is allowed. DELETED: deleted and does not need to be displayed. ERROR: faulty. Only deletion is allowed. HAWAIT: The standby node is being created. No operation is allowed. FROZEN: Frozen. Only renewal, binding, and unbinding are allowed. UPGRADING: The upgrade is in progress and is not allowed.
subnet_id	String	Subnet ID
task	String	Task status. The options are as follows: powering-on: The instance is being powered on and can be bound or unbound. powering-off: The instance is being powered off and can be bound or unbound. rebooting: The instance is being restarted. The instance can be bound or unbound. delete_wait: The cluster is waiting to be deleted. No operation can be performed on the cluster and instance. NO_TASK: no
version	String	Current instance version
vpc_id	String	Virtual Private Cloud
zone	String	Availability zone

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

/v1/{project_id}/audit/instances

Example Responses

Status code: 200

Success

{
  "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
}