DescribeLiveUpVideoAudioInfo-阿里云帮助中心

Queries the audio and video parameters of upstream ingest streams within a specified time period.

Operation description

The maximum query time span is 24 hours.
The minimum query time span is 1 minute.
The maximum query time range is 7 days.

QPS limit

The single-user QPS limit for this API is 10 calls per minute. If the limit is exceeded, API calls are throttled, which may affect your business. Call this API appropriately.

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 name of the stream to query. Specify the full stream name in the following format: `rtmp://Ingest domain/App name/Stream name`.	rtmp://example.com/AppName/StreamName
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2015-12-10T15:00:00Z
EndTime	string	No	The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2015-12-10T15:10:00Z

Response elements

Element	Type	Description	Example
	object	The video and audio information.
RequestId	string	The request ID.	BC858082-736F-4A25-867B-E5B67C85ACF7
UpItems	object
PublishItem	array<object>	The total number of aggregated ingest streams in the response.
	array<object>	The information.
AacHeaders	object
AacHeaders	array<object>	The per-second audio AAC headers. Unit: count.
	object	The per-second audio AAC header.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	20
AppName	string	The name of the ingest application.	AppName
AudioBitRate	object
AudioBitRate	array<object>	The per-second audio bitrate. Unit: bit/s.
	object	The per-second audio bitrate.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	24552
AudioFrames	object
AudioFrames	array<object>	The per-second audio frame rate. Unit: frames.
	object	The per-second audio frame rate.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	23
AudioInterval	object
AudioInterval	array<object>	The per-second maximum audio frame interval. Unit: milliseconds.
	object	The per-second maximum audio frame interval.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	254
AudioStamps	object
AudioStamps	array<object>	The per-second audio timestamp. Unit: milliseconds.
	object	The per-second audio timestamp.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	725053422
AvcHeaders	object
AvcHeaders	array<object>	The per-second audio AVC headers. Unit: count.
	object	The per-second audio AVC header.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	11
CodecInfo	string	The audio and video codec information.	H264/AAC
DomainName	string	The ingest domain.	example.com
ErrorFlags	object
ErrorFlags	array<object>	The error codes for stream ingest disconnection.
	object	The error codes for stream ingest disconnection.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	0
PublishInterval	string	The stream ingest duration, in seconds. A value of "-" indicates that stream ingest is in progress and the duration is not yet available.	-
PublishIp	string	The IP address of the stream ingest client.	cn397
PublishStatus	string	The stream ingest status. Valid values: 1: stream ingest is in progress. 0: stream ingest has ended.	1
PublishTime	string	The start time of stream ingest, in UTC format.	2015-12-10T15:00:00Z
StopTime	string	The end time of 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 per-second difference between the video UNIX timestamp and the audio UNIX timestamp. Unit: milliseconds.
	object	The per-second difference between the video UNIX timestamp and the audio UNIX timestamp.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	359
VideoBitRate	object
VideoBitRate	array<object>	The per-second video bitrate. Unit: bit/s.
	object	The per-second video bitrate.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	3970160
VideoFrames	object
VideoFrames	array<object>	The per-second video frame rate. Unit: frames.
	object	The per-second video frame rate.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	29
VideoInterval	object
VideoInterval	array<object>	The per-second maximum video keyframe interval. Unit: milliseconds.
	object	The per-second maximum video keyframe interval.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	278
VideoStamps	object
VideoStamps	array<object>	The per-second video timestamp. Unit: milliseconds.
	object	The per-second video timestamp.
Time	integer	The query time, expressed as a UNIX timestamp in milliseconds.	1538134750408
Value	integer	The per-second metric value of the corresponding quality data at the query time.	725053781

If certain parameters do 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	Description
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, please check and try again later.	Operation not allowed, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.