QueryTopsChart
    • PDF

    QueryTopsChart

    • PDF

    기사 요약

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

    Network Traffic Monitoring 서비스의 Top-N chart를 조회합니다.

    요청

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

    메서드URI
    POST/chart/v1/vpc/traffic/chart/tops

    요청 헤더

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

    요청 바디

    요청 바디 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    vpcMetricTypeStringRequired트래픽 수집 정보
    • BYTES_MAX | BYTES_SUM | PACKETS_MAX | PACKETS_SUM
      • BYTES_MAX: 1분간 트래픽 최대값
      • BYTES_SUM: 1분간 트래픽 총합의 평균
      • PACKETS_MAX: 1분간 패킷 최대값
      • PACKETS_SUM: 1분간 패킷 총합의 평균
    directionTypeStringRequired트래픽 방향
    • IN | OUT | ALL
    trafficTypeStringRequired트래픽 유형
    • INTERNET | PRIVATE
    periodStringRequired단위 시간
    • DAY | HOUR | MINUTE | THIRTY_MINUTE | FIFTEEN_MINUTE
    groupingTypeStringRequired그룹핑 유형
    • SERVER | COUNTRY | CITY | REGION | AS | VPC | SUBNET | TYPE
    startTimeIntegerOptional측정 시작 시간 (밀리초)
    • Unix Timestamp 형식
    endTimeIntegerOptional측정 종료 시간 (밀리초)
    • Unix Timestamp 형식
    asNoStringOptional통신사 번호
    cityCodeStringOptional도시 코드
    countryCodeStringOptional국가 코드
    instanceNoStringOptional인스턴스 번호
    regionNoStringOptional리전 번호
    typeCodeStringOptional타입 코드
    vpcNoStringOptionalVPC 번호
    subnetNoStringOptionalSubnet 번호
    limitIntegerOptional최대 line 수
    • 1~3000 (기본값: 10)

    요청 예시

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

    curl --location --request POST 'https://vpc-ntm.apigw.ntruss.com/chart/v1/vpc/traffic/chart/tops' \
    --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' \
    --data '{
        "vpcMetricType": "BYTES_MAX",
        "directionType": "ALL",
        "trafficType": "PRIVATE",
        "period": "DAY",
        "groupingType": "REGION"
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    topValuesArray-Top-N chart 조회 결과

    TopValue

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

    필드타입필수 여부설명
    nameString-groupingType 이름
    noString-groupingType 번호
    valueInteger-트래픽 값 (bps)
    inValueInteger-인바운드 트래픽 값 (bps)
    outValueInteger-아웃바운드 트래픽 값 (bps)

    응답 상태 코드

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

    응답 예시

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

    {
    	"topValues": [
    		{
    			"no": "1",
    			"name": "Korea",
    			"value": 41997,
    			"inValue": 41997,
    			"outValue": 0
    		}
    	]
    }
    

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

    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.