GetMetaServer

Available in VPC

Get available server information from the Network Traffic Monitoring service.

Request

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

Request headers

For information about the headers common to all Network Traffic Monitoring APIs, see Network Traffic Monitoring request headers.

Request query parameters

You can use the following query parameters with your request:

Request example

The request example is as follows:

curl --location --request GET 'https://vpc-ntm.apigw.ntruss.com/meta/v1/server?regionCode=KR' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-dmn_cd: PUB' \

Response body

The response body includes the following data:

serverList

The following describes serverList.

Response status codes

For information about the HTTP status codes common to all Network Traffic Monitoring APIs, see Network Traffic Monitoring response status codes.

Response example

The response example is as follows:

{
  "total": 7,
  "serverList": [
    {
      "instanceNo": 1777948,
      "serverName": "test-code003",
      "regionNo": 1,
      "regionCode": "KR",
      "regionName": "Korea",
      "privateIpList": [
        "***.***.***.***"
      ],
      "publicIp": null,
      "instanceStatusCode": "NSTOP",
      "instanceStatusName": "stopped",
      "networkTrafficMonitoringInstanceNo": 2094117,
      "subscribed": true
    },
    {
      "instanceNo": 1777945,
      "serverName": "test-code002",
      "regionNo": 1,
      "regionCode": "KR",
      "regionName": "Korea",
      "privateIpList": [
        "***.***.***.***"
      ],
      "publicIp": null,
      "instanceStatusCode": "RUN",
      "instanceStatusName": "running",
      "networkTrafficMonitoringInstanceNo": 1808470,
      "subscribed": true
    }
  ]
}