MENU
      GetMetaServer

        GetMetaServer


        Article summary

        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:

        MethodURI
        GET/meta/v1/server

        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:

        FieldTypeRequiredDescription
        pageIntegerRequiredPage number
        • 0 - N
        sizeIntegerRequiredPage output count
        • 1 - 100
        privateIpStringOptionalPrivate IP
        publicIpIntegerOptionalPublic IP
        regionCodeStringOptionalRegion code
        • KR (default)
        serverNameIntegerOptionalServer name

        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' \
        Shell

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        serverListArray-Server list
        totalInteger-Number of response results

        serverList

        The following describes serverList.

        FieldTypeRequiredDescription
        networkTrafficMonitoringInstanceNoInteger-Network Traffic Monitoring instance number
        subscribedBoolean-Network Traffic Monitoring subscription status
        • true | false
          • true: subscribed
          • false: not subscribed
        Note

        See ServerInstance for more information about the fields related to server information.

        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
            }
          ]
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.