Queries the bandwidth data of the WebSocket network for one or more specified accelerated domains. You can query data collected within the last 90 days.

When you call this operation, follow these rules:
  • The data is measured in bit/s.
  • If you do not specify StartTime or EndTime, the data for the last 24 hours is returned. If you specify both StartTime and EndTime, the data within the specified time range is returned.
  • 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 accelerated domain name. You can specify multiple accelerated domain names and separate them with commas (,).

By default, 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.

The end time must be later than the start time.

Interval String No 300

The data collection interval. Unit: second. The value varies based on the values of the StartTime and EndTime parameters. If you do not specify this parameter, the default value is used.

  • If the time span between StartTime and EndTime is less than 3 days, the valid values are 300, 3600, and 86400. Default value: 300.
  • If the time span between StartTime and EndTime is from 3 to 30 days, the valid values are 3600 and 86400. Default value: 3600.
  • If the time span between StartTime and EndTime is 31 days or longer, the valid value is 86400. Default value: 86400.
IspNameEn String No unicom

The name of the Internet service provider (ISP). To query ISPs, call the DescribeCdnRegionAndIsp operation. If you do not set this parameter, the data of the accelerated domains for all ISPs is returned.

LocationNameEn String No beijing

The name of the region. To query regions, call the DescribeCdnRegionAndIsp operation. If you do not set this parameter, the data of the accelerated domains in all regions is returned.

Response parameters

Parameter Type Example Description
BpsDataPerInterval Array

The bandwidth returned at each interval.

DataModule
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 collection interval. Unit: second.

DomainName String example.com

The name of the accelerated domain for which the data was returned.

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

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

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 returned.

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

{
    "BpsDataPerInterval": {
        "DataModule": [
            {
                "TimeStamp": "2017-12-10T20:00:00Z",
                "WebsocketBps": 11288111
            },
            {
                "TimeStamp": "2017-12-10T20:05:00Z",
                "WebsocketBps": 11288111
            }
        ]
    },
    "DomainName": "example.com",
    "DataInterval": "300",
    "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
    "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 the StartTime and EndTime parameters must be specified at the same time.
400 InvalidEndTime.Malformed The specified EndTime is invalid. The error message returned because the format of 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 StartTime parameter is invalid.

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