You can call this operation to query the WebSocket network traffic monitoring data. The maximum time range that can be specified is the last 90 days.

When you call this operation, follow these rules:
  • If you do not specify the StartTime and EndTime parameters, the data within the last 24 hours is queried. If you specify the StartTime and EndTime parameters, the data within the specified time range is queried.
  • You can specify multiple accelerated domain names and separate them with commas (,).
  • The 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 DescribeDcdnDomainWebsocketTrafficData

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

DomainName String No example.com

If you do not specify this parameter, the data of all accelerated domains are returned.

The name of the accelerated domain. You can separate multiple accelerated domain names with commas (,).

EndTime String No 2017-12-10T21: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 data sampling interval. Unit: seconds. The value varies based on the values specified in the StartTime and EndTime parameters. If you do not specify this parameter or the specified value is invalid, the default value is used. Valid values:

  • Less than 3 days: 300, 3600, and 86400. Default value: 300.
  • 3 to 31 days (excluding 31 days): 3600 and 86400. Default value: 3600.
  • No less than 31 days: 86400. Default value:86400.
IspNameEn String No unicom

The name of the ISP. You can call the DescribeCdnRegionAndIsp operation to query providers. If you do not specify this parameter, all providers are queried.

LocationNameEn String No beijing

The name of the region. You can call the DescribeCdnRegionAndIsp operation to query regions. If you do not specify this parameter, all regions 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.
  • The data granularity is one hour.
  • If you do not specify this parameter, the data within the last 24 hours is queried.

Response parameters

Parameter Type Example Description
DataInterval String 300

The data sampling interval. Unit: seconds.

DomainName String example.com

The name of the accelerated domain returned.

EndTime String 2017-12-10T21:00:00Z

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

RequestId String B955107D-E658-4E77-B913-E0AC3D31693E

The ID of the request.

StartTime String 2017-12-10T20:00:00Z

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

TrafficDataPerInterval Array

The network traffic data collected at each sampling interval.

DataModule

The network traffic data collected at each sampling interval.

TimeStamp String 2017-12-10T20:00:00Z

The timestamp of the data returned.

WebsocketTraffic Float 423304182

The total network traffic.

Examples

Sample requests

http://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

<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

{
	"TrafficDataPerInterval":{
		"DataModule":[
			{
				"TimeStamp":"2017-12-10T20:00:00Z",
				"WebsocketTraffic":423304182
			}
		]
	},
	"DataInterval":"300",
	"RequestId":"B955107D-E658-4E77-B913-E0AC3D31693E",
	"DomainName":"example.com",
	"EndTime":"2017-12-10T21:00:00Z",
	"StartTime":"2017-12-10T20: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 the StartTime and EndTime parameters must be specified together.
400 InvalidStartTime.Malformed The specified StartTime is invalid. The error message returned because the specified StartTime 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.Malformed The specified EndTime is invalid. The error message returned because the specified 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 specified EndTime parameter is earlier than the specified StartTime parameter.
400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid. The error message returned because the specified start time is invalid.

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