Set automatic export

Prev Next

Available in Classic and VPC

Set automatic export for logs retrieved from the Cloud Log Analytics service.

Request

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

Method URI
POST /api/{regionCode}-v1/export/config

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
exportBucket Integer Required Object Storage's bucket name
logTypes String Required Log type
regionNo Integer Required Region number
obsPathType String Optional Automatic export path
  • 2 (default) | 3
    • 2: /CLA/AutoExport/{logtype}/{YYYY}/{MM}/{DD}/{logtype}{hh}.json.gz
    • 3: /CLA/AutoExport/{YYYY}/{MM}/{DD}/{logtype}{hh}.json.gz

Request example

The request example is as follows:

curl --location --request POST 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/export/config' \
--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' \
--data '{
  "exportBucket": "asdcx",
  "logTypes": [
    "all"
  ],
  "regionNo": "1",
  "obsPathType": "2"
}'

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 String - Response result

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