DescribeDomainTrafficData - New API Reference| Alibaba Cloud Documentation Center

Note

If you do not set StartTime or EndTime, data collected within the last 24 hours is queried. If you set both StartTime and EndTime, data collected within the specified time range is queried.
The maximum number of times that each user can call this operation per second is 100.
You can specify multiple domain names (no more than 500) and separate them with commas (,).

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	No	DescribeDomainTrafficData	The operation that you want to perform. Set the value to DescribeDomainTrafficData.
DomainName	String	No	example.com	The accelerated domain names. You can specify multiple accelerated domain names and separate them with commas (,). By default, this operation queries the monitoring data of network traffic for all accelerated domain names that belong to your Alibaba Cloud account.
StartTime	String	No	2015-12-10T20:00:00Z	The start 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.
EndTime	String	No	2015-12-10T21:00:00Z	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.
LocationNameEn	String	No	beijing	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query the most recent region list. If you do not specify a region, monitoring data in all regions is queried.
IspNameEn	String	No	unicom	The name of the Internet service provider (ISP) for your Alibaba Cloud CDN service. You can call the DescribeCdnRegionAndIsp operation to query ISP names. If you do not specify an ISP, data of all ISPs is queried.
Interval	String	No	300	The time interval between the data entries. Unit: seconds. The value varies based on the values of the StartTime and EndTime parameters. Valid values: If the time range between StartTime and EndTime is less than 3 days, the valid values are 300, 3600, and 86400. If you do not specify a value for this parameter, 300 is used. If the time span between StartTime and EndTime is from 3 to 31 days (31 days excluded), valid values are 3600 and 86400. Default value: 3600. If the time range between StartTime and EndTime is 31 days or longer, the valid value is 86400. Default value: 86400.

Response parameters


Parameter	Type	Example	Description
DataInterval	String	300	The time interval between the data entries. Unit: seconds.
DomainName	String	example.com	The accelerated domain name.
EndTime	String	2015-12-10T21:00:00Z	The end of the time range that was queried.
RequestId	String	B955107D-E658-4E77-B913-E0AC3D31693E	The ID of the request.
StartTime	String	2015-12-10T20:00:00Z	The beginning of the time range that was queried.
TrafficDataPerInterval	Array of DataModule		The monitoring data of network traffic that was collected at each interval.
DataModule
DomesticValue	String	0	The amount of network traffic in mainland China.
HttpsDomesticValue	String	0	The amount of HTTPS network traffic on L1 CDN edge nodes in mainland China.
HttpsOverseasValue	String	0	The amount of HTTPS network traffic on L1 CDN edge nodes outside mainland China.
HttpsValue	String	423304182	The total amount of HTTPS network traffic on L1 CDN edge nodes.
OverseasValue	String	0	The amount of network traffic outside mainland China.
TimeStamp	String	example.com	The timestamp of the data returned.
Value	String	423304182	The total amount of network traffic.

Examples

Sample requests

http(s)://cdn.aliyuncs.com/?Action=DescribeDomainTrafficData
&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T21:00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeDomainTrafficDataResponse>
      <DomainName>example.com</DomainName>
      <DataInterval>300</DataInterval>
      <TrafficDataPerInterval>
            <DataModule>
                  <TimeStamp>2015-12-10T20:00:00Z</TimeStamp>
                  <Value>423304182</Value>
                  <DomesticValue>0</DomesticValue>
                  <OverseasValue>0</OverseasValue>
                  <HttpsValue>423304182</HttpsValue>
                  <HttpsDomesticValue>0</HttpsDomesticValue>
                  <HttpsOverseasValue>0</HttpsOverseasValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2015-12-10T20:05:00Z</TimeStamp>
                  <Value>454680793</Value>
                  <DomesticValue>0</DomesticValue>
                  <OverseasValue>0</OverseasValue>
                  <HttpsValue>423304182</HttpsValue>
                  <HttpsDomesticValue>0</HttpsDomesticValue>
                  <HttpsOverseasValue>0</HttpsOverseasValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2015-12-10T20:10:00Z</TimeStamp>
                  <Value>501718342</Value>
                  <DomesticValue>0</DomesticValue>
                  <OverseasValue>0</OverseasValue>
                  <HttpsValue>423304182</HttpsValue>
                  <HttpsDomesticValue>0</HttpsDomesticValue>
                  <HttpsOverseasValue>0</HttpsOverseasValue>
            </DataModule>
      </TrafficDataPerInterval>
      <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>
      <StartTime>2015-12-10T20:00:00Z</StartTime>
      <EndTime>2015-12-10T21:00:00Z</EndTime>
</DescribeDomainTrafficDataResponse>

JSON format

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

Error codes

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