Queries the bandwidth data for one or more ingest domains.

Note
  • The unit of the bandwidth data is bit/s.
  • You can query the bandwidth data for multiple ingest domains by separating them with commas (,).
  • If you do not set the StartTime parameter or the EndTime parameter, the data of the last 24 hours is queried. If you set the StartTime and EndTime parameters, the data of the specified time range is queried.
  • You can query the data within the last 90 days.

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 a sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveDomainPushBpsData

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

DescribeLiveDomainPushBpsData.

DomainName String No example.com

The ingest domain.

You can query the bandwidth data for multiple ingest domains by separating them with commas (,).

If you do not set this parameter, the merged data of all your ingest domains is returned.

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.

If you do not set this parameter, the data for the last 24 hours is returned.

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 interval at which the data is to be queried. Unit: seconds. Valid values:

  • 300
  • 3600
  • 86400

The default value is 300. If you do not set this parameter or if you specify an invalid value, the default value is used.

IspNameEn String No alibaba

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 all ISPs is returned.

LocationNameEn String No tianjin

The name of the region in which you want to query the data.

To query regions, call the DescribeCdnRegionAndIsp operation. If you do not set this parameter, the data in all regions is returned.

Response parameters

Parameter Type Example Description
BpsDataPerInterval Array of DataModule

The bandwidth data that was collected for each interval.

DataModule
BpsValue String 11288111

The bandwidth. Unit: bit/s.

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

The timestamp of the returned data.

DataInterval String 300

The interval at which the data was queried.

DomainName String example.com

The ingest domain.

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

The end of the time range in 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 in which the data was queried.

Examples

Sample requests

http(s)://live.aliyuncs.com?Action=DescribeLivePushDomainBpsData&DomainName=example.com
&StartTime=2017-12-10T20:00:00Z
&EndTime=2017-12-10T21:00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeLiveDomainPushBpsDataResponse>
      <BpsDataPerInterval>
            <DataModule>
                  <TimeStamp>2017-12-10T20:00:00Z</TimeStamp>
                  <BpsValue>11288111</BpsValue>
            </DataModule>
            <DataModule>
                  <TimeStamp>2017-12-10T20:05:00Z</TimeStamp>
                  <BpsValue>1288111</BpsValue>
            </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>
</DescribeLiveDomainPushBpsDataResponse>

JSON format

{
    "BpsDataPerInterval": {
        "DataModule": [
            {
                "TimeStamp": "2017-12-10T20:00:00Z",
                "BpsValue": "11288111"
            },
            {
                "TimeStamp": "2017-12-10T20:05:00Z",
                "BpsValue": "1288111"
            }
        ]
    },
    "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 InvalidStartTime.Malformed Specified StartTime is malformed. The error message returned because the format of the start time is invalid. Check whether the value of the StartTime parameter is valid.
400 InvalidEndTime.Malformed Specified EndTime is malformed. The error message returned because the format of the end time is invalid. Check whether the value of the EndTime parameter is valid.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. The error message returned because the end time is not later than the start time. Check whether the values of the StartTime and EndTime parameters are valid.

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