QueryTopsChart
- 인쇄
- PDF
QueryTopsChart
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
개요
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 | 필수 여부 | 타입 | 제약사향 | 설명 |
|---|---|---|---|---|
| trafficType | Y | TrafficType | INTERNET, PRIVATE | traffic의 종류 |
| groupingType | Y | GroupingType | SERVER, COUNTRY, CITY, REGION, AS, VPC, SUBNET, TYPE | grouping 종류 |
| vpcMetricType | Y | VpcMetricType | BYTES_MAX, BYTES_SUM, PACKTES_MAX, PACKTES_SUM | traffic 수집 정보 |
| directionType | Y | VpcDirectionType | IN, OUT, ALL | traffic의 방향 |
| period | Y | PeriodType | DAY, HOUR, MINUTE, THIRTY_MINUTE, FIFTEEN_MINUTE | 단위 시간 |
| limit | Y | Integer | 최대: 3000 | 최대 line 수 |
| startTime | Y | Long | Millisecond | 측정 시작 시간 |
| endTime | Y | Long | Millisecond | 측정 종료 시간 |
| asNo | N | String | 통신사 번호 | |
| cityCode | N | String | 도시 코드 | |
| countryCode | N | String | 국가 코드 | |
| instanceNo | N | String | 인스턴스 번호 | |
| regionNo | N | String | 지역 번호 | |
| typeCode | N | String | 타입 코드 | |
| vpcNo | N | String | VPC 번호 | |
| subnetNo | N | String | Subnet 번호 |
BYTES_SUM: 1분간 traffic 총합의 평균BYTES_MAX: 1분간 traffic 최대 값
응답
응답 바디
| key | 타입 | 제약사향 | 설명 |
|---|---|---|---|
| topValues | List[TopValue] |
TopValue
| key | 타입 | 제약사향 | 설명 |
|---|---|---|---|
| no | String | Grouping type의 번호 | |
| name | String | Grouping type의 이름 | |
| value | Integer | 단위: bps | Traffic 합 |
| inValue | Integer | 단위: bps | Inbound traffic 합 |
| outValue | Integer | 단위: bps | Outbount 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
}
]
}
이 문서가 도움이 되었습니까?