All Products
Search
Document Center

Edge Security Acceleration:DescribeDcdnDomainRealTimeBpsData

Last Updated:Oct 17, 2024

Queries the real-time network bandwidth of a domain name.

Operation description

  • You can call this operation up to 10 times per second per account.
  • If you do not specify StartTime or EndTime, the request returns the data collected in the last hour by default. If you specify both parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay.

Time granularityMaximum time range per queryHistorical data availableData delay
1 minute1 hour7 days5 minutes
5 minutes3 days93 days15 minutes
1 hour31 days186 days3 to 4 hours

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. Separate multiple accelerated domain names with commas (,).

example.com
IspNameEnstringNo

The name of the Internet service provider (ISP).

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

telecom
LocationNameEnstringNo

The name of the region.

If you do not set this parameter, all regions are queried. You can call DescribeDcdnRegionAndIsp to query regions.

beijing
StartTimestringNo

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.

2018-01-02T11:00:00Z
EndTimestringNo

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.
2018-01-02T11:00:00Z

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B49E6DDA-F413-422B-B58E-2FA23F286726
Dataarray<object>

The returned data.

BpsModelobject
Bpsfloat

The bandwidth. Unit: bit/s.

16710625.733333332
TimeStampstring

The timestamp of the data returned. The time follows the ISO 8601 standard. The time is displayed in UTC.

2018-01-02T11:05:00Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "B49E6DDA-F413-422B-B58E-2FA23F286726",
  "Data": {
    "BpsModel": [
      {
        "Bps": 16710625.733333332,
        "TimeStamp": "2018-01-02T11:05:00Z"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified StartTime parameter is invalid.The format of the specified start 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.
400InvalidEndTime.MalformedThe specified EndTime is invalid.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.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.The end time is earlier than the start time.
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid.

For a list of error codes, visit the Service error codes.