View OS monitoring data
- Print
- PDF
View OS monitoring data
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Can be used in a VPC environment.
Description
View the OS monitoring data for servers.
Requests
Request URL
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getOsMonitoringData/{service-group-instance-no}
?computeInstanceNo={computeInstanceNo}
&interval={interval}
&metric={metric}
&timeEnd={timeEnd}
&timeStart={timeStart} [KR]
GET https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/monitoring/getOsMonitoringData/{service-group-instance-no}
?computeInstanceNo={computeInstanceNo}
&interval={interval}
&metric={metric}
&timeEnd={timeEnd}
&timeStart={timeStart} [SGN]
GET https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/monitoring/getOsMonitoringData/{service-group-instance-no}
?computeInstanceNo={computeInstanceNo}
&interval={interval}
&metric={metric}
&timeEnd={timeEnd}
&timeStart={timeStart} [JPN]
Request header
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | Number of milliseconds that have elapsed since January 1, 1970 00:00:00. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. x-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | Value of Access Key ID issued on Naver Cloud Platform portalx-ncp-iam-access-key:{Account Access Key} |
| x-ncp-apigw-signature-v2 | Signature encrypted with the Access Key ID value and Secret Keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| Content-Type | Specifies the request body content type as application/jsonContent-Type: application/json |
Request parameters
| Parameter | Type | Requirement status | Description |
|---|---|---|---|
| serviceGroupInstanceNo | String | Y | Cluster number to be searched |
| timeStart | Long | Y | Search start time (milliseconds) |
| timeEnd | Long | Y | Search end time (milliseconds) |
| metric | String | Y | Metric name to be searched |
| computeInstanceNo | String | Y | Compute instance number of the server to be searched |
| interval | String | N | Aggregation interval (default: Min1) |
- OS Metric
| Metric | Description |
|---|---|
| OS_ALL_METRICS | All Metrics of OS |
- Interval
| Metric | Description |
|---|---|
| Min1 | Search every minute (maximum one day) |
| Min5 | Search every 5 minutes (maximum one week) |
| Min30 | Search every 30 minutes (maximum one month) |
| Hour2 | Search every 2 hours (maximum 3 months) |
| Day1 | Search everyday (maximum one year) |
Request example
GET https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getOsMonitoringData/1768175
?computeInstanceNo=2416997
&metric=OS_ALL_METRICS
&timeEnd=1657590447000
&timeStart=1657586847000
HOST: vpcsearchengine.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1593848345548
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw
curl -X GET "https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getOsMonitoringData/1768175
?computeInstanceNo=2416997
&metric=OS_ALL_METRICS
&timeEnd=1657590447000
&timeStart=1657586847000 \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
-H "x-ncp-apigw-timestamp: 1601971222179" \
-H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4="
Response parameters
public class QueryDataResponseVo {
List<MetricInfoResponseVo> data;
}
public class MetricInfoResponseVo{
List<ArrayList<Object>> dps;
String aggregation;
DimensionsVo dimensions;
String interval;
String metric;
String graphName;
String productName;
}
public class DimensionsVo {
@JsonProperty("Svc_group_instance_no")
String serviceGroupInstanceNo;
String instanceNo;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| data | List | Information of monitoring data |
| dps | List<ArrayList | Monitoring information (timestamp, data format) |
| aggregation | String | Aggregation functions of the searched data |
| dimensions | DimensionsVo | Separators of the searched data |
| interval | String | Aggregation interval of the searched data |
| metric | String | Name of the searched metric |
| graphName | String | Graph name |
| productName | String | Product name |
| serviceGroupInstanceNo | String | Service group instance number of the searched cluster |
| instanceNo | String | Compute instance number of the searched server |
Response example
{
"code": 0,
"message": "SUCCESS",
"result": {
"data": [
{
"dps": [
[
1626315360000,
0.01306
],
[
1626315420000,
0.01306
],
[
1626315480000,
0.01306
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "wait i/o",
"graphName": "CPU Usage(%)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
0.19299
],
[
1626315420000,
0.19299
],
[
1626315480000,
0.19299
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "user",
"graphName": "CPU Usage(%)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
0.2799
],
[
1626315420000,
0.2799
],
[
1626315480000,
0.2799
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "total",
"graphName": "CPU Usage(%)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
0.07385
],
[
1626315420000,
0.07385
],
[
1626315480000,
0.07385
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "kernel",
"graphName": "CPU Usage(%)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
0.05
],
[
1626315420000,
0.05
],
[
1626315480000,
0.05
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "load_15",
"graphName": "Load Average",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
0.01
],
[
1626315420000,
0.01
],
[
1626315480000,
0.01
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "load_5",
"graphName": "Load Average",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
0
],
[
1626315420000,
0
],
[
1626315480000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "load_1",
"graphName": "Load Average",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
56.86386
],
[
1626315420000,
56.86386
],
[
1626315480000,
56.86386
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "usage",
"graphName": "Memory Usage(%)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
0
],
[
1626315420000,
0
],
[
1626315480000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "swap_mem",
"graphName": "Swap(%)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
4.4295235
],
[
1626315420000,
4.4295235
],
[
1626315480000,
4.429638
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "used",
"graphName": "Disk Used(GB)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
0
],
[
1626315420000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "read",
"graphName": "Disk I/O(MB / sec)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
0
],
[
1626315420000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "write",
"graphName": "Disk I/O(MB / sec)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
4.1667
],
[
1626315420000,
4.1667
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "send",
"graphName": "Network I/O(MB / sec)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
4.1667
],
[
1626315420000,
4.1667
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "receive",
"graphName": "Network I/O(MB / sec)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
1.13574
],
[
1626315420000,
1.13574
],
[
1626315480000,
1.13574
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "free",
"graphName": "Free Memory(GB)",
"productName": "Search Engine Service(VPC)"
},
{
"dps": [
[
1626315360000,
43.54509
],
[
1626315420000,
43.54509
],
[
1626315480000,
43.544975
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1768176",
"Svc_group_instance_no": "1768175"
},
"interval": "Min1",
"metric": "free",
"graphName": "Free Storage Space(GB)",
"productName": "Search Engine Service(VPC)"
}
]
},
"requestId": "36f7336f-8236-4b05-aa52-3d2ca1c3d370"
}
Was this article helpful?