DescribeDcdnDomainIpaBpsData - Edge Security Acceleration

Queries bandwidth of accelerated domain names for which Layer 4 acceleration is enabled. You can query the data that is collected over the last 90 days.

Operation description

Note

The bandwidth is measured in bit/s.
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.
You can call this operation up to 100 times per second per account.

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 domain names with commas (,). If you leave this parameter empty, 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.	2017-12-10T20: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.	2017-12-10T21:00:00Z
TimeMerge	string	No	Specifies whether to automatically set the interval. If you set TimeMerge to 1, the value of the Interval parameter is automatically assigned based on the startTime and endTime parameters. You can specify either this parameter or the Interval parameter.	1
Interval	string	No	The time granularity of data entries. Unit: seconds. The time granularity varies with the time range specified by StartTime and EndTime. If the time range between StartTime and EndTime is less than 3 days, the valid values are 300, 3600, and 86400. If you leave this parameter empty, 300 is used. If the time range between StartTime and EndTime is greater than or equal to 3 days and less than 31 days, the valid values are 3600 and 86400. Default value: 3600. If the time range between StartTime and EndTime is 31 days or longer, the valid value is 86400. Default value: 86400.	300
FixTimeGap	string	No	Specifies whether to implement padding with zeros. Valid values: true false	false
IspNameEn	string	No	The name of the Internet service provider (ISP). You can call the DescribeDcdnRegionAndIsp operation to query ISPs.	Unicom
LocationNameEn	string	No	The name of the region. You can call the DescribeDcdnRegionAndIsp operation to query regions.	beijing

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2017-12-10T21:00:00Z
StartTime	string	The beginning of the time range during which data was queried.	2017-12-10T20:00:00Z
RequestId	string	The ID of the request.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval at which data was collected. Unit: seconds.	300
BpsDataPerInterval	array<object>	The bandwidth data returned at each interval.
DataModule	object
IpaBps	float	The bandwidth value. Unit: bit/s.	11288111
TimeStamp	string	The timestamp of the data returned.	2017-12-10T20:00:00Z

Examples

Sample success responses

JSONformat

{
  "EndTime": "2017-12-10T21:00:00Z",
  "StartTime": "2017-12-10T20:00:00Z",
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "DomainName": "example.com",
  "DataInterval": "300",
  "BpsDataPerInterval": {
    "DataModule": [
      {
        "IpaBps": 11288111,
        "TimeStamp": "2017-12-10T20:00:00Z"
      }
    ]
  }
}

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	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.