ListLiveRecordVideo - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries live-to-VOD videos.

Operation Description

You can query a maximum of 5,000 videos based on the specified filter condition.

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.

Operation	Access level	Resource type	Condition key	Associated operation
vod:ListLiveRecordVideo	List	VOD acs:vod::{#accountId}:/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
StreamName	string	No	The name of the recorded live stream.	live-test
DomainName	string	No	The domain name of the recorded live stream.	example.aliyundoc.com
AppName	string	No	The name of the application that was used to record the live stream.	testApp
PageNo	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
SortBy	string	No	The sorting rule of results. Valid values: CreationTime:Desc: sorts the results based on the creation time in descending order. This is the default value. CreationTime:Asc: sorts the results based on the creation time in ascending order.	CreationTime:Desc
StartTime	string	No	The beginning of the time range to query. The query is performed based on the time range during which the required live streams were recorded. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-01-11T12:00:00Z
EndTime	string	No	The end of the time range to query. The query is performed based on the time range during which the required live streams were recorded. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-01-11T13:00:00Z

Response parameters

Parameter	Type	Description	Example
	object
Total	integer	The total number of videos returned.	123
RequestId	string	The ID of the request.	25818875-5F78-4A13-****-D7393642CA58
LiveRecordVideoList	object []	The list of videos.
AppName	string	The name of the application.	testApp
PlaylistId	string	The ID of the playlist.	****
StreamName	string	The name of the live stream.	live-test
RecordEndTime	string	The end of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-12-08T08:44:56Z
RecordStartTime	string	The beginning of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-12-08T07:40:56Z
DomainName	string	The domain name.	example.com
Video	object	The information about the video.
CreationTime	string	The time when the video was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-12-08T07:40:56Z
Status	string	The status of the video. Valid values: Uploading:: indicates that the video is being uploaded. UploadFail: indicates that the video failed to be uploaded. UploadSucces: indicates that the video was uploaded. Transcoding: indicates that the video is being transcoded. TranscodeFail: indicates that the video failed to be transcoded. Blocked: indicates that the video is blocked. Normal: indicates that the video is in a normal state.	Normal
CateId	integer	The ID of the video category.	78
VideoId	string	The ID of the video.	93ab850b4f6f*****54b6e91d24d81d4
Tags	string	The tags of the video. Separate multiple tags with commas (,).	tag1, tag2
CateName	string	The name of the video category.	Category name
Description	string	The description of the video.	Description of the ApsaraVideo VOD video
Size	long	The size of the mezzanine file. Unit: byte.	10897890
CoverURL	string	The thumbnail URL of the video.	https://example.aliyundoc.com/coversample.jpg
TemplateGroupId	string	The ID of the transcoding template group.	1
Duration	float	The duration of the video. Unit: seconds.	135.6
Title	string	The title of the video.	Title of the ApsaraVideo VOD video
ModifyTime	string	The last time when the video was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-12-08T09:40:56Z
Snapshots	array	The array of video snapshot URLs.
	string	The array of video snapshot URLs.	{"Snapshot":["http://example.aliyundoc.com/snapshot/sample000001.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333**","http://example.aliyundoc.com/snapshot/sample00002.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272**"]}

Examples

Sample success responses

JSONformat

{
  "Total": 123,
  "RequestId": "25818875-5F78-4A13-****-D7393642CA58",
  "LiveRecordVideoList": {
    "LiveRecordVideo": [
      {
        "AppName": "testApp",
        "PlaylistId": "****",
        "StreamName": "live-test",
        "RecordEndTime": "2017-12-08T08:44:56Z",
        "RecordStartTime": "2017-12-08T07:40:56Z",
        "DomainName": "example.com",
        "Video": {
          "CreationTime": "2017-12-08T07:40:56Z",
          "Status": "Normal",
          "CateId": 78,
          "VideoId": "93ab850b4f6f*****54b6e91d24d81d4",
          "Tags": "tag1, tag2",
          "CateName": "Category name",
          "Description": "Description of the ApsaraVideo VOD video",
          "Size": 10897890,
          "CoverURL": "https://example.aliyundoc.com/coversample.jpg",
          "TemplateGroupId": "1",
          "Duration": 135.6,
          "Title": "Title of the ApsaraVideo VOD video",
          "ModifyTime": "2017-12-08T09:40:56Z",
          "Snapshots": {
            "Snapshot": [
              "{\"Snapshot\":[\"http://example.aliyundoc.com/snapshot/sample000001.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e27333****\",\"http://example.aliyundoc.com/snapshot/sample00002.jpg?auth_key=1498476426-0-0-f00b9455c49a423ce69cf4e272****\"]}"
            ]
          }
        }
      }
    ]
  }
}

Error codes

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

The following table describes the errors that are specific to this operation. For more information about errors common to all operations, see Common errors.

Error code	Error message	HTTP status code	Description
IpsIsEmpty	The specified “Ips” can not be empty.	400	The error message returned because the Ips parameter is not specified.
IpsExceededMax	The specified Ips count has exceeded 100.	403	The error message returned because more than 100 IP addresses are added to a group.
SecurityIpGroupExceededMax	The audit security group count has exceeded 10.	403	The error message returned because the number of review security groups exceeds the upper limit.