DescribeUpBpsPeakOfLine - - Alibaba Cloud Documentation Center

Operation description

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

QPS limit

The queries per second (QPS) limit for a single user is 5 calls per second. Throttling is triggered if you exceed this limit, which may affect your business. Call this operation at a reasonable rate. For more information, see QPS limit.

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:DescribeUpBpsPeakOfLine

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
StartTime	string	Yes	The start time for stream pulling. Use the UTC format. The time between StartTime and EndTime cannot exceed 30 days.	2017-10-10T20:00:00Z
EndTime	string	Yes	The end time for stream pulling. Use the UTC format. The time between StartTime and EndTime cannot exceed 30 days. EndTime must be later than the current time.	2017-10-10T21:00:00Z
Line	string	Yes	The leased line. Valid values are integers from 0 to 9.	3
DomainSwitch	string	No	The switch for domain name-level statistics. Valid values: on: Enables statistics at the domain name level. off: Gathers 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 information.
RequestId	string	The request ID.	6CFDE7AB-571A-14EA-B072-989FF753****
DescribeUpBpsPeakOfLines	object
DescribeUpBpsPeakOfLine	array<object>	The daily peak upstream bandwidth information for the leased line.
	object	The daily peak upstream bandwidth information for the leased line.
QueryTime	string	The daily time of the query.	1522080000000
StatName	string	The name of the statistical data property. If DomainSwitch is set to on, the live streaming domain name is returned. If DomainSwitch is set to off or is not specified, the user ID is returned.	push-live.aliyuncs.com
BandWidth	number	The daily peak upstream bandwidth on the leased line.	777.2727083333333
PeakTime	string	The timestamp of the daily peak upstream bandwidth on the leased line.	1522180000000

Examples

Success response

JSON format

{
  "RequestId": "6CFDE7AB-571A-14EA-B072-989FF753****",
  "DescribeUpBpsPeakOfLines": {
    "DescribeUpBpsPeakOfLine": [
      {
        "QueryTime": "1522080000000\n",
        "StatName": "push-live.aliyuncs.com",
        "BandWidth": 777.2727083333333,
        "PeakTime": "1522180000000"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.