Updating Audit Instance Information

This API is used to update audit instance information.

For details, see Calling APIs.

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

**Table 1** URI parameter
Parameter	Mandatory	Parameter Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID. You can obtain the value from the ID field in the API for querying the instance list.

**Table 2** 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.)

**Table 3** Request body parameter
Parameter	Mandatory	Parameter Type	Description
name	No	String	Instance name. The value can contain a maximum of 64 characters, including letters, numbers, underscores (_), and hyphens (-). It cannot be an empty string.
comment	No	String	Instance description. The value can contain a maximum of 255 characters, including letters, numbers, underscores (_), hyphens (-), and spaces. This field can be left blank.

Status code: 200

**Table 4** Response body parameters
Parameter	Parameter Type	Description
result	String	Response status

Status code: 400

**Table 5** Response body parameters
Parameter	Parameter Type	Description
error	Object	Error message.

**Table 6** ErrorDetail
Parameter	Parameter Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 403

**Table 7** Response body parameter
Parameter	Parameter Type	Description
error	Object	Error message.

**Table 8** ErrorDetail
Parameter	Parameter Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 9** Response body parameter
Parameter	Parameter Type	Description
error	Object	Error message.

**Table 10** ErrorDetail
Parameter	Parameter Type	Description
error_code	String	Error code
error_msg	String	Error message

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

{
  "name" : "DBSS-test1"
}

Status code: 400

Failed

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

For details, see Error Codes.

Parent topic: Audit Instance

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.