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

When you call this operation, follow these rules:
  • The data is measured in bit/s.
  • 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 domain names 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 Yes DescribeDcdnDomainWebsocketBpsData

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

DomainName String No example.com

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

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

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 Internet Service Provider (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
BpsDataPerInterval Array

The bandwidth data retrieved at each sampling interval.

DataModule

The bandwidth data retrieved at each sampling interval.

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

The timestamp of the data returned.

WebsocketBps Float 11288111

The bandwidth. Unit: bit/s.

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 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F

The ID of the request.

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

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

Examples

Sample requests

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

Sample success responses

XML format

<DescribeDcdnDomainWebsocketBpsDataResponse>
	  <BpsDataPerInterval>
		    <DataModule>
			      <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
			      <WebsocketBps>11288111</WebsocketBps>
		    </DataModule>
		    <DataModule>
			      <TimeStamp>2017-12-10T20:05:00Z</TimeStamp>
			      <WebsocketBps>11288111</WebsocketBps>
		    </DataModule>
	  </BpsDataPerInterval>
	  <DomainName>example.com</DomainName>
	  <DataInterval>300</DataInterval>
	  <RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
	  <StartTime>2017-12-10T20:00:00Z</StartTime>
	  <EndTime>2017-12-10T21:00:00Z</EndTime>
</DescribeDcdnDomainWebsocketBpsDataResponse>

JSON format

{
	"DataInterval":"300",
	"BpsDataPerInterval":{
		"DataModule":[
			{
				"TimeStamp":"2017-12-10T20:00:00Z",
				"WebsocketBps":11288111
			},
			{
				"TimeStamp":"2017-12-10T20:05:00Z",
				"WebsocketBps":11288111
			}
		]
	},
	"RequestId":"3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
	"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 not supported.

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