All Products
Search
Document Center

CDN:DescribeDomainTrafficData

Last Updated:Aug 06, 2024

Queries network traffic for one or more accelerated domain names. You can query data that is collected in the last 90 days.

Operation description

  • You can call this operation up to 100 times per second per account.
  • If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both these parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table.

Time granularityMaximum time range per queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours
1 day366 days36604:00 on the next day

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name. You can specify up to 500 domain names in each request. Separate multiple domain names with commas (,).

By default, this operation queries the network traffic for all accelerated domain names that belong to your Alibaba Cloud account.

example.com
StartTimestringNo

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2015-12-10T20:00:00Z
EndTimestringNo

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note The end time must be later than the start time.
2015-12-10T21:00:00Z
IntervalstringNo

The time granularity of the data entries. Unit: seconds.

The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.

300
IspNameEnstringNo

The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query ISPs.

If you do not specify an ISP, data of all ISPs is queried.

unicom
LocationNameEnstringNo

The name of the region. You can call the DescribeCdnRegionAndIsp operation to query regions.

If you do not specify a region, data in all regions is queried.

beijing

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range during which data was queried.

2015-12-10T21:00:00Z
StartTimestring

The start of the time range during which data was queried.

2015-12-10T20:00:00Z
RequestIdstring

The ID of the request.

B955107D-E658-4E77-B913-E0AC3D31693E
DomainNamestring

The accelerated domain name.

example.com
DataIntervalstring

The time interval between the data entries returned. Unit: seconds.

300
TrafficDataPerIntervalarray<object>

The amount of network traffic at each time interval. Unit: bytes.

object
HttpsDomesticValuestring

The amount of HTTPS traffic on points of presence (POPs) in the Chinese mainland.

0
Valuestring

The total volume of traffic.

423304182
OverseasValuestring

The amount of network traffic outside the Chinese mainland.

0
HttpsValuestring

The total amount of HTTPS traffic on POPs.

423304182
HttpsOverseasValuestring

The amount of HTTPS traffic on POPs outside the Chinese mainland.

0
TimeStampstring

The timestamp of the returned data.

2015-12-10T20:00:00Z
DomesticValuestring

The amount of network traffic in the Chinese mainland.

0

Examples

Sample success responses

JSONformat

{
  "EndTime": "2015-12-10T21:00:00Z",
  "StartTime": "2015-12-10T20:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "TrafficDataPerInterval": {
    "DataModule": [
      {
        "HttpsDomesticValue": "0",
        "Value": "423304182",
        "OverseasValue": "0",
        "HttpsValue": "423304182",
        "HttpsOverseasValue": "0",
        "TimeStamp": "2015-12-10T20:00:00Z",
        "DomesticValue": "0"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified value of parameter StartTime is malformed.The specified start time is invalid. For more information, see the help documentation of this operation.
400InvalidEndTime.MalformedThe specified value of parameter EndTime is malformed.The specified EndTime parameter is invalid.
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.StartTime must be earlier than EndTime.
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The start time is invalid. Set this parameter to another value and try again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-06-13The Error code has changedView Change Details