All Products
Search
Document Center

CDN:DescribeDomainBpsDataByTimeStamp

Last Updated:Aug 06, 2024

Queries the bandwidth data at a specified time for an accelerated domain.

Operation description

  • The bandwidth is measured in bit/s.
  • You can specify only one accelerated domain name in each request.
  • The data is collected every 5 minutes.
  • You can call this operation up to 20 times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeDomainBpsDataByTimeStampnone
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify only one domain name in each request.

example.com
TimePointstringYes

The point in time 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 data is collected every 5 minutes.
2019-11-30T05:40:00Z
IspNamesstringYes

The names of the Internet service providers (ISPs). Separate multiple ISPs with commas (,).

You can call the DescribeCdnRegionAndIsp operation to query regions.

uni***,tele***
LocationNamesstringYes

The regions. Separate multiple regions with commas (,).

You can call the DescribeCdnRegionAndIsp operation to query regions.

liaoning,guangxi

Response parameters

ParameterTypeDescriptionExample
object
TimeStampstring

The point in time.

2019-11-30T05:40:00Z
RequestIdstring

The ID of the request.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
DomainNamestring

The accelerated domain name.

example.com
BpsDataListarray<object>

A list of bandwidth values by ISP and region.

object
LocationNamestring

The name of the region.

Liaoning
TimeStampstring

The timestamp of the data returned.

2019-11-30T05:40:00Z
IspNamestring

The name of the ISP.

unicom
Bpslong

The bandwidth value.

52119553

Examples

Sample success responses

JSONformat

{
  "TimeStamp": "2019-11-30T05:40:00Z",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "DomainName": "example.com",
  "BpsDataList": {
    "BpsDataModel": [
      {
        "LocationName": "Liaoning",
        "TimeStamp": "2019-11-30T05:40:00Z",
        "IspName": "unicom",
        "Bps": 52119553
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedThe specified value of parameter StartTime is malformed.The specified start time is invalid. For more information, see the help documentation of this operation.
400InvalidEndTime.MalformedThe specified value of parameter EndTime is malformed.The specified EndTime parameter is invalid.
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The start time is invalid. Set this parameter to another value and try again.
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.StartTime must be earlier than EndTime.

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