DescribeDcdnDomainWebsocketTrafficData - Dynamic Route for CDN

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 the StartTime and EndTime parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity supported by the Interval parameter varies with the maximum time range per query. The following table describes the time period within which historical data is available and the data delay.


Time granularity	Maximum time range per query	Historical data available	Data delay
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours
1 day	366 days	366 days	04: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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDcdnDomainWebsocketTrafficData	The operation that you want to perform. Set the value to DescribeDcdnDomainWebsocketTrafficData.
DomainName	String	No	example.com	The accelerated domain name. Separate multiple domain names with commas (,). If you do not specify a value for this parameter, all accelerated domain names are queried.
StartTime	String	No	2017-12-10T20: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.
EndTime	String	No	2017-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.
Interval	String	No	300	The time interval between the data entries to return. 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 Description.
IspNameEn	String	No	unicom	The name of the Internet service provider (ISP). You can call the DescribeDcdnRegionAndIsp operation to query ISPs.
LocationNameEn	String	No	beijing	The name of the region. You can call the DescribeDcdnRegionAndIsp operation to query regions.

Response parameters


Parameter	Type	Example	Description
EndTime	String	2017-12-10T21:00:00Z	The end of the time range during which data was queried.
StartTime	String	2017-12-10T20:00:00Z	The beginning of the time range during which data was queried.
RequestId	String	B955107D-E658-4E77-B913-E0AC3D31693E	The ID of the request.
DomainName	String	example.com	The accelerated domain name.
DataInterval	String	300	The time interval between the data entries returned. Unit: seconds.
TrafficDataPerInterval	Array of DataModule		The network traffic returned at each time interval. Unit: bytes.
DataModule
WebsocketTraffic	Float	423304182	The total amount of network traffic.
TimeStamp	String	2017-12-10T20:00:00Z	The timestamp of the data returned.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDcdnDomainWebsocketTrafficDataResponse>
	<DomainName>example.com</DomainName>
	<DataInterval>300</DataInterval>
	<TrafficDataPerInterval>
		<DataModule>
			<TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
			<WebsocketTraffic>423304182</WebsocketTraffic>
		</DataModule>
	</TrafficDataPerInterval>
	<RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>
	<StartTime>2017-12-10T20:00:00Z</StartTime>
	<EndTime>2017-12-10T21:00:00Z</EndTime>
</DescribeDcdnDomainWebsocketTrafficDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DomainName" : "example.com",
  "DataInterval" : "300",
  "TrafficDataPerInterval" : {
    "DataModule" : [ {
      "TimeStamp" : "2017-12-10T20:00:00Z",
      "WebsocketTraffic" : 423304182
    } ]
  },
  "RequestId" : "B955107D-E658-4E77-B913-E0AC3D31693E",
  "StartTime" : "2017-12-10T20:00:00Z",
  "EndTime" : "2017-12-10T21:00:00Z"
}

Error codes


HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	The error message returned because no value is specified for the StartTime or EndTime parameter.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.	The error message returned because the format of the EndTime parameter is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The error message returned because the end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The error message returned because the value specified for the StartTime parameter is invalid. Specify a valid value.

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