Queries traffic monitoring data for one or more accelerated domain names.

Note
  • If you do not set the StartTime or EndTime parameter, data collected within the last 24 hours is queried. If you set both the StartTime and EndTime parameters, data collected within the specified time range is queried.
  • You can query traffic monitoring of one or more accelerated domain names. Separate multiple domain names with commas (,).
  • You can query data within the last 90 days. Traffic data is measured in bytes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDomainFlowData

The operation that you want to perform. Set the value to DescribeDomainFlowData.

TimeMerge String No on

Specifies whether to merge the data entries. Valid values:

  • on (default): merges data entries based on the time range.
  • off: data is collected every 5 minutes. The maximum time range can be 31 days.
DomainType String No dynamic

The query type.

  • If this parameter is set to dynamic, the real-time traffic for delivering dynamic resources and static resources is queried.
  • If you do not specify a value, real-time traffic for delivering only static resources is queried.
DomainName String No example.com

The accelerated domain names. Separate accelerated domain names with commas (,).

If you do not set this parameter, the traffic data of all accelerated domain names is returned.

StartTime String No 2019-10-21T08:00:00:00Z

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.
  • Traffic data is collected every 5 minutes.
  • If you do not set this parameter, data within the last 24 hours is returned.
EndTime String No 2019-10-22T08:00:00:00Z

The end of the time range to query.

  • The end time must be later than the start time.
  • Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.
  • The time must be in UTC.
Interval String No 300

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

  • Valid values are 300, 3600, 14400, 28800, and 86400.
  • The default value is 300. If you do not set this parameter or if you specify an invalid value, the default value is used.
IspNameEn String No unicom

The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query ISPs. If you do not set this parameter, all ISPs are queried.

LocationNameEn String No beijing

The name of the region in which you want to query the data. You can call the DescribeCdnRegionAndIsp operation to query the most recent region list. If you do not set this parameter, all regions are queried.

Response parameters

Parameter Type Example Description
DomainName String example.com

The accelerated domain name.

DataInterval String 300

The time interval between the data entries, in seconds.

StartTime String 2015-12-10T20:00Z

The start of the time range that was queried.

EndTime String 2015-12-10T21:00Z

The end of the time range that was queried.

FlowDataPerInterval Array of DataModule

The traffic monitoring data that was collected at each interval.

DataModule
TimeStamp String 2017-12-22T08:00:00:00Z

The timestamp of the data returned.

Value String 423304182

The total amount of network traffic.

DomesticValue String 0

The amount of network traffic in mainland China.

OverseasValue String 0

The amount of network traffic outside mainland China.

DynamicValue String 0

The amount of network traffic for delivering dynamic resources. When the bandwidth data is queried by ISP, no value is returned.

DynamicDomesticValue String 0

The amount of network traffic for delivering dynamic resources in mainland China. When the bandwidth data is queried by ISP, no value is returned.

DynamicOverseasValue String 0

The amount of network traffic for delivering dynamic resources outside mainland China. When the bandwidth data is queried by ISP, no value is returned.

StaticValue String 0

The amount of network traffic for delivering static resources. When the bandwidth data is queried by ISP, no value is returned.

StaticDomesticValue String 0

The amount of network traffic for delivering static resources in mainland China. When the bandwidth data is queried by ISP, no value is returned.

StaticOverseasValue String 0

The amount of network traffic for delivering static resources outside mainland China. When the bandwidth data is queried by ISP, no value is returned.

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeDomainFlowData
&<Common request parameters>

Sample success responses

XML format

<DescribeDomainFlowDataResponse>
      <DomainName>example.com</DomainName>
      <DataInterval>300</DataInterval>
      <FlowDataPerInterval>
            <DataModule>
                  <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>
                  <Value>423304182</Value>
                  <DynamicValue>0</DynamicValue>
                  <DynamicDomesticValue>0</DynamicDomesticValue>
                  <DynamicOverseasValue>0</DynamicOverseasValue>
                  <StaticValue>0</StaticValue>
                  <StaticDomesticValue>0</StaticDomesticValue>
                  <StaticOverseasValue>0</StaticOverseasValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2015-12-10T20:05:00Z</TimeStamp>
                  <Value>454680793</Value>
                  <DynamicValue>0</DynamicValue>
                  <DynamicDomesticValue>0</DynamicDomesticValue>
                  <DynamicOverseasValue>0</DynamicOverseasValue>
                  <StaticValue>0</StaticValue>
                  <StaticDomesticValue>0</StaticDomesticValue>
                  <StaticOverseasValue>0</StaticOverseasValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2015-12-10T20:10:00Z</TimeStamp>
                  <Value>501718342</Value>
                  <DynamicValue>0</DynamicValue>
                  <DynamicDomesticValue>0</DynamicDomesticValue>
                  <DynamicOverseasValue>0</DynamicOverseasValue>
                  <StaticValue>0</StaticValue>
                  <StaticDomesticValue>0</StaticDomesticValue>
                  <StaticOverseasValue>0</StaticOverseasValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2015-12-10T20:15:00Z</TimeStamp>
                  <Value>434816025</Value>
                  <DynamicValue>0</DynamicValue>
                  <DynamicDomesticValue>0</DynamicDomesticValue>
                  <DynamicOverseasValue>0</DynamicOverseasValue>
                  <StaticValue>0</StaticValue>
                  <StaticDomesticValue>0</StaticDomesticValue>
                  <StaticOverseasValue>0</StaticOverseasValue>
            </DataModule>
      </FlowDataPerInterval>
      <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>
      <StartTime>2015-12-10T20:00Z</StartTime>
      <EndTime>2015-12-10T21:00Z</EndTime>
</DescribeDomainFlowDataResponse>

JSON format

{
    "DomainName": "example.com",
    "DataInterval": "300",
    "FlowDataPerInterval": {
        "DataModule": [
            {
                "TimeStamp": "2015-12-10T20:00:00Z",
                "Value": "423304182",
                "DynamicValue": "0",
                "DynamicDomesticValue": "0",
                "DynamicOverseasValue": "0",
                "StaticValue": "0",
                "StaticDomesticValue": "0",
                "StaticOverseasValue": "0"
            },
            {
                "TimeStamp": "2015-12-10T20:05:00Z",
                "Value": "454680793",
                "DynamicValue": "0",
                "DynamicDomesticValue": "0",
                "DynamicOverseasValue": "0",
                "StaticValue": "0",
                "StaticDomesticValue": "0",
                "StaticOverseasValue": "0"
            },
            {
                "TimeStamp": "2015-12-10T20:10:00Z",
                "Value": "501718342",
                "DynamicValue": "0",
                "DynamicDomesticValue": "0",
                "DynamicOverseasValue": "0",
                "StaticValue": "0",
                "StaticDomesticValue": "0",
                "StaticOverseasValue": "0"
            },
            {
                "TimeStamp": "2015-12-10T20:15:00Z",
                "Value": "434816025",
                "DynamicValue": "0",
                "DynamicDomesticValue": "0",
                "DynamicOverseasValue": "0",
                "StaticValue": "0",
                "StaticDomesticValue": "0",
                "StaticOverseasValue": "0"
            }
        ]
    },
    "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
    "StartTime": "2019-10-10T20:00Z",
    "EndTime": "2019-10-10T21:00Z"
}

Error codes

HttpCode Error code Error message Description
400 InvalidStartTime.Malformed Specified StartTime is malformed. The error message returned because the format of the specified start time is invalid. For more information about the time format, see the Request parameters section.
400 InvalidEndTime.Malformed Specified EndTime is malformed. The error message returned because the format of the specified end time is invalid. For more information about the time format, see the Request parameters section.
400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. The error message returned because the specified start time is invalid. Rectify the start time and try again.

For a list of error codes, visit the API Error Center.