Queries the monitoring data of WebSocket network traffic for one or more accelerated domain names. You can query data within the last 90 days.
- 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 monitoring data is measured in bytes.
Debugging
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. You can specify one or more accelerated domain names. Separate them with commas (,). By default, all accelerated domain names that belong to your Alibaba Cloud account are queried. |
StartTime | String | No | 2017-12-10T20:00:00Z |
The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
EndTime | String | No | 2017-12-10T21:00:00Z |
The end of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The end of the time range to query. The end time must be later than the start time.
|
Interval | String | No | 300 |
The time interval between the data entries returned. Unit: seconds. The valid values vary based on the values of the StartTime and EndTime parameters. Valid values:
|
IspNameEn | String | No | unicom |
The name of the Internet service provider (ISP) for Dynamic Route for CDN (DCDN). You can call the DescribeCdnRegionAndIsp operation to query the most recent ISP list. If you do not specify an ISP, all ISPs are queried. |
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, all regions are queried. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
DataInterval | String | 300 |
The time interval between the data entries returned. Unit: seconds. |
DomainName | String | example.com |
The accelerated domain name. |
EndTime | String | 2017-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 | 2017-12-10T20:00:00Z |
The beginning of the time range that was queried. |
TrafficDataPerInterval | Array of DataModule |
The monitoring data of WebSocket network traffic that was collected at each interval. |
|
DataModule | |||
TimeStamp | String | 2017-12-10T20:00:00Z |
The timestamp of the data returned. |
WebsocketTraffic | Float | 423304182 |
The total amount of network traffic. |
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
<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
{
"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
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | The error message returned because both the StartTime and EndTime parameters must be set. |
400 | InvalidEndTime.Malformed | The specified EndTime is invalid. | The error message returned because the format of the specified end time 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 end time is earlier than the specified start time. |
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.