QueryMultiDomainsIPV6OrIPV4Bandwidth
Update time: 2026-07-13 15:50:10
Applicable Products
Other
API Description
This interface is used to query the IPV6 or IPV4 bandwidth data of multiple domain names. The user provides parameters such as time range, domain name, IP type and region to obtain bandwidth details of related domain names. The returned results include bandwidth data for each domain name in the specified time period. This interface helps users monitor and analyze network traffic of different domain names under specific IP types, thereby optimizing resource allocation and improving network performance.
- API URL: https://api.atomile.com/api/report/bandwidth/ipv6
- Method: POST
Call frequency
Single user trigger frequency: 300/5min
Request parameter(s)
Body Params
| Name | Description |
|---|---|
*dateFromString | Start time:
1. The time format is yyyy-MM-ddTHH:mm:ss±HH:mm. Please note: ±HH:mm is the time zone offset, which can be adjusted according to your data needs, for example, +00:00 represents UTC time, +08:00 represents East 8th District, and -05:00 represents West 5th District. 2024-01-15T10:30:45+00:00 means UTC time January 15, 2024 10:30:45 AM;
2. No bigger than the current time.
3. Data in the last 183 days at most can be queried. |
*dateToString | End time:
1.The time format is yyyy-MM-ddTHH:mm:ss±HH:mm. Please note: ±HH:mm is the time zone offset, which can be adjusted according to your data needs, for example, +00:00 represents UTC time, +08:00 represents East 8th District, and -05:00 represents West 5th District. 2024-01-15T10:30:45+00:00 means UTC time January 15, 2024 10:30:45 AM
2. End time should be greater than start time. If the end time is greater than current time, current time will be used.
3. If both fields of dataFrom and dateTo are left empty, then data in the last 24 hours will be queried by default; if only one field is filled in and one is left empty, then exception will be occur.
4. Allowable maximum time range for query:7 day, means the period between dateFrom to dateTo should not exceed 7 day (can be adjusted by contacting technical support). |
*domainList | Domain:
1. The maximum number of domian is 200 by default (Technical Support Adjustment can be contacted);
2. automatic filtering invalid domain name (if pass illegal domain name, can be filtered, query result only returns the data of valid domain name). |
*dataIntervalString | Data granularity
1. Support 5m (5 minute granularity), 1h (1 hour granularity);
2. The default is 5m |
*ipTypeString | IP type:
1.The optional values are IPv6 and IPv4
2.If let this parameter empty,it will query all IP type; |
*regionList | 1.If let this parameter empty,it will query all rigion;
2.Optional values cn, am, apac, au, emea, hk, tw, etc |
Response parameter(s)
Body Params
| Name | Description |
|---|---|
codeString | The result status code of this request |
messageString | The result info of this request |
dataList | Detailed data on the result of the request |
domainString | domain |
detailListList | |
timestampString | Timestamp: The timestamp between the start time and the end time. |
valueString | Bandwidth,Mbps |
Error code
| Error code(code) | Description(message) | HTTP status | Semantic |
|---|---|---|---|
| 24102013 | The Accept request header is not supported, the interface only supports json and xml formats, and the default is json format | 400 | The Accept request header is not supported, the interface only supports json and xml formats, and the default is json format |
| 24102002 | There was an error in the body of your HTTP request. | 400 | There was an error in the body of your HTTP request. |
| 24102006 | dateFrom or dateTo does not conform to the specification or the time interval is illegal | 400 | dateFrom or dateTo does not conform to the specification or the time interval is illegal |
| 24102007 | The difference between dateFrom and dateTo exceeds the limit | 400 | The difference between dateFrom and dateTo exceeds the limit |
| 24102021 | Date format error | 400 | Date format error |
| 24102019 | The number of domain names passed exceeds the account limit | 400 | The number of domain names passed exceeds the account limit |
| 24102008 | The parameter domain does not conform to the specification | 400 | The parameter domain does not conform to the specification |
| 24102008 | The parameter dataInterval does not conform to the specification | 400 | The parameter dataInterval does not conform to the specification |
| 24102019 | The number of domain names exceeds the limit | 400 | The number of domain names exceeds the limit |
| 24102008 | The parameter ipType does not conform to the specification | 400 | The parameter ipType does not conform to the specification |
| 24102500 | We encountered an internal error. Please try again. | 500 | We encountered an internal error. Please try again. |
Example
JSON
- Request example Copy success
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://api.atomile.com/api/report/bandwidth/ipv6" \ -X "POST" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -d '{ "dateFrom":"2020-12-15T00:00:00+00:00", "dateTo":"2020-12-15T01:00:00+00:00", "domain":["test.com"], "dataInterval":"5m", "ipType":"IPV6" }'- Response example Copy success
{ "code": "0", "message": "success", "data": [ { "domain": "test.com", "detailList": [ { "timestamp": "2020-12-15 00:00", "value": "0.16" } ] } ] }