DescribeDomainMax95BpsData - CDN - Alibaba Cloud Documentation Center

Operation description

You can use one of the following methods to query data:

If you specify the StartTime and EndTime parameters and the time range that is specified by these parameters is less than or equal to 24 hours, the 95th percentile bandwidth data on the day of the start time is returned. If the time range that is specified by these parameters is more than 24 hours, the 95th percentile bandwidth data in the month of the start time is returned.
If you specify the TimePoint and Cycle parameters, the 95th percentile bandwidth data of the cycle is returned.
If you specify the StartTime, EndTime, and Cycle parameters, the 95th percentile bandwidth data of the cycle is returned.

If you do not use one of the methods, the 95th percentile bandwidth data of the previous 24 hours is returned by default.

Maximum time range to query: 90 days
Minimum data granularity to query: 1 day
Historical data available: 90 days

Each account can call this operation up to 100 times per second.
The unit of the bandwidth data returned is bit/s.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:DescribeDomainMax95BpsData

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. If you do not specify a domain name, data of all domain names is queried. Note You cannot specify multiple domain names in a DescribeDomainMax95BpsData request.	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-21T08: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-22T08:00:00Z
TimePoint	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-21T10:00:00Z
Cycle	string	No	The cycle to query the 95th percentile bandwidth data. Default value: day. Valid values: day: queries the 95th percentile bandwidth data by day. month: queries the 95th percentile bandwidth data by month.	month

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
DomainName	string	The accelerated domain name.	example.com
EndTime	string	The end of the time range for which the data was queried.	2015-12-11T21:00:00Z
StartTime	string	The beginning of the time range for which the data was queried.	2015-12-10T20:00:00Z
DomesticMax95Bps	string	The 95th percentile bandwidth in the Chinese mainland.	16777590.28
OverseasMax95Bps	string	The 95th percentile bandwidth outside the Chinese mainland.	0
Max95Bps	string	The 95th percentile bandwidth.	16777590.28
DetailData	object
Max95Detail	array<object>	Details of the 95th percentile bandwidth.
	object
TimeStamp	string	The timestamp of the returned data.	2015-12-11T21:00:00Z
Area	string	Region of the 95th percentile bandwidth.	CN
Max95BpsPeakTime	string	Time of the 95th percentile bandwidth.	2015-12-11T21:05:00Z
Max95Bps	number	The 95th percentile bandwidth.	16777590.28

Examples

Success response

JSON format

{
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "DomainName": "example.com",
  "EndTime": "2015-12-11T21:00:00Z",
  "StartTime": "2015-12-10T20:00:00Z",
  "DomesticMax95Bps": "16777590.28",
  "OverseasMax95Bps": "0",
  "Max95Bps": "16777590.28",
  "DetailData": {
    "Max95Detail": [
      {
        "TimeStamp": "2015-12-11T21:00:00Z",
        "Area": "CN",
        "Max95BpsPeakTime": "2015-12-11T21:05:00Z",
        "Max95Bps": 16777590.28
      }
    ]
  }
}

Error response

JSON format

{"RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8","HostId":"cdn.aliyuncs.com","Code":"InternalError","Message":"The request processing has failed due to some unknown error."}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	StartTime must be earlier than EndTime.
400	InvalidTimePoint.Malformed	Specified TimePoint is malformed.	The specified TimePoint parameter is invalid.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Configure a valid time span as described in API documentation.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	The specified start or end time is invalid.
404	InvalidDomain.NotFound	The domain provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.