Get export history

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Get the history of exporting logs retrieved from the Cloud Log Analytics service to Object Storage.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/{regionCode}-v1/export/history

Request headers

For information about the headers common to all Cloud Log Analytics APIs, see Cloud Log Analytics request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`regionCode`	String	Required	Region code `kr` \| `sgn` \| `jpn` \| `uswn` \| `den` `kr`: Korea Region `sgn`: Singapore Region `jpn`: Japan Region `uswn`: US West Region `den`: Germany Region

Request query parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`pageNo`	Integer	Optional	Page number 1 - 100 (default: 1)
`pageSize`	Integer	Optional	Number of items per page 20 - 100 (default: 20)

Request example

The request example is as follows:

curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/export/history' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
-date '{
  "bucketname": "asdcx"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`code`	Integer	-	Response status codes
`message`	String	-	Response status message
`result`	Object	-	Response result
`result.pageSize`	Integer	-	Number of items per page
`result.currentPage`	Integer	-	Current page number
`result.totalPage`	Integer	-	Total page number
`result.totalCount`	Integer	-	Total item count
`result.isPaged`	Boolean	-	Whether additional pages exist `true` \| `false` `true`: It exists `false`: It doesn't exist
`result.exporthistoryInfo`	Array	-	Export history

`exporthistoryInfo`

The following describes exporthistoryInfo.

Field	Type	Required	Description
`start_ymdt`	Integer	-	Export date and time
`export_types`	String	-	Export type
`regionNo`	Integer	-	Region number
`bucketname`	String	-	Object Storage's bucket name
`folderName`	String	-	Folder name
`log_types`	String	-	Export log type
`status`	String	-	Export progress status
`progress`	String	-	Export progress (%)
`description`	String	-	Object Storage's bucket name

Response status codes

For response status codes common to all Cloud Log Analytics APIs, see Cloud Log Analytics response status codes.

Response example

The response example is as follows:

{
  "code": 0,
  "message": "The request has been successfully processed.",
  "result": {
    "pageSize": 10,
    "currentPage": 1,
    "totalPage": 3,
    "totalCount": 29,
    "isPaged": true,
    "exporthistoryInfo": [
      {
        "start_ymdt": "2024-11-19 03:30:30",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "CLA-20241119033030/",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": ""
      },
      {
        "start_ymdt": "2024-11-18 03:10:24",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-17 03:08:57",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-16 02:52:43",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-15 03:34:59",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-14 03:27:51",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-13 03:25:57",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-12 03:33:46",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-11 03:08:42",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      },
      {
        "start_ymdt": "2024-11-10 03:02:56",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "test.cla",
        "folderName": "",
        "log_types": "all",
        "status": "Complete",
        "progress": 100,
        "description": "No data"
      }
    ]
  }
}

Was this article helpful?

What's Next

Export

Table of contents

Request
Response