DescribeUpPeakPublishStreamData - - Alibaba Cloud Documentation Center

Operation description

You can call this operation to query the daily peak number of concurrent upstream streams.

QPS limits

This operation has a queries per second (QPS) limit of 10 for each user. Exceeding this limit triggers API call throttling, which can affect 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:DescribeUpPeakPublishStreamData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
StartTime	string	Yes	The start of the time range to query. Specify the time in UTC. 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 UTC. The time range between StartTime and EndTime cannot exceed 30 days, and EndTime must be later than the current time.	2017-10-10T22:00:00Z
DomainSwitch	string	No	The switch for domain-level statistics. Valid values: on: enables domain-level statistics. off: provides user-level data. This is the default value.	on
DomainName	string	No	The accelerated domain name.	example.com

Response parameters

Parameter	Type	Description	Example
	object	The stream ingest data.
RequestId	string	The request ID.	6CFDE7AB-571A-14EA-B072-989FF753****
DescribeUpPeakPublishStreamDatas	object
DescribeUpPeakPublishStreamData	array<object>	The daily peak number of concurrent upstream streams.
	object	The daily peak number of concurrent upstream streams.
QueryTime	string	The timestamp of the data returned.	1522080000000
BandWidth	string	The daily peak upstream bandwidth.	777.2727083333333
StatName	string	The name of the statistical metric. If you set DomainSwitch to on, the domain name for live streaming is returned. If you set DomainSwitch to off or leave it empty, the user ID is returned.	push-live.aliyuncs.com
PeakTime	string	The timestamp of the peak number of concurrent upstream streams for the day.	1522180000000
PublishStreamNum	integer	The daily peak number of concurrent upstream streams.	36

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
401	IllegalOperation	%s
500	InternalError	%s
404	InvalidCaster.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.