DescribeLivePushProxyUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Queries usage data for the stream push proxy feature of the live center.
The maximum time range for a query is 31 days.
The minimum data granularity is 1 day.
You can query data from the last 90 days.

QPS limits

The queries per second (QPS) limit for a single user is 5 calls per second. If the limit is exceeded, API calls are throttled. This may affect your business operations. Plan your calls accordingly.

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

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Region	string	No	The live center to query. You can specify multiple regions. Separate multiple region IDs with commas (,). Valid values: cn-beijing: Beijing cn-shanghai: Shanghai cn-shenzhen: Shenzhen cn-qingdao: Qingdao ap-southeast-1: Singapore eu-central-1: Germany ap-northeast-1: Japan (Tokyo) ap-southeast-5: Indonesia (Jakarta) If you leave this parameter empty, aggregated data for all regions is returned.	cn-beijing
DomainName	string	No	The ingest domain name to query. You can query one or more domain names. To query multiple domain names, separate them with commas (,). If you leave this parameter empty, the merged data for all ingest domain names is returned.	example.com
StartTime	string	No	The start 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. By default, data in the last 7 days is returned.	2022-10-10T20:00:00Z
EndTime	string	No	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.	2022-10-10T21:00:00Z
SplitBy	string	No	The key to group data by. If you leave this parameter empty, data is grouped by region by default. To specify multiple keys, separate them with commas (,). Valid values: domain: domain name. If you set this parameter to domain, the Domain parameter in the response takes effect. region (default): the region where the live center is located. If you set this parameter to region, the Region parameter in the response takes effect.	region

Response elements

Element	Type	Description	Example
	object	The returned data.
EndTime	string	The end of the time range.	2022-10-10T21:00:00Z
PushProxyData	object
PushProxyDataItem	array<object>	The usage data of the stream pushing proxy feature of the live center.
	object	The usage data of the stream pushing proxy feature of the live center.
DomainName	string	The domain name for which the usage data is returned. This parameter is returned when you set SplitBy to domain.	example.com
Region	string	The live center. This parameter is returned when you set SplitBy to region.	cn-beijing
StreamCount	integer	The peak number of ingest endpoints for the stream pushing proxy feature of the live center. Unit: endpoints.	8
TimeStamp	string	The start of the time slice.	2022-10-10T20:00:00Z
RequestId	string	The ID of the request.	4B460F8B-993C-4F48-B98A-910811DEBFEB
StartTime	string	The start of the time range.	2022-10-10T20:00:00Z

Examples

Success response

JSON format

{
  "EndTime": "2022-10-10T21:00:00Z",
  "PushProxyData": {
    "PushProxyDataItem": [
      {
        "DomainName": "example.com",
        "Region": "cn-beijing",
        "StreamCount": 8,
        "TimeStamp": "2022-10-10T20:00:00Z"
      }
    ]
  },
  "RequestId": "4B460F8B-993C-4F48-B98A-910811DEBFEB",
  "StartTime": "2022-10-10T20:00:00Z"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Please refer to the API documentation to specify a reasonable time span.
400	InvalidTime.ValueNotSupported	Specified Time is malformed.	The specified time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.