Get automatic export settings

Prev Next

Available in Classic and VPC

Get the history of automatic export settings 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
GET /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 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/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 'Accept: application/json' \

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.exportConfigInfo Array - Automatic export settings history

exportConfigInfo

The following describes exportConfigInfo.

Field Type Required Description
startymdt Integer - Automatic export settings date and time
exportStatus String Required Automatic export settings status
regionNo Integer - Region number
exportBucket String - Object Storage's bucket name
logTypes String - Automatic export log type
obsPathType String - Automatic export storage path

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": 1,
    "totalCount": 1,
    "isPaged": true,
    "exportConfigInfo": [
      {
        "configKey": "5338e2fabd0a4070af67013e61adccbf",
        "start_ymdt": "2025-01-06 16:25:44",
        "export_types": "Auto",
        "regionNo": "1",
        "bucketName": "catalog-cdbmy",
        "folderName": null,
        "log_types": "Application,SYSLOG",
        "obsPathType": 3
      }
    ]
  }
}