DescribeLiveGrtnDuration - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the co-streaming usage data.

Operation description

The maximum time range for a query is 31 days.
The minimum time granularity for a query is 5 minutes.
You can query the data in the last 90 days.

QPS limit

You can call this operation up to 10 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:DescribeLiveGrtnDuration		Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	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.	2022-10-10T20:00:00Z
EndTime	string	Yes	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. The time range that can be specified is greater than or equal to 5 minutes and less than or equal to 31 days.	2022-10-10T21:00:00Z
AppId	string	No	The ID of the application. Separate multiple application IDs with commas (,). You can specify up to 30 application IDs. By default, the aggregated data of all applications is returned.	4346289a-a790-4869-9e23-22766d5e****
Area	string	No	The ID of the billable region. Valid values: CN: Chinese mainland OverSeas: countries and regions outside the Chinese mainland AP1: Asia Pacific 1, including Hong Kong (China), Macao (China), Taiwan (China), Japan, and other Southeast Asia countries and regions except Vietnam and Indonesia AP2: Asia Pacific 2, including Indonesia, South Korea, and Vietnam AP3: Asia Pacific 3, including Australia and New Zealand NA: North America, including US and Canada SA: South America, specifically meaning Brazil EU: Europe, including Ukraine, UK, France, Netherlands, Spain, Italy, Sweden, and Germany MEAA: Middle East and Africa, including South Africa, Oman, UAE, and Kuwait If you do not specify this parameter, data of all regions is aggregated and returned by default.	CN
Interval	string	No	The time granularity of the query. Unit: seconds. Valid values: 300 3600 86400 If you specify an invalid value or do not specify this parameter, the default value 3600 is used.	3600

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The request ID.	4B460F8B-993C-4F48-B98A-910811DEBFEB
StreamDetailData	array<object>	The details of the co-streaming usage data.
StreamData	object	The details of the co-streaming usage data.
AppId	string	The ID of the application.	4346289a-a790-4869-9e23-22766d5e****
Duration	long	The co-streaming duration. Unit: minutes.	30
MediaProfile	string	The media specification. Valid values: 0: audio-only. This is a basic specification. 480P: standard definition (SD). The video resolution is 640 × 480 or lower. 720P: high definition (HD). The video resolution is 1280 × 720 or lower. 1080P: full HD. The video resolution is 1920 × 1080 or lower.	480P
MediaType	string	The media type. Valid values: audio video	audio
TimeStamp	string	The timestamp of the returned data.	2022-12-10T20:00:00Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "4B460F8B-993C-4F48-B98A-910811DEBFEB",
  "StreamDetailData": {
    "StreamData": [
      {
        "AppId": "4346289a-a790-4869-9e23-22766d5e****",
        "Duration": 30,
        "MediaProfile": "480P",
        "MediaType": "audio",
        "TimeStamp": "2022-12-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	InvalidAreaParameter	The specified Area parameter is invalid.	The specified Area parameter is invalid. Specify a correct region code.
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	InvalidAppIdParameter	The specified AppId parameter is invalid.	-
400	InvalidInstanceIdParameter	The specified InstanceId parameter is invalid.	-
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

Special error codes

Error code	Error message	HTTP status code	Description
Throttling	Request was denied due to request throttling.	503	The error message returned because the request was denied due to throttling.
IllegalOperation	Illegal domain, operation is not permitted.	403	The error message returned because the specified domain name is invalid.
OperationDenied	Your account does not open LIVE service yet.	403	The error message returned because ApsaraVideo Live is not activated.
OperationDenied	Your LIVE service is suspended.	403	The error message returned because ApsaraVideo Live is suspended.
InvalidStartTime.Malformed	Specified StartTime is malformed.	400	The error message returned because one or more parameters are invalid.
InvalidEndTime.Malformed	Specified EndTime is malformed.	400	The error message returned because the time format is invalid.
InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	400	The error message returned because the format of the start time or end time is invalid.
InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	400	The error message returned because the start time and end time do not match.
InvalidTimeSpan	The time span exceeds the limit.	400	The error message returned because the specified time range to query is invalid.
InvalidAppIdParameter	The specified AppId parameter is invalid.	400	The error message returned because the value of the AppID parameter is invalid.
InvalidParameterInterval	Invalid Parameter Interval.	400	The error message returned because the value of the Interval parameter is invalid.