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 요청 헤더를 참조해 주십시오.
요청 바디
요청 바디 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
vpcMetricType | String | Required | 트래픽 수집 정보
|
directionType | String | Required | 트래픽 방향
|
trafficType | String | Required | 트래픽 유형
|
period | String | Required | 단위 시간
|
groupingType | String | Required | 그룹핑 유형
|
startTime | Integer | Optional | 측정 시작 시간 (밀리초)
|
endTime | Integer | Optional | 측정 종료 시간 (밀리초)
|
asNo | String | Optional | 통신사 번호 |
cityCode | String | Optional | 도시 코드 |
countryCode | String | Optional | 국가 코드 |
instanceNo | String | Optional | 인스턴스 번호 |
regionNo | String | Optional | 리전 번호 |
typeCode | String | Optional | 타입 코드 |
vpcNo | String | Optional | VPC 번호 |
subnetNo | String | Optional | Subnet 번호 |
limit | Integer | Optional | 최대 line 수
|
요청 예시
요청 예시는 다음과 같습니다.
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"
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
topValues | Array | - | Top-N chart 조회 결과 |
TopValue
TopValue
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
name | String | - | groupingType 이름 |
no | String | - | groupingType 번호 |
value | Integer | - | 트래픽 값 (bps) |
inValue | Integer | - | 인바운드 트래픽 값 (bps) |
outValue | Integer | - | 아웃바운드 트래픽 값 (bps) |
응답 상태 코드
Network Traffic Monitoring API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Network Traffic Monitoring 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"topValues": [
{
"no": "1",
"name": "Korea",
"value": 41997,
"inValue": 41997,
"outValue": 0
}
]
}
이 문서가 도움이 되었습니까?