개요
네이버 클라우드 플랫폼은 NAVER의 최신 컴퓨팅 기술과 운영 노하우가 축적된 클라우드 서비스입니다.
네이버 클라우드 플랫폼에서 제공하는 서비스와 솔루션을 활용할 수 있도록 지원하는 응용 프로그램 인터페이스(API)를 네이버 클라우드 플랫폼 API라고 합니다.
네이버 클라우드 플랫폼 API는 RESTful 형태로 제공됩니다. HTTP 방식의 GET/POST 메서드 호출을 통해서 이루어집니다.
공통 설정
API URL
https://cloudloganalytics.apigw.gov-ntruss.com/api/{regionCode}-v1/
요청 헤더
헤더명 | 설명 |
---|
x-ncp-apigw-timestamp | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 |
x-ncp-apigw-api-key | API Gateway에서 발급받은 키 |
x-ncp-iam-access-key | 네이버 클라우드 플랫폼에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey |
x-ncp-apigw-signature-v1 | 위 예제의 Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명 HMAC 암호화 알고리즘은 HmacSHA256 사용 |
요청헤더 값 생성하기는 NAVER Cloud Platform 공통가이드
regionCode
도메인 | 리전 | regionCode |
---|
공공 | KR | kr |
| KRS | krs |
- Cloud Log Analytics의 api는 리전별 endpoint가 분리되어 있습니다.
- 다른 리전의 api를 호출하실 경우 해당 리전의 endpoint를 호출하여야 합니다.
- 리전별 endpoint와 regionCode가 다를 경우 처리 되지 않습니다.
오퍼레이션
서버 목록 조회
API명 | 설명 |
---|
getClassicServers | 클래식 서버 목록 조회 |
getClassicServersMysql | Classic CDB-MySQL 서버 목록 조회 |
getClassicServersMssql | Classic CDB-MSSQL 서버 목록 조회 |
getClassicServersBaremetal | Classic Baremetal 서버 목록 조회 |
getVPCServers | VPC 서버 목록 조회 |
getVPCServersMysql | VPC CDB-MySQL 서버 목록 조회 |
getVPCServersMssql | VPC CDB-MSSQL 서버 목록 조회 |
getVPCServersMongoDB | VPC CDB-MongoDB 서버 목록 조회 |
getVPCServersPostgresql | VPC CDB-PostgreSQL 서버 목록 조회 |
getVPCServersBaremetal | VPC Baremetal 서버 목록 조회 |
getVPCServersSES | VPC Search Engine Service 서버 목록 조회 |
getVPCServersCDSS | VPC Cloud Data Streaming Service 서버 목록 조회 |
getVPCServersKubernetes | VPC Ncloud Kubernetes Service 서버 목록 조회 |
서버 로그 수집 설정
API명 | 설명 |
---|
postClassicServersCollectingInfos | Classic 서버 로그 수집 정보 설정 |
postVPCServersCollectingInfos | VPC 서버 로그 수집 정보 설정 |
setUpClassicCla | Classic Linux 서버 agent 설치 |
setUpClaVPC | VPC Linux 서버 agent 설치 |
setUpwinCla | Classic Windows 서버 agent 설치 |
setUpwinClaVPC | VPC Windows 서버 agent 설치 |
서버 로그 수집 해제
API명 | 설명 |
---|
deleteClassicServerColleectingInfos | Classic 서버 로그 수집 정보 해제 |
deleteVPCServerCollectingInfos | VPC 서버 로그 수집 정보 해제 |
removeCla | Classic Linux agent 제거 |
removewinCla | VPC Linux agent 제거 |
removewinCla | Classic Windows agent 제거 |
로그 개수 조회
API명 | 설명 |
---|
getLogsCountTotal | 총 발생 로그량 조회 |
getLogsCountRecent | 최근 로그량 조회 |
getLogsCountInterval | 기간별 로그량 조회 |
getLogsCountAggregation | 타입별 로그량 조회 |
로그 검색
버킷 목록 조회
API명 | 설명 |
---|
getExportBuckets | 버킷 목록 조회 |
사용량 조회
로그 내보내기
API명 | 설명 |
---|
postLogsSearchExport | 로그 검색 결과 내보내기 |
내보내기 이력 조회
API명 | 설명 |
---|
getExportHistory | 내보내기 이력 조회 |
자동 내보내기 설정 조회
API명 | 설명 |
---|
getExportConfig | 자동 내보내기 설정 조회 |
자동 내보내기 설정
API명 | 설명 |
---|
postExportConfig | 자동 내보내기 설정 |
자동 내보내기 해제
API명 | 설명 |
---|
deleteExportConfig | 자동 내보내기 해제 |
에러 응답 형식
API 요청이 잘못되었거나 처리 도중 오류가 발생하면 HTTP 상태코드로 성공/실패를 반환하고 JSON 형식으로 상세 메시지를 반환합니다.
응답 예시
{
"error": {
"errorCode": "integer",
"message": "string"
}
}
의견을 보내 주셔서 감사합니다! 우리 팀이 당신에게 돌아갈 것입니다.