로그 조회

Classic/VPC 환경에서 이용 가능합니다.

Cloud Log Analytics 서비스에서 수집한 로그를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/api/{regionCode}-v1/logs/search

요청 헤더

Cloud Log Analytics API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Log Analytics 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`regionCode`	String	Required	리전 코드 `kr` \| `krs` `kr`: 수도권 `krs`: 남부권

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`interval`	String	Optional	조회 주기 `5m` (기본값) <예시> `1d`, `1h`, `1m`
`keyword`	String	Optional	조회 키워드 전체 검색 (기본값)
`logTypes`	String	Optional	로그 유형 전체 검색 (기본값) <예시> `SYSLOG`, `security_log`, `tomcat`
`timestampFrom`	String	Optional	조회 시작 일시 Unix Timestamp 형식
`timestampTo`	String	Optional	조회 종료 일시 Unix Timestamp 형식
`pageNo`	Integer	Optional	페이지 번호 1~100 (기본값: 1)
`pageSize`	Integer	Optional	페이지당 항목 수 10~100 (기본값: 10)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://cloudloganalytics.apigw.gov-ntruss.com/api/{regionCode}-v1/logs/search' \
--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' \
-date '{
  "interval": "30m",
  "pageNo": 1,
  "pageSize": 10
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`code`	Integer	-	응답 상태 코드
`message`	String	-	응답 상태 메시지
`result`	Object	-	응답 결과
`result.pageSize`	Integer	-	페이지당 항목 수
`result.currentPage`	Integer	-	현재 페이지 번호
`result.totalPage`	Integer	-	전체 페이지 번호
`result.totalCount`	Integer	-	전체 로그 수
`result.isPaged`	Boolean	-	추가 페이지 존재 여부 `true` \| `false` `true`: 존재 `false`: 존재 안 함
`result.chartData`	Array	-	로그 수 로그 발생 시간 Unix Timestamp 형식 로그 발생 수
`result.searchResult`	Array	-	조회 결과

`searchResult`

searchResult에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`logTime`	Integer	-	로그 발생 시간 Unix Timestamp 형식
`logType`	String	-	로그 유형
`servername`	String	-	로그 수집 대상 서버 이름
`logDetail`	String	-	로그 내용

응답 상태 코드

Cloud Log Analytics API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Log Analytics 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": 0,
    "message": "요청이 정상적으로 처리되었습니다",
    "result": {
        "pageSize": 3,
        "currentPage": 1,
        "totalPage": 1695,
        "totalCount": 5083,
        "isPaged": true,
        "chartData": [
            [
                1731987000000,
                2111
            ],
            [
                1731988800000,
                2620
            ],
            [
                1731990600000,
                352
            ]
        ],
        "searchResult": [
            {
                "logTime": "1731990853000",
                "logType": "CDB_MSSQL",
                "servername": "m-100514954-002",
                "logDetail": "select \r\n\tcase \r\n\t\twhen count(a.name) + count(b.name) = 0 then 'not exists'\r\n\t\twhen count(a.name) + count(b.name) = 1 then 'stop'\r\n\t\twhen count(a.name) + count(b.name) = 2 then 'start'\r\n\tend xe_status\r\nfrom sys.server_event_sessions a\r\n\tleft join sys.dm_xe_sessions b\r\n\ton a.name = b.name \r\nwhere a.name = 'AuditLog'"
            },
            {
                "logTime": "1731990847925",
                "logType": "ses_log",
                "servername": "{name=ses-test-m-62vl}",
                "logDetail": "[2024-11-19T13:34:07,621][WARN ][o.o.p.c.u.JsonConverter  ] [ses-test-m-62vl] Json Mapping Error: Cannot invoke \"java.lang.Long.longValue()\" because \"this.cacheMaxSize\" is null (through reference chain: org.opensearch.performanceanalyzer.collectors.CacheConfigMetricsCollector$CacheMaxSizeStatus[\"Cache_MaxSize\"])"
            },
            {
                "logTime": "1731990847000",
                "logType": "CDB_MSSQL",
                "servername": "m-100514954-001",
                "logDetail": "select \r\n\tcase \r\n\t\twhen count(a.name) + count(b.name) = 0 then 'not exists'\r\n\t\twhen count(a.name) + count(b.name) = 1 then 'stop'\r\n\t\twhen count(a.name) + count(b.name) = 2 then 'start'\r\n\tend xe_status\r\nfrom sys.server_event_sessions a\r\n\tleft join sys.dm_xe_sessions b\r\n\ton a.name = b.name \r\nwhere a.name = 'AuditLog'"
            }
        ]
    }
}