All Products
Search
Document Center

CDN:DescribeDomainRealTimeBpsData

Last Updated:Nov 29, 2024

Queries the bandwidth data about one or more accelerated domain names.

Operation description

  • You can call this operation up to 100 times per second per account.
  • If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last hour. If you set both these 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 days4 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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cdn:DescribeDomainRealTimeBpsDatanone
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

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

Note You can specify up to 500 domain names in each request.
example.com
IspNameEnstringNo

The name of the Internet service provider (ISP).

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

telecom
LocationNameEnstringNo

The name of the region.

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

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.

2019-11-30T05:33: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.
2019-11-30T05:40:00Z

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The data returned.

BpsModelobject
Bpsfloat

The bandwidth. Unit: bit/s.

16710625.733333332
TimeStampstring

The timestamp of the data returned. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2019-11-30T05:41:00Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "B49E6DDA-F413-422B-B58E-2FA23F286726",
  "Data": {
    "BpsModel": [
      {
        "Bps": 16710625.733333332,
        "TimeStamp": "2019-11-30T05:41:00Z"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidTime.MalformedSpecified StartTime or EndTime is malformed.The specified start or end time is invalid.
400InvalidDomainName.MalformedSpecified domain name is malformed.-

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

Change history

Change timeSummary of changesOperation
2023-06-13The Error code has changedView Change Details