Queries monitoring information about bandwidth data of the WebSocket network for one or more specified accelerated domain names. You can query data that is collected within the last 90 days.

Note
  • Unit: bit/s.
  • 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 maximum number of times that each user can call this operation per second is 100.

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 software development kits (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 names.

Separate multiple domain names 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.

Note The end time must be later than the start time.
Interval String No 300

The unit of time in which data is collected: seconds.

The value varies based on the values of the StartTime and EndTime parameters. Valid values:

  • If the time range between StartTime and EndTime is less than 3 days, valid values are 300, 3600, and 86400. Default value: 300.
  • If the time range between StartTime and EndTime is from 3 to 31 days (31 days excluded), valid values are 3600 and 86400. Default value: 3600.
  • If the time range 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).

If you do not set this parameter, all ISPs are queried. You can call the DescribeDcdnRegionAndIsp operation to query ISP names.

LocationNameEn String No beijing

The name of the region.

If you do not set this parameter, all regions are queried. You can call the DescribeDcdnRegionAndIsp operation to query the most recent region list.

Response parameters

Parameter Type Example Description
BpsDataPerInterval Array of DataModule

The bandwidth data that is collected for each interval.

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

The timestamp of the data entry.

WebsocketBps Float 11288111

The bandwidth value. Unit: bit/s.

DataInterval String 300

The time interval between the data entries returned. Unit: seconds.

DomainName String example.com

The information about the accelerated domain name.

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

The end time.

RequestId String 3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F

The ID of the request.

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

The start time.

Examples

Sample requests

http(s)://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 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 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 specified start time is invalid. Specify a valid value.

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