DescribeLiveUpVideoAudioInfo - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the audio and video parameters of an upstream ingest stream within a specified time range.

Operation description

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

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per minute. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this API 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:DescribeLiveUpVideoAudioInfo

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Stream	string	Yes	The full name of the stream to query. The format is `rtmp://<ingest domain>/<AppName>/<StreamName>`	rtmp://example.com/AppName/StreamName
StartTime	string	No	The start time. The format is `yyyy-MM-ddTHH:mm:ssZ` in UTC.	2015-12-10T15:00:00Z
EndTime	string	No	The end time. The format is `yyyy-MM-ddTHH:mm:ssZ` in UTC.	2015-12-10T15:10:00Z

Response parameters

Parameter	Type	Description	Example
	object	The audio and video information.
RequestId	string	The request ID.	BC858082-736F-4A25-867B-E5B67C85ACF7
UpItems	object
PublishItem	array<object>	The information about the ingest streams.
	object	The details of the ingest stream.
AacHeaders	object
AacHeaders	array<object>	The number of audio Advanced Audio Coding (AAC) headers per second. Unit: count.
	object	The audio AAC headers per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	20
AppName	string	The name of the ingest application.	AppName
AudioBitRate	object
AudioBitRate	array<object>	The audio bitrate per second. Unit: bit/s.
	object	The audio bitrate per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	24552
AudioFrames	object
AudioFrames	array<object>	The audio frame rate per second. Unit: frames.
	object	The audio frame rate per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	23
AudioInterval	object
AudioInterval	array<object>	The maximum audio frame interval per second. Unit: milliseconds.
	object	The maximum audio frame interval per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	254
AudioStamps	object
AudioStamps	array<object>	The audio timestamp per second. Unit: milliseconds.
	object	The audio timestamp per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	725053422
AvcHeaders	object
AvcHeaders	array<object>	The number of video Advanced Video Coding (AVC) headers per second. Unit: count.
	object	The video AVC headers per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	11
CodecInfo	string	The audio and video encoding information.	H264/AAC
DomainName	string	The ingest domain name.	example.com
ErrorFlags	object
ErrorFlags	array<object>	The error code for the stream ingest disconnection.
	object	The error code for the stream ingest disconnection.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	0
PublishInterval	string	The duration of the stream ingest in seconds. A hyphen (-) indicates that the stream is ongoing and the duration is not yet available.	-
PublishIp	string	The IP address of the ingest client.	cn397
PublishStatus	string	The status of the stream ingest. `1`: The stream is ongoing. `0`: The stream has ended.	1
PublishTime	string	The start time of the stream ingest in UTC format.	2015-12-10T15:00:00Z
StopTime	string	The end time of the stream ingest in UTC format.	2015-12-10T15:10:00Z
StreamName	string	The name of the stream.	StreamName
UniqueId	string	The unique ID for each stream ingest session.	2.-395_37261_9848098_1538080899396
VideoAndAudioStamp	object
V_AStamp	array<object>	The difference between the video and audio timestamps per second. Unit: milliseconds.
	object	The difference between the video and audio timestamps per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	359
VideoBitRate	object
VideoBitRate	array<object>	The video bitrate per second. Unit: bit/s.
	object	The video bitrate per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	3970160
VideoFrames	object
VideoFrames	array<object>	The video frame rate per second. Unit: frames.
	object	The video frame rate per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	29
VideoInterval	object
VideoInterval	array<object>	The maximum video frame interval per second. Unit: milliseconds.
	object	The maximum video frame interval per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	278
VideoStamps	object
VideoStamps	array<object>	The video timestamp per second. Unit: milliseconds.
	object	The video timestamp per second.
Time	integer	The query time. This is a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The value of the metric per second at the specified time.	725053781

If a parameter does not exist, an empty string is returned.

Examples

Success response

JSON format

{
  "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 code	Error code	Error message
200	InvalidDuration.ExceedOneDay	StartTime and EndTime Duration Exceeds One Day
200	InvalidDuration.StratTimeBiggerEndTime	StartTime Bigger Than EndTime
400	InvalidParam	Parameter Stream invalid.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
401	IllegalOperation	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.