DescribeVodDomainMax95BpsData API Reference - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the 95th percentile bandwidth monitoring data for accelerated domain names.

Operation description

Three query methods are available:

When both StartTime and EndTime are specified: if the difference between EndTime and StartTime is within 24 hours, the 95th percentile bandwidth of the day that contains StartTime is returned. Otherwise, the 95th percentile bandwidth of the month that contains StartTime is returned.
When both TimePoint and Cycle are specified, the 95th percentile bandwidth of the cycle that contains TimePoint is returned.
When StartTime and EndTime are specified with an additional Cycle parameter, the 95th percentile bandwidth for all specified cycles within the query range is returned.

If none of these three methods are specified, the 95th percentile bandwidth of the past 24 hours is returned by default.

Maximum query span: 90 days.
Minimum query granularity: 1 day.
Maximum query range: 90 days.
Maximum number of calls per user per second: 100.
Data unit: 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

vod:DescribeVodDomainMax95BpsData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name to query. If this parameter is left empty, the merged data of all accelerated domain names is returned by default. Note Batch domain name queries are not supported.	example.com
StartTime	string	No	The start time of the query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-01-11T12:00:00Z
EndTime	string	No	The end time of the 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-01-12T13:00:00Z
TimePoint	string	No	The start time point for data retrieval. 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 for the 95th percentile bandwidth. Default value: day. Valid values: day: queries the 95th percentile bandwidth by day. month: queries the 95th percentile bandwidth by month.	month

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	25818875-5F78-4A*****F6-D7393642CA58
DomainName	string	The accelerated domain name information.	example.com
EndTime	string	The end time of the data.	2017-01-11T13:00:00Z
StartTime	string	The start time of the data.	2017-01-11T12: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>	The detailed 95th percentile bandwidth data.
	object
TimeStamp	string	The timestamp of the returned data.	2024-01-18 10:11:32
Area	string	The billable region where the peak 95 data was collected.	CN
Max95BpsPeakTime	string	The time corresponding to the 95th percentile bandwidth peak.	2015-12-11T21:05:00Z
Max95Bps	number	The 95th percentile bandwidth.	16777590.28

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "DomainName": "example.com",
  "EndTime": "2017-01-11T13:00:00Z",
  "StartTime": "2017-01-11T12:00:00Z",
  "DomesticMax95Bps": "16777590.28\n",
  "OverseasMax95Bps": "0",
  "Max95Bps": "16777590.28\n",
  "DetailData": {
    "Max95Detail": [
      {
        "TimeStamp": "2024-01-18 10:11:32",
        "Area": "CN",
        "Max95BpsPeakTime": "2015-12-11T21:05:00Z\n",
        "Max95Bps": 16777590.28
      }
    ]
  }
}

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.
400	InvalidTimePoint.Malformed	Specified TimePoint is malformed.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Configure a valid time span based on the documentation.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.
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.