The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.
Overview
NAVER Cloud Platform is a cloud service built with NAVER's latest computing technology and operational know-how. The application program interface (API) that supports the use of services and solutions provided by NAVER Cloud Platform is called NAVER Cloud Platform API. NAVER Cloud Platform API is provided in the RESTful format, and is run by GET/POS method calls in the HTTP method.
It indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds. Request is considered invalid if the timestamp differs from the current time by more than 5 minutes
x-ncp-apigw-api-key
Key issued by API Gateway
x-ncp-iam-access-key
API key issued by NAVER Cloud Platform or access key issued by IAM
x-ncp-apigw-signature-v2
Signature signed by the secret key that matches the access key in the sample body above Use the HMAC-SHA256 encryption algorithm
Content-Type
Specify the request body content type as application/JSON
The APIs of Cloud Log Analytics have separate endpoints for each Region.
If you call the API of another Region, you must call the endpoint of that Region.
If the regionCode is different from the Region endpoint, it won't be processed.
Operations
View server list
API name
Description
getClassicServers
View Classic server list
getClassicServersMysql
View Classic CDB-MySQL server list
getClassicServersMssql
View Classic CDB-MSSQL server list
getClassicServersBaremetal
View Classic Baremetal server list
getVPCServers
View VPC server list
getVPCServersMysql
View VPC CDB-MySQL server list
getVPCServersMssql
View VPC CDB-MSSQL server list
getVPCServersMongoDB
View VPC CDB-MongoDB server list
getVPCServersPostgresql
View VPC CDB-PostgreSQL server list
getVPCServersBaremetal
View VPC Baremetal server list
getVPCServersSES
View VPC Search Engine Service server list
getVPCServersCDSS
View VPC Cloud Data Streaming Service server list
getVPCServersKubernetes
View VPC Ncloud Kubernetes Service server list
Set server log collection
API name
Description
postClassicServersCollectingInfos
Set Classic server log collection information
postVPCServersCollectingInfos
Set VPC server log collection information
setUpClassicCla
Install Classic Linux server agent
setUpClaVPC
Install VPC Linux server agent
setUpwinCla
Install Classic Windows Server agent
setUpwinClaVPC
Install VPC Windows Server agent
Disable server log collection
API name
Description
deleteClassicServerColleectingInfos
Disable Classic server log collection information
deleteVPCServerCollectingInfos
Disable VPC server log collection information
removeCla
Remove Classic Linux agent
removewinCla
Remove VPC Linux agent
removewinCla
Remove Classic Windows agent
View log count
API name
Description
getLogsCountTotal
View total log volume
getLogsCountRecent
View recent log volume
getLogsCountInterval
View log volume by period
getLogsCountAggregation
View log volume by type
Search log
API name
Description
getLogsSearch
Search log
View bucket list
API name
Description
getExportBuckets
View bucket list
View usage
API name
Description
getCapacity
View usage
Export log
API name
Description
postLogsSearchExport
Export log search results
View export history
API name
Description
getExportHistory
View export history
View automatic export settings
API name
Description
getExportConfig
View automatic export settings
Set automatic export
API name
Description
postExportConfig
Set automatic export
Disable automatic export
API name
Description
deleteExportConfig
Disable automatic export
Error response format
If a wrong API request is sent, or an error occurs during its processing, then the success/failure result is returned as an HTTP status code. The detailed message is then returned in the form of JSON.