Querying Log Records
Function
This API is used to query audit logs.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/audit-log-records
| 
         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  | 
      
Request Parameters
None
Response Parameters
Status code: 200
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         records  | 
       
         Array of AuditDumpRecord objects  | 
       
         Definition Audit log list. Range N/A  | 
      
| 
         cluster_id  | 
       
         String  | 
       
         Definition Cluster ID. Range It is a 36-digit UUID.  | 
      
| 
         count  | 
       
         Integer  | 
       
         Definition Total number. Range N/A  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         cluster_id  | 
       
         String  | 
       
         Definition Cluster ID. Range It is a 36-digit UUID.  | 
      
| 
         executor_time  | 
       
         String  | 
       
         Definition Execution time. Range N/A  | 
      
| 
         begin_time  | 
       
         String  | 
       
         Definition Start time. Range N/A  | 
      
| 
         end_time  | 
       
         String  | 
       
         Definition End time. Range N/A  | 
      
| 
         bucket_name  | 
       
         String  | 
       
         Definition Bucket name. Range N/A  | 
      
| 
         location_prefix  | 
       
         String  | 
       
         Definition Prefix. Range N/A  | 
      
| 
         result  | 
       
         String  | 
       
         Definition Results. Range N/A  | 
      
| 
         failed_reason  | 
       
         String  | 
       
         Definition Failure cause. Range N/A  | 
      
Example Requests
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/audit-log-records
  Example Responses
Status code: 200
Query succeeded.
{
  "records" : [ {
    "result" : "RUNNING",
    "cluster_id" : "a07cb2f7-b17e-4d95-923b-a33d0c884d37",
    "executor_time" : "2022-10-31T09:11:31",
    "begin_time" : "2022-10-31T09:09:55",
    "end_time" : "2022-10-31T09:19:55",
    "bucket_name" : "testbucket",
    "location_prefix" : "test"
  } ],
  "count" : 1,
  "cluster_id" : "a07cb2f7-b17e-4d95-923b-a33d0c884d37"
}
  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.  | 
      
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.