Export

Prev Next

Available in Classic and VPC

Export logs queried in the Cloud Log Analytics service to Object Storage.

Request

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

Method URI
POST /api/{regionCode}-v1/logs/search/export

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 body

You can include the following data in the body of your request:

Field Type Required Description
bucketname String Required Object Storage's bucket name
keyword String Optional Query keyword
  • Search all (default).
logTypes String Optional Log type
  • Search all (default).
  • Example: SYSLOG, security_log, tomcat
timestampFrom String Optional Query start date and time
  • now-1h (default)
  • Unix timestamp format
  • Example: 1720828861
timestampTo String Optional Query end date and time
  • now (default)
  • Unix timestamp format
  • Example: 1720828861
regionNo Integer Optional Region number

Request example

The request example is as follows:

curl --location --request POST 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/logs/search/export' \
--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 Boolean - Response result
  • true | false
    • true: succeeded
    • false: failed

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": true
}