In order to provide detailed descriptions of the various NAVER CLOUD PLATFORM services, and to facilitate use of various APIs, we offer [Manual] and [API reference] separately.
Monitoring API overview
NAVER CLOUD PLATFORM is a cloud service built with NAVER's latest computing technology and operation know-how.
NAVER CLOUD PLATFORM provides a set of application programming interfaces (APIs) which allows you to use some solution products among its various product categories.
NAVER CLOUD PLATFORM APIs are RESTful, using HTTP GET/POST methods.
Common
- {MONITORING_API_URL}
https://ncloud.apigw.ntruss.com/monitoring/v1
- Request header
Header | Description |
---|---|
x-ncp-apigw-timestamp | It is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference with the APIGW server is more than 5 minutes, the request is considered invalid. |
x-ncp-apigw-api-key | API 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-v1 | Signature used to encrypt the body of the example with the “secret key” that maps with the “access key.” The HMAC encryption algorithm is HMAC SHA256. |
API References
Monitoring
getMetricStatistics
API name
Get metric statistics
Action
getMetricStatistics
Description
- NAVER CLOUD PLATFORM periodically collects statistical information for each metric of (server) instances. This API is used to view such information.
Request parameters
Parameter | Brief Description | Type | Limitations | Required |
---|---|---|---|---|
instanceNoList | Server instance number | String | Min: 1, Max: 30 | Yes |
metricName | Metric name | String | Yes | |
startTime | Start time | Date | Yes | |
endTime | End time | Date | Yes | |
period | Period (sec.) | String | Yes |
- instanceNoList
- List of (server) instance numbers for which you want to view statistical information.
metricName
- Name of the metric for which you want to view statistical information.
The available values are as follows:
CPU Utilization (CPUUtilization) | Capacity to store data on disk (DiskWriteBytes) | Capacity to read data from disk (DiskReadBytes) | Number of transmit bits per second - Receive (NetworkIn) | Number of transmit bits per second - Send (NetworkOut)
startTime
- Start time from which you want to view statistical data.
It must be in the following format.
Format: yyyy-MM-dd'T'HH:mm:ssZ Example: 2013-07-25T17:50:00+0900, 2013-07-25T08:50:00Z
endTime
- End time to which you want to view statistical data.
It must be in the following format.
Format: yyyy-MM-dd'T'HH:mm:ssZ Example: 2013-07-25T17:50:00+0900, 2013-07-25T08:50:00Z
period
- Collection period of basic data for extracting statistical data.
The available collection periods are as follows:
Collection period Data retention period 1 minute 8 days 5 minutes 40 days 30 minutes 6 months 2 hours 2 years 1 day 5 years
Example
Request
{MONITORING_API_URL}/getMetricStatistics ?instanceNoList.1=68417 &metircName=CPUUtilization &startTime=2014-06-10T17:50:00+0900 &endTime=2014-06-10T18:50:00+0900 &period=1800
Response
<getMetricStatisticsResponse> <requestId>d3ea7fbd-9bff-4ff0-a2ef-78817575943e</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> <statistics> <statistic> <instanceNo>68417</instanceNo> <dataPoints> <label>CPUUtilization</label> <average>0.08812500000000001</average> <maximum>0.090833</maximum> <minimum>0.085417</minimum> <sum>0.17625000000000002</sum> <member> <timestamp>2014-06-10T09:00:00Z</timestamp> <average>0.090833</average> <unit>Percent</unit> </member> <member> <timestamp>2014-06-10T09:30:00Z</timestamp> <average>0.085417</average> <unit>Percent</unit> </member> </dataPoints> </statistic> </statistics> </getMetricStatisticsResponse>
getListMetrics
API name
Get metric list
Action
getListMetrics
Description
Gets metrics for which statistical information is provided.
Request parameters
Parameter Brief Description Type Limitations Required instanceNo Server instance number String Yes metricName Metric name String No instanceNo
- (Server) instance number for which you want to view statistical data.
metricName
- This parameter is used to check which metric is available for statistics information.
The available values are as follows:
CPU Utilization (CPUUtilization) | Capacity to store data on disk(DiskWriteBytes) | Capacity to read data from disk(DiskReadBytes) | Number of transmit bits per second - Receive(NetworkIn) | Number of transmit bits per second - Send (NetworkOut)
Example
Request
{MONITORING_API_URL}/getListMetric ?instanceNo=68417
Response
<getListMetricsResponse> <requestId>77122dd7-e61f-4f43-ba0b-f17a1b52b760</requestId> <returnCode>0</returnCode> <returnMessage>success</returnMessage> <metrics> <member> <instanceNo>68417</instanceNo> <metricName>CPUUtilization</metricName> </member> <member> <instanceNo>68417</instanceNo> <metricName>DiskReadBytes</metricName> </member> <member> <instanceNo>68417</instanceNo> <metricName>DiskWriteBytes</metricName> </member> <member> <instanceNo>68417</instanceNo> <metricName>NetworkIn</metricName> </member> <member> <instanceNo>68417</instanceNo> <metricName>NetworkOut</metricName> </member> </metrics> </getListMetricsResponse>