QueryTopsChart
- Print
- PDF
QueryTopsChart
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
Available in the VPC environment.
Inquire NTM's Top-N chart.
Request
API URL
URL: https://vpc-ntm.apigw.ntruss.com/chart/v1/vpc/traffic/chart/tops
Method: POST
Request header
The request header specified in the common setting is required.
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}
Request body
| key | essential | Type | Constraints | Description |
|---|---|---|---|---|
| trafficType | Y | TrafficType | INTERNET,PRIVATE | Traffic |
| groupingType | Y | GroupingType | SerVER,COUNTRY,CITY,REGION,AS,VPC,SUBNET,PET | |
| vpcMetricType | Y | VpcMetricType | BYTES_MAX,BYTES_SUM,PACKTES_MAX,PACKTES_MAX,PACKTES_SUM | traffic collected information |
| directionType | Y | VpcDirectionType | IN,OUT,ALL | traffic direction |
| period | Y | PeriodType | DAY,HOUR,MINUTE,THIRTY_MINUTE,FIFTEEN_MINUTE | Unit time |
| limit | Y | Integer | Max: 3000 | Maximum number of lines |
| startTime | Y | Long | Millisecond | Measurement Start Time |
| endTime | Y | Long | Millisecond | Measurement End Time |
| asNo | N | String | Carrier Number | |
| cityCode | N | String | CityCode | |
| countryCode | N | String | CountryCode | |
| instanceNo | N | String | InstanceNo | |
| regionNo | N | String | RegionNo | |
| typeCode | N | String | TypeCode | |
| vpcNo | N | String | VPC Number | |
| subnetNo | N | String | Subnet Number |
BYTES_SUM: The average of traffic total for 1 minuteBYTES_MAX: Traffic maximum value for 1 minute.
Answer
Response body
| key | Type | Constraints | Description |
|---|---|---|---|
| topValues | List[TopValue] |
TopValue
| key | Type | Constraints | Description |
|---|---|---|---|
| no | String | Grouping type number | |
| name | String | Grouping type's name | |
| value | Integer | unit: bps | Traffic sum |
| inValue | Integer | unit: bps | Inbound traffic sum |
| outValue | Integer | unit: bps | Outcount traffic sum |
Example
Request example
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
}
Response example
HTTP code 200 and topN chart are inquired if the inquiry is completed without errors.
{
"topValues": [
{
"no": "1",
"name": "Korea",
"value": 41997,
"inValue": 41997,
"outValue": 0
}
]
}
Was this article helpful?