Querying Audit Records of Parameter Modifications

Function

This API is used to query audit records of parameter modifications.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/clusters/{cluster_id}/configurations/audit-records

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
cluster_id	Yes	String	Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints The value must be a valid DWS cluster ID. Range It is a 36-digit UUID. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
action_time	No	Long	Definition Task time. Constraints N/A Range N/A Default Value N/A
filter_by	No	String	Definition Filter criteria. Constraints N/A Range N/A Default Value N/A
filter	No	String	Definition Filter content. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Size of a single page. Constraints N/A Range Greater than 0 Default Value 10
offset	No	Integer	Definition Page offset, which starts from 0 (page number minus 1). Constraints N/A Range Greater than or equal to 0 Default Value 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
records	Array of ConfigurationRecordResp objects	Definition Records. Range N/A
count	Integer	Definition Total number. Range N/A

**Table 4** ConfigurationRecordResp
Parameter	Type	Description
id	String	Definition Record ID. Range N/A
operator	String	Definition Action name. Range N/A
start_time	String	Definition Start time. Range N/A
end_time	String	Definition End time. Range N/A
status	String	Definition Status. Range N/A
failed_reason	String	Definition Failure cause. Range N/A

Example Requests

GET https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/configurations/audit-records

Example Responses

Status code: 200

Query succeeded.

{
  "records" : [ {
    "id" : 1,
    "operator" : null,
    "start_time" : "2023-06-10T16:23:21.000Z",
    "end_time" : null,
    "status" : null,
    "failed_reason" : null
  }, {
    "id" : 2,
    "operator" : null,
    "start_time" : "2023-06-10T16:23:32.000Z",
    "end_time" : null,
    "status" : null,
    "failed_reason" : null
  } ],
  "count" : 10
}

Status Codes

Status Code	Description
200	Query succeeded.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.