Help Center/ Database Security Service/ API Reference/ API/ Audit Instance/ Querying Information About an Instance Creation Task

Updated on 2025-09-10 GMT+08:00

View PDF

Querying Information About an Instance Creation Task

Function

This API is used to query information about an instance creation task.

URI

GET /v1/{project_id}/audit/{resource_id}/jobs

**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 subject to the return value of the IAM service interface. The value contains 32 to 64 characters. Default Value: N/A
resource_id	Yes	String	Resource ID. You can obtain the value from resource_id in the API for querying the instance list.

Request Parameters

**Table 2** 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. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range: The value is subject to the user token query interface of the IAM service. Default Value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
jobs	Array of JobBean objects	Instance creation task list

**Table 4** JobBean
Parameter	Type	Description
job_id	String	Task ID.
status	String	Task status. The options are as follows: SUCCESS RUNNING FAIL INIT READY
job_type	String	Type
server_id	String	VM ID
server_name	String	VmName
resource_id	String	Resource id
begin_time	Long	Start time
end_time	Long	End time
charge_mode	String	Billing mode. The options are as follows: Period: period-based charging Demand: pay-per-use
error_code	String	Error Codes
fail_reason	String	Failure cause.
ha_id	String	Protected instance ID. This field has been discarded.
ha_name	String	Protected instance name. This field has been discarded.

Status code: 400

**Table 5** 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 6** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 7** 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 8** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 9** 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 10** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

/v1/{project_id}/audit/{resource_id}/jobs

Example Responses

Status code: 200

Success

{
  "jobs" : [ {
    "resource_id" : "2c154fdd-0d43-47b7-9cf1-5236bf6a2ca7",
    "status" : "SUCCESS",
    "job_type" : null,
    "job_id" : "8abf9647852a1daa01852e517e1a1a0b",
    "begin_time" : 1671519371000,
    "end_time" : 1671519417000,
    "error_code" : null,
    "fail_reason" : null,
    "charge_mode" : "Demand",
    "server_name" : "DBSS-qct-1220",
    "server_id" : "0aa8f621-bc19-4822-b66d-7ab9ae3c8693",
    "ha_id" : null,
    "ha_name" : null
  } ]
}