Help Center/ Database Security Service/ API Reference/ API/ Audit Instance/ Querying Whether a Tenant's Instance Can Be Upgraded

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

View PDF

Querying Whether a Tenant's Instance Can Be Upgraded

Function

Query whether a tenant's instance can be upgraded.

URI

GET /v1/{project_id}/audit/upgrade/status

**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

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 Determined by the value of the IAM API used for querying user tokens. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
audit_upgrade_infos	Array of AuditUpgradeStatus objects	Instance upgrade information

**Table 4** AuditUpgradeStatus
Parameter	Type	Description
current_version	String	Source Version
instance_id	String	Instance ID
status	Integer	Alarm status. 0: being upgraded 1: The upgrade is not performed when the conditions are met. 2: The upgrade conditions are not met.
steps	Array of AuditUpgradeStep objects	Upgrade process
total	Integer	Capacity
upgrade_version	String	Upgrade version

**Table 5** AuditUpgradeStep
Parameter	Type	Description
msg	String	Message
result_code	String	Result code
step_name	String	Step name.
time	String	Upgrade time

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: 401

**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: 403

**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

Status code: 500

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

Example Requests

/v1/{project_id}/audit/upgrade/status

Example Responses

Status code: 200

{
  "audit_upgrade_infos" : [ {
    "instance_id" : "5ac5856d-5c40-431d-98cc-1501eb7d8e11",
    "current_version" : "25.07.21.163957",
    "status" : 2,
    "total" : 1
  } ]
}