OS Monitoring data inquiry
- Print
- PDF
OS Monitoring data inquiry
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Description
View the OS monitoring data for servers.
Requests
Request URL
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/monitoring/getOsMonitoringData/{service-group-instance-no} [KR]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/sgn-v1/monitoring/getOsMonitoringData/{service-group-instance-no} [SGN]
POST https://clouddatastreamingservice.apigw.ntruss.com/api/jpn-v1/monitoring/getOsMonitoringData/{service-group-instance-no} [JPN]
Request header
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. 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 | Access key ID value issued on the 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 | OS All Metrics |
- Interval
| Metric | Description |
|---|---|
| Min1 | Search every minute (up to one day) |
| Min5 | Search every 5 minutes (up to one week) |
| Min30 | Search every 30 minutes (up to one month) |
| Hour2 | Search every 2 hours (up to 3 months) |
| Day1 | Search every day (up to one year) |
Request example
POST https://clouddatastreamingservice.apigw.ntruss.com/api/v1/monitoring/getOsMonitoringData/1773271
HOST: clouddatastreamingservice.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
{
"timeEnd": "1626240000000",
"timeStart": "1626239850000",
"metric": "OS_ALL_METRICS",
"computeInstanceNo": "1773272",
"interval" : "Min1"
}
curl -X POST "https://clouddatastreamingservice.apigw.ntruss.com/api/v1/monitoring/getOsMonitoringData/1773271 \
-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=" \
-d \
'{
"timeEnd": "1626240000000",
"timeStart": "1626239850000",
"metric": "OS_ALL_METRICS",
"computeInstanceNo": "1773272",
"interval" : "Min1"
}'
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 {
String instanceNo;
}
Field
| Parameter name | Type | Description |
|---|---|---|
| data | List | Monitoring data information |
| 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 |
| instanceNo | String | Compute instance number of the searched server |
Response example
{
"code": 0,
"message": "SUCCESS",
"result": {
"data": [
{
"dps": [
[
1626239880000,
0.00602
],
[
1626239940000,
0.00602
],
[
1626240000000,
0.00602
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "wait i/o",
"graphName": "CPU Usage(%)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0.22452
],
[
1626239940000,
0.22452
],
[
1626240000000,
0.22453
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "user",
"graphName": "CPU Usage(%)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0.32506
],
[
1626239940000,
0.32506
],
[
1626240000000,
0.32507
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "total",
"graphName": "CPU Usage(%)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0.09452
],
[
1626239940000,
0.09452
],
[
1626240000000,
0.09452
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "kernel",
"graphName": "CPU Usage(%)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0.05
],
[
1626239940000,
0.05
],
[
1626240000000,
0.05
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "load_15",
"graphName": "Load Average",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0.01
],
[
1626239940000,
0.01
],
[
1626240000000,
0.01
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "load_5",
"graphName": "Load Average",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "load_1",
"graphName": "Load Average",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
30.26428
],
[
1626239940000,
30.26428
],
[
1626240000000,
30.23586
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "usage",
"graphName": "Memory Usage(%)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0
],
[
1626239940000,
0
],
[
1626240000000,
0
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "swap_mem",
"graphName": "Swap(%)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
2.64788
],
[
1626239940000,
2.64788
],
[
1626240000000,
2.64788
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "used",
"graphName": "Disk Used(GB)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0.0001
],
[
1626239940000,
0.0001
],
[
1626240000000,
0.0001
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "read",
"graphName": "Disk I/O(MB / sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0.00264
],
[
1626239940000,
0.0016
],
[
1626240000000,
0.00183
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "write",
"graphName": "Disk I/O(MB / sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0.1672
],
[
1626239940000,
0.16878
],
[
1626240000000,
0.16762
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "send",
"graphName": "Network I/O(MB / sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
0.10795
],
[
1626239940000,
0.10829
],
[
1626240000000,
0.10651
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "receive",
"graphName": "Network I/O(MB / sec)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
1.98535
],
[
1626239940000,
1.98535
],
[
1626240000000,
1.98633
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "free",
"graphName": "Free Memory(GB)",
"productName": "Cloud Data Streaming Service(VPC)"
},
{
"dps": [
[
1626239880000,
46.32722
],
[
1626239940000,
46.32722
],
[
1626240000000,
46.32722
]
],
"aggregation": "AVG",
"dimensions": {
"instanceNo": "1773272"
},
"interval": "Min1",
"metric": "free",
"graphName": "Free Storage Space(GB)",
"productName": "Cloud Data Streaming Service(VPC)"
}
]
},
"requestId": "0da610fc-9e2a-406a-81ce-b5863111cb1d"
}
Was this article helpful?