QueryTopsChart
    • PDF

    QueryTopsChart

    • PDF

    기사 요약

    개요

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

    NTM의 topN chart를 조회합니다.

    요청

    API URL

    URL: https://vpc-ntm.apigw.fin-ntruss.com/chart/v1/vpc/traffic/chart/tops
    Method: POST
    

    요청 헤더

    공통설정에 명시된 요청헤더가 필요합니다.

    x-ncp-apigw-signature-v2: {generated signature}
    x-ncp-apigw-timestamp: {current timestamp}
    x-ncp-iam-access-key: {your iam access key}
    

    요청 바디

    key필수 여부타입제약사향설명
    trafficTypeYTrafficTypeINTERNET, PRIVATEtraffic의 종류
    groupingTypeYGroupingTypeSERVER, COUNTRY, CITY, REGION, AS, VPC, SUBNET, TYPEgrouping 종류
    vpcMetricTypeYVpcMetricTypeBYTES_MAX, BYTES_SUM, PACKTES_MAX, PACKTES_SUMtraffic 수집 정보
    directionTypeYVpcDirectionTypeIN, OUT, ALLtraffic의 방향
    periodYPeriodTypeDAY, HOUR, MINUTE, THIRTY_MINUTE, FIFTEEN_MINUTE단위 시간
    limitYInteger최대: 3000최대 line 수
    startTimeYLongMillisecond측정 시작 시간
    endTimeYLongMillisecond측정 종료 시간
    asNoNString통신사 번호
    cityCodeNString도시 코드
    countryCodeNString국가 코드
    instanceNoNString인스턴스 번호
    regionNoNString지역 번호
    typeCodeNString타입 코드
    vpcNoNStringVPC 번호
    subnetNoNStringSubnet 번호
    • BYTES_SUM: 1분간 traffic 총합의 평균
    • BYTES_MAX: 1분간 traffic 최대 값

    응답

    응답 바디

    key타입제약사향설명
    topValuesList[TopValue]

    TopValue

    key타입제약사향설명
    noStringGrouping type의 번호
    nameStringGrouping type의 이름
    valueInteger단위: bpsTraffic 합
    inValueInteger단위: bpsInbound traffic 합
    outValueInteger단위: bpsOutbount traffic 합

    예시

    요청 예시

    POST /vpc/traffic/chart/tops
    Host: vpc-ntm.apigw.ntruss.com
    x-ncp-apigw-signature-v2: {generated signature}
    x-ncp-apigw-timestamp: {current timestamp}
    x-ncp-iam-access-key: {your iam access key}
    x-ncp-mbr_no: {your member number}
    {
    	"vpcMetricType": "BYTES_MAX",
    	"directionType": "ALL",
    	"trafficType": "INTERNET",
    	"period": "MINUTE",
    	"groupingType": "REGION",
    	"startTime": 1644231420000,
    	"endTime": 1644235020000,
    	"limit": 10
    }
    

    응답 예시

    오류 없이 조회가 완료된 경우 HTTP code 200과 topN chart가 조회됩니다.

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

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

    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.