Stopping an Audit Instance

This API is used to disable an audit instance.

For details, see Calling APIs.

POST /v1/{project_id}/dbss/audit/instance/stop

**Table 1** URI parameter
Parameter	Mandatory	Parameter Type	Description
project_id	Yes	String	Project ID.

**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
instance_id	Yes	String	Instance ID. You can obtain the value from the ID field in the API for querying the instance list.

Status code: 200

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

Status code: 400

**Table 5** Response body parameter
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/instance/stop

{
  "instance_id" : "1d07f606-92d2-441c-b05c-dca47e180552"
}

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.