All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveGrtnDuration

Last Updated:Sep 18, 2023

Queries the co-streaming usage data.

Usage notes

  • 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. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes DescribeLiveGrtnDuration

The operation that you want to perform. Set the value to DescribeLiveGrtnDuration.

StartTime String Yes 2022-10-10T20:00:00Z

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.

EndTime String Yes 2022-10-10T21:00:00Z

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.

AppId String No 4346289a-a790-4869-9e23-22766d5e****

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.

Area String No CN

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 India, 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.

Interval String No 3600

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.

Response parameters

Parameter

Type

Example

Description

RequestId String 4B460F8B-993C-4F48-B98A-910811DEBFEB

The request ID.

StreamDetailData Array of StreamData

Details about the co-streaming usage data.

StreamData
Duration Long 30

The co-streaming duration. Unit: minutes.

TimeStamp String 2022-12-10T20:00:00Z

The timestamp of the data returned.

MediaProfile String 480P

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.
MediaType String audio

The media type. Valid values:

  • audio
  • video
AppId String 4346289a-a790-4869-9e23-22766d5e****

The ID of the application.

Examples

Sample requests

http://live.aliyuncs.com?Action=DescribeLiveGrtnDuration&DomainName=example.com
&StartTime=2022-12-10T20:00:00Z
&EndTime=2022-12-10T22:00:00Z
&Area=CN,OverSeas
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveGrtnDurationResponse>
    <StreamDetailData>
        <StreamData>
            <TimeStamp>2022-12-10T20:00:00Z</TimeStamp>
            <MediaType>video</MediaType>
            <MediaProfile>720P</MediaProfile>
            <Duration>423304182</Duration>
        </StreamData>
        <StreamData>
            <TimeStamp>2022-12-10T21:00:00Z</TimeStamp>
            <MediaType>video</MediaType>
            <MediaProfile>720P</MediaProfile>
            <Duration>454680793</Duration>
        </StreamData>
    </StreamDetailData>
    <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId>
</DescribeLiveGrtnDurationResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "StreamDetailData" : {
    "StreamData" : [ {
      "TimeStamp" : "2022-12-10T20:00:00Z",
      "MediaType" : "video",
      "MediaProfile" : "720P",
      "Duration" : "423304182"
    }, {
      "TimeStamp" : "2022-12-10T21:00:00Z",
      "MediaType" : "video",
      "MediaProfile" : "720P",
      "Duration" : "454680793"
    } ]
  },
  "RequestId" : "B955107D-E658-4E77-B913-E0AC3D31693E"
}

Error codes

HttpCode

Error code

Error message

Description

400 InvalidStartTime.Malformed Specified StartTime is malformed. The error message returned because the value specified for StartTime is invalid. Check whether the value of the StartTime parameter is valid.
400 InvalidEndTime.Malformed Specified EndTime is malformed. The error message returned because the value specified for EndTime is invalid. Check whether the value of the EndTime parameter is valid.
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. The error message returned because the end time does not match the start time. Check whether the value of the EndTime parameter matches.
400 InvalidTimeSpan The time span exceeds the limit. The error message returned because the time range exceeds the limit. Configure a valid time range to query.
400 InvalidTime.ValueNotSupported Specified Time is malformed. The error message returned because the start time and end time do not match.

For a list of error codes, see Service error codes.

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.