All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveUpVideoAudioInfo

Last Updated:Dec 05, 2024

Queries the audio and video data of an ingested stream within a specific period of time.

Operation description

Usage notes

  • The maximum time range for a query is 24 hours.
  • The minimum time range for a query is 1 hour.
  • You can query data in the last 31 days.

QPS limit

You can call this operation up to 10 times per minute 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

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveUpVideoAudioInfoget
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StreamstringYes

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

rtmp://example.com/AppName/StreamName
StartTimestringNo

The name of the stream that you want to query. Specify this parameter in the following format: rtmp://Ingest domain/Application name/Stream name.

2015-12-10T15:00:00Z
EndTimestringNo

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.

2015-12-10T15:10:00Z

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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.

BC858082-736F-4A25-867B-E5B67C85ACF7
UpItemsarray<object>

The request ID.

PublishItemobject
AacHeadersarray<object>

The details about the audio and video data of the stream ingest occurrences.

AacHeadersobject

The number of AAC headers in the audio.

Timelong

The number of AAC headers in the audio.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

20
AppNamestring

The metric value at a granularity of seconds at the query time.

AppName
AudioBitRatearray<object>

The name of the application to which the ingested stream belongs.

AudioBitRateobject

The bitrate of the audio. Unit: bit/s.

Timelong

The bitrate of the audio. Unit: bit/s.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

24552
AudioFramesarray<object>

The metric value at a granularity of seconds at the query time.

AudioFramesobject

The frame rate of the audio. Unit: frames.

Timelong

The frame rate of the audio. Unit: frames.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

23
AudioIntervalarray<object>

The metric value at a granularity of seconds at the query time.

AudioIntervalobject

The maximum audio frame interval. Unit: milliseconds.

Timelong

The maximum audio frame interval. Unit: milliseconds.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

254
AudioStampsarray<object>

The metric value at a granularity of seconds at the query time.

AudioStampsobject

The audio timestamp. Unit: milliseconds.

Timelong

The audio timestamp. Unit: milliseconds.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

725053422
AvcHeadersarray<object>

The metric value at a granularity of seconds at the query time.

AvcHeadersobject

The number of AVC headers in the audio.

Timelong

The number of AVC headers in the audio.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

11
CodecInfostring

The metric value at a granularity of seconds at the query time.

H264/AAC
DomainNamestring

The audio and video encoding information.

example.com
ErrorFlagsarray<object>

The ingest domain.

ErrorFlagsobject

The number of times the error code that indicates interrupted stream ingest was returned.

Timelong

The number of times the error code that indicates interrupted stream ingest was returned.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

0
PublishIntervalstring

The metric value at a granularity of seconds at the query time.

-
PublishIpstring

The stream ingest duration. Unit: seconds. A hyphen (-) indicates that the stream is being ingested and the duration cannot be returned.

cn397
PublishStatusstring

The IP address of the stream ingest client.

1
PublishTimestring

The stream ingest status. A value of 1 indicates that the stream is being ingested. A value of 0 indicates that the stream was ingested.

2015-12-10T15:00:00Z
StopTimestring

The start time of stream ingest. The time is displayed in UTC.

2015-12-10T15:10:00Z
StreamNamestring

The end time of stream ingest. The time is displayed in UTC.

StreamName
UniqueIdstring

The name of the stream.

2.-395_37261_9848098_1538080899396
VideoAndAudioStamparray<object>

The unique ID of each stream ingest occurrence.

V_AStampobject

The difference between the audio and video timestamps. Unit: milliseconds.

Timelong

The difference between the audio and video timestamps. Unit: milliseconds.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

359
VideoBitRatearray<object>

The metric value at a granularity of seconds at the query time.

VideoBitRateobject

The bitrate of the video. Unit: bit/s.

Timelong

The bitrate of the video. Unit: bit/s.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

3970160
VideoFramesarray<object>

The metric value at a granularity of seconds at the query time.

VideoFramesobject
Timelong

The frame rate of the video. Unit: frames.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

29
VideoIntervalarray<object>

The metric value at a granularity of seconds at the query time.

VideoIntervalobject

The maximum video frame interval. Unit: milliseconds.

Timelong

The maximum video frame interval. Unit: milliseconds.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

278
VideoStampsarray<object>

The metric value at a granularity of seconds at the query time.

VideoStampsobject

The video timestamp. Unit: milliseconds.

Timelong

The video timestamp. Unit: milliseconds.

1538134750408
Valueinteger

The query time. The value is a UNIX timestamp in milliseconds.

725053781

Examples

Sample success responses

JSONformat

{
  "RequestId": "BC858082-736F-4A25-867B-E5B67C85ACF7",
  "UpItems": {
    "PublishItem": [
      {
        "AacHeaders": {
          "AacHeaders": [
            {
              "Time": 1538134750408,
              "Value": 20
            }
          ]
        },
        "AppName": "AppName",
        "AudioBitRate": {
          "AudioBitRate": [
            {
              "Time": 1538134750408,
              "Value": 24552
            }
          ]
        },
        "AudioFrames": {
          "AudioFrames": [
            {
              "Time": 1538134750408,
              "Value": 23
            }
          ]
        },
        "AudioInterval": {
          "AudioInterval": [
            {
              "Time": 1538134750408,
              "Value": 254
            }
          ]
        },
        "AudioStamps": {
          "AudioStamps": [
            {
              "Time": 1538134750408,
              "Value": 725053422
            }
          ]
        },
        "AvcHeaders": {
          "AvcHeaders": [
            {
              "Time": 1538134750408,
              "Value": 11
            }
          ]
        },
        "CodecInfo": "H264/AAC",
        "DomainName": "example.com",
        "ErrorFlags": {
          "ErrorFlags": [
            {
              "Time": 1538134750408,
              "Value": 0
            }
          ]
        },
        "PublishInterval": "-",
        "PublishIp": "cn397",
        "PublishStatus": "1",
        "PublishTime": "2015-12-10T15:00:00Z",
        "StopTime": "2015-12-10T15:10:00Z",
        "StreamName": "StreamName",
        "UniqueId": "2.-395_37261_9848098_1538080899396",
        "VideoAndAudioStamp": {
          "V_AStamp": [
            {
              "Time": 1538134750408,
              "Value": 359
            }
          ]
        },
        "VideoBitRate": {
          "VideoBitRate": [
            {
              "Time": 1538134750408,
              "Value": 3970160
            }
          ]
        },
        "VideoFrames": {
          "VideoFrames": [
            {
              "Time": 1538134750408,
              "Value": 29
            }
          ]
        },
        "VideoInterval": {
          "VideoInterval": [
            {
              "Time": 1538134750408,
              "Value": 278
            }
          ]
        },
        "VideoStamps": {
          "VideoStamps": [
            {
              "Time": 1538134750408,
              "Value": 725053781
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
200InvalidDuration.ExceedOneDayStartTime and EndTime Duration Exceeds One Day
200InvalidDuration.StratTimeBiggerEndTimeStartTime Bigger Than EndTime
400InvalidParamParameter Stream invalid.
400InvalidParamParameter StartTime/EndTime invalid.
400InvalidStartTime.MalformedSpecified StartTime is malformed.
400InvalidEndTime.MalformedSpecified EndTime is malformed.
401IllegalOperation%s

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

Change history

Change timeSummary of changesOperation
No change history