GetMetaServer
    • PDF

    GetMetaServer

    • PDF

    기사 요약

    VPC 환경에서 이용 가능합니다.

    Network Traffic Monitoring 서비스에서 사용 가능한 Server 정보를 조회합니다.

    요청

    요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

    메서드URI
    GET/meta/v1/server

    요청 헤더

    Network Traffic Monitoring API에서 공통으로 사용하는 헤더에 대한 정보는 Network Traffic Monitoring 요청 헤더를 참조해 주십시오.

    요청 쿼리 파라미터

    요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    pageIntegerRequired페이지 번호
    • 0~N
    sizeIntegerRequired페이지 출력 수
    • 1~100
    privateIpStringOptionalPrivate IP
    publicIpIntegerOptionalPublic IP
    regionCodeStringOptional리전 코드
    • KR (기본값)
    serverNameIntegerOptionalServer 이름

    요청 예시

    요청 예시는 다음과 같습니다.

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

    응답 바디

    응답 바디에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    serverListArray-Server 목록
    totalInteger-응답 결과 수

    serverList

    serverList에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    networkTrafficMonitoringInstanceNoInteger-Network Traffic Monitoring 인스턴스 번호
    subscribedBoolean-Network Traffic Monitoring 이용 신청 여부
    • true | false
      • true: 이용 신청
      • false: 이용 해제
    참고

    Server 정보 관련 필드에 대한 설명은 ServerInstance를 참조해 주십시오.

    응답 상태 코드

    Network Traffic Monitoring API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Network Traffic Monitoring 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    {
      "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
        }
      ]
    }
    

    이 문서가 도움이 되었습니까?

    What's Next
    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.