Get operating system monitoring result

Available in VPC

Get operating system monitoring data for a search engine node server.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/v2/monitoring/getOsMonitoringData/{serviceGroupInstanceNo} (Korea Region)
GET	/api/sgn-v2/monitoring/getOsMonitoringData/{serviceGroupInstanceNo} (Singapore Region)
GET	/api/jpn-v2/monitoring/getOsMonitoringData/{serviceGroupInstanceNo} (Japan Region)

Request headers

For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`serviceGroupInstanceNo`	Integer	Required	Cluster instance number See Get cluster list.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`timeStart`	Integer	Required	Query start date and time (millisecond) Unix timestamp format
`timeEnd`	Integer	Required	Query end date and time (millisecond) Unix timestamp format
`metric`	String	Required	Metric type `OS_ALL_METRICS`: OS monitoring metric (valid value)
`computeInstanceNo`	Integer	Required	Node server instance number See Get node list.
`interval`	String	Optional	Aggregation interval `Min1` (default) \| `Min5` \| `Min30` \| `Hour2` \| `Day1` `Min1`: 1 minute (up to 1 day) `Min5`: 5 minutes (up to 1 week) `Min30`: 30 minutes (up to 1 month) `Hour2`: 2 hours (up to 3 months) `Day1`: 1 day (up to 1 year)

Request example

The request example is as follows:

curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/monitoring/getOsMonitoringData/1037****?timeStart=1742520660000&timeEnd=1742866674000&metric=OS_ALL_METRICS&computeInstanceNo=1037*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`code`	Integer	-	Response code
`message`	String	-	Response message
`result`	Object	-	Response result
`result.data`	Array	-	Monitoring data
`requestId`	String	-	ID for the request UUID format

`result.data`

The following describes result.data.

Field	Type	Required	Description
`dps`	Array	-	Query result Display in the data point (Unix timestamp format) and data value format
`aggregation`	String	-	Aggregation function
`dimensions`	Object	-	Dimension information
`dimensions.instanceNo`	String	-	Node server instance number
`dimensions.Svc_group_instance_no`	String	-	Cluster instance number
`interval`	String	-	Aggregation interval `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1` `Min1`: 1 minute (up to 1 day) `Min5`: 5 minutes (up to 1 week) `Min30`: 30 minutes (up to 1 month) `Hour2`: 2 hours (up to 3 months) `Day1`: 1 day (up to 1 year)
`metric`	String	-	Metric name
`graphName`	String	-	Graph name
`productName`	String	-	Product name

Response status codes

For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.

Response example

The response example is as follows:

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "data": [
            {
                "dps": [
                    [
                        1742522400000,
                        0.2895593
                    ],
                    [
                        1742524200000,
                        0.20599635
                    ],
                    [
                        1742526000000,
                        0.15053034
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1037*****",
                    "Svc_group_instance_no": "1037*****"
                },
                "interval": "Min30",
                "metric": "wait i/o",
                "graphName": "CPU Usage(%)",
                "productName": "Search Engine Service(VPC)"
            },
            {
                "dps": [
                    [
                        1742522400000,
                        3.7677953
                    ],
                    [
                        1742524200000,
                        2.5108845
                    ],
                    [
                        1742526000000,
                        1.9430301
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1037*****",
                    "Svc_group_instance_no": "1037*****"
                },
                "interval": "Min30",
                "metric": "user",
                "graphName": "CPU Usage(%)",
                "productName": "Search Engine Service(VPC)"
            },
            ...
        ]
    },
    "requestId": "0065bc1b-****-****-****-4046e17d4407"
}