All Products
Search
Document Center

ApsaraVideo VOD:ListLiveRecordVideo

Last Updated:May 22, 2024

Queries live-to-VOD videos.

Operation description

You can query up to 5,000 videos based on the specified filter condition.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
vod:ListLiveRecordVideoList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StreamNamestringNo

The name of the recorded live stream.

live-test
DomainNamestringNo

The domain name of the recorded live stream.

example.aliyundoc.com
AppNamestringNo

The name of the application that was used to record the live stream.

testApp
PageNointegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10
SortBystringNo

The sorting rule of the results. Valid values:

  • CreationTime:Desc: The results are sorted in reverse chronological order based on the creation time.
  • CreationTime:Asc: The results are sorted in chronological order based on the creation time.
CreationTime:Desc
StartTimestringNo

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
EndTimestringNo

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

ParameterTypeDescriptionExample
object
Totalinteger

The total number of videos.

123
RequestIdstring

The ID of the request.

25818875-5F78-4A13-****-D7393642CA58
LiveRecordVideoListobject []

The list of videos.

AppNamestring

The name of the app.

testApp
PlaylistIdstring

The ID of the playlist.

****
StreamNamestring

The name of the live-to-VOD file.

live-test
RecordEndTimestring

The recording end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-12-08T08:44:56Z
RecordStartTimestring

The recording start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-12-08T07:40:56Z
DomainNamestring

The domain name.

example.com
Videoobject

The information about the live-to-VOD file.

CreationTimestring

The time when the audio or video file was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-12-08T07:40:56Z
Statusstring

The status of the video. Valid values:

  • Uploading
  • UploadFail
  • UploadSuccess
  • Transcoding
  • TranscodeFail
  • Blocked
  • Normal: The video is normal.
Normal
CateIdinteger

The ID of the video category.

78
VideoIdstring

The ID of the video.

93ab850b4f6f*****54b6e91d24d81d4
Tagsstring

The tags of the video. Multiple tags are separated with commas (,).

tag1, tag2
CateNamestring

The category of the video.

Category name
Descriptionstring

The description of the video file.

Description of the ApsaraVideo VOD video
Sizelong

The size of the source video file. Unit: bytes.

10897890
CoverURLstring

The URL of the video thumbnail.

https://example.aliyundoc.com/coversample.jpg
TemplateGroupIdstring

The ID of the transcoding template group.

1
Durationfloat

The duration of the video file. Unit: seconds.

135.6
Titlestring

The title of the video.

Title of the ApsaraVideo VOD video
ModifyTimestring

The time when the video was updated. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-12-08T09:40:56Z
Snapshotsarray

The array of video snapshot URLs.

string

The video snapshot URL.

{"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 codeError messageHTTP status codeDescription
IpsIsEmptyThe specified “Ips” can not be empty.400The error message returned because the Ips parameter is not specified.
IpsExceededMaxThe specified Ips count has exceeded 100.403The error message returned because more than 100 IP addresses are added to a group.
SecurityIpGroupExceededMaxThe audit security group count has exceeded 10.403The error message returned because the number of review security groups exceeds the upper limit.