DescribeUpBpsPeakData - - Alibaba Cloud Documentation Center

Operation description

You can call this operation to query the daily peak upstream bandwidth for a user.

QPS limits

This operation has a queries per second (QPS) limit of 5 for each user. If you exceed the limit, API calls are throttled, which may impact your business. Call this operation at a reasonable rate. For more information, see QPS limits.

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

live:DescribeUpBpsPeakData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the UTC format. The time range between StartTime and EndTime cannot exceed 30 days.	2017-10-10T20:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the UTC format. The time range between StartTime and EndTime cannot exceed 30 days.	2017-10-10T21:00:00Z
DomainSwitch	string	No	Specifies whether to query data by domain name. Valid values: on: queries data at the domain name level. off: queries data at the user level. This is the default value.	on
DomainName	string	No	The accelerated domain name.	example.com

Response elements

Element	Type	Description	Example
	object	The bandwidth data.
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F****
DescribeUpPeakTraffics	object
DescribeUpPeakTraffic	array<object>	The daily peak upstream bandwidth data.
	object	The daily peak upstream bandwidth data.
QueryTime	string	The timestamp of the daily data.	1522080000000
BandWidth	string	The peak upstream bandwidth for the day.	777.2727083333333
StatName	string	The name of the statistical metric. If you set DomainSwitch to on, this parameter returns the domain name. If you set DomainSwitch to off or leave it empty, this parameter returns the user ID.	push-live.aliyuncs.com
PeakTime	string	The timestamp of when the peak upstream bandwidth was reached.	1522180000000

Examples

Success response

JSON format

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "DescribeUpPeakTraffics": {
    "DescribeUpPeakTraffic": [
      {
        "QueryTime": "1522080000000",
        "BandWidth": "777.2727083333333",
        "StatName": "push-live.aliyuncs.com",
        "PeakTime": "1522180000000"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.