DescribeDcdnDomainOriginBpsData - Edge Security Acceleration

Queries back-to-origin bandwidth for one or more accelerated domains.

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 24 hours. If you set both the StartTime and EndTime parameters, the request returns the data collected within the specified time range.

Time granularity

The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table.

Time granularity	Maximum time range per query	Historical data available	Data delay
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours
1 day	366 days	366 days	04:00 on the next day

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. Separate multiple accelerated domain names with commas (,). If you do not specify a value for this parameter, all accelerated domain names are queried.	example.com
StartTime	string	No	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-12-10T00:00:00Z
EndTime	string	No	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-12-11T00:00:00Z
Interval	string	No	The time granularity for a query. Unit: seconds. The time granularity varies with the maximum time range per query. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see Usage notes.	300

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2019-12-11T00:00:00Z
StartTime	string	The start of the time range during which data was queried.	2019-12-10T00:00:00Z
RequestId	string	The ID of the request.	7CBCD6AD-B016-42E5-AE0B-B3731DE8F755
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between the data entries returned. Unit: seconds.	300
OriginBpsDataPerInterval	array<object>	The origin bandwidth data returned at each time interval. Unit: bit/s.
DataModule	object
DynamicHttpOriginBps	float	The bandwidth that was consumed for fetching dynamic content from the origin over HTTP.	100
StaticHttpOriginBps	float	The bandwidth that was consumed for fetching static content from the origin over HTTP.	100
TimeStamp	string	The timestamp of the returned data.	2019-12-10T00:00:00Z
StaticHttpsOriginBps	float	The bandwidth that was consumed for fetching static content from the origin over HTTPS.	100
OriginBps	float	The bandwidth that was consumed for fetching content from the origin.	100
DynamicHttpsOriginBps	float	The bandwidth that was consumed for fetching dynamic content from the origin over HTTPS.	100

Examples

Sample success responses

JSONformat

{
  "EndTime": "2019-12-11T00:00:00Z",
  "StartTime": "2019-12-10T00:00:00Z",
  "RequestId": "7CBCD6AD-B016-42E5-AE0B-B3731DE8F755",
  "DomainName": "example.com",
  "DataInterval": "300",
  "OriginBpsDataPerInterval": {
    "DataModule": [
      {
        "DynamicHttpOriginBps": 100,
        "StaticHttpOriginBps": 100,
        "TimeStamp": "2019-12-10T00:00:00Z",
        "StaticHttpsOriginBps": 100,
        "OriginBps": 100,
        "DynamicHttpsOriginBps": 100
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The 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.
400	InvalidEndTime.Malformed	The 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.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

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