DescribeLiveGrtnDuration - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

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

QPS limit

The queries per second (QPS) limit for this operation is 10 calls per second per user. API calls that exceed this limit are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.

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

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
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. The end time must be later than the start time. The time span between the start and end times must be between 5 minutes and 31 days, inclusive. 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
AppId	string	No	The application ID. You can query multiple application IDs. Separate multiple IDs with commas (,). You can query up to 30 IDs. If you do not specify this parameter, the aggregated data of all applications is returned.	4346289a-a790-4869-9e23-22766d5e****
Area	string	No	The area code. Valid values: CN: the Chinese mainland. OverSeas: regions outside the Chinese mainland. AP1: Asia Pacific 1. This area includes Hong Kong (China), Macao (China), Taiwan (China), Japan, and Southeast Asian countries except for Vietnam and Indonesia. AP2: Asia Pacific 2. This area includes Indonesia, South Korea, and Vietnam. AP3: Asia Pacific 3. This area includes Australia and New Zealand. NA: North America. This area includes the United States and Canada. SA: South America. This area includes Brazil. EU: Europe. This area includes Ukraine, the United Kingdom, France, the Netherlands, Spain, Italy, Sweden, and Germany. MEAA: Middle East and Africa. This area includes South Africa, Oman, the United Arab Emirates, and Kuwait. If you do not specify this parameter, aggregated data for all areas is returned.	CN
Interval	string	No	The time granularity of the data to query. Unit: seconds. Valid values: 300 3600 86400 If you do not specify this parameter or specify an unsupported value, the default value 3600 is used.	3600

Response elements

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

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.