DescribeLivePushProxyUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the usage data of live center stream relay.

Operation description

You can call this operation to query the usage data of live center stream relay.
The maximum time range for a query is 31 days.
The minimum time granularity for a query is 1 day.
You can query the data in the last 90 days.

QPS limit

You can call this operation up to 5 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLivePushProxyUsageData		Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The ID of the region. Separate multiple region IDs with commas (,). Valid values: cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-shenzhen: China (Shenzhen) cn-qingdao: China (Qingdao) ap-southeast-1: Singapore eu-central-1: Germany (Frankfurt) ap-northeast-1: Japan (Tokyo) ap-southeast-5: Indonesia (Jakarta) If you do not specify this parameter, data of all regions is aggregated and returned by default.	cn-beijing
DomainName	string	No	The main streaming domain to query. You can query one or more domain names. If you specify multiple domain names, separate them with commas (,). If you leave this parameter empty, the data of all domain names within your Alibaba Cloud account is returned.	example.com
StartTime	string	No	The beginning 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 seven days is returned.	2022-10-10T20:00:00Z
EndTime	string	No	The end 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. The end time must be later than the start time.	2022-10-10T21:00:00Z
SplitBy	string	No	The key that is used to group data. If you do not specify this parameter, the default value region is used. Data is aggregated and returned. Separate multiple keys with commas (,). Valid values: domain: The value of DomainName in the response takes effect only if SplitBy is set to domain. region: This is the default value. The value of Region in the response takes effect only if SplitBy is set to region.	region

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
EndTime	string	The end time.	2022-10-10T21:00:00Z
PushProxyData	array<object>	The usage data of live center stream relay.
PushProxyDataItem	object	The usage data of live center stream relay.
DomainName	string	The domain name. If the value of SplitBy includes domain, the returned data is grouped by domain name.	example.com
Region	string	The ID of the region. If the value of SplitBy includes region, the returned data is grouped by region.	cn-beijing
StreamCount	long	The peak number of live center stream relay channels.	8
TimeStamp	string	The timestamp of the returned data.	2022-10-10T20:00:00Z
RequestId	string	The request ID.	4B460F8B-993C-4F48-B98A-910811DEBFEB
StartTime	string	The start time.	2022-10-10T20:00:00Z

Examples

Sample success responses

JSONformat

{
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history