DescribeLiveStreamRecordContent - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the recordings of a live stream.

Operation description

Obtain the main streaming domain, and then call this operation to query the recordings of a live stream.

The information returned by this API is organized by recording task. To get information about specific recording files within a task, use the DescribeLiveStreamRecordIndexFiles and DescribeLiveStreamRecordIndexFile APIs.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions.

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:DescribeLiveStreamRecordContent

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The main streaming domain.	example.com
AppName	string	Yes	The AppName of the live stream.	liveApp****
StreamName	string	Yes	The name of the live stream.	liveStream****
StartTime	string	Yes	The start time for the query. You can query records from the last 6 months. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-21T08:00:00Z
EndTime	string	Yes	The end time for the query. The time range between StartTime and EndTime cannot exceed 4 days. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-12-22T08:00:00Z

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	62136AE6-7793-45ED-B14A-60D19A9486D3
RecordContentInfoList	object
RecordContentInfo	array<object>	A list of recording content information.
	object
EndTime	string	End time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-12-01T07:46:00Z
StartTime	string	Start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-12-01T07:36:00Z
Duration	number	Recording duration. Unit: seconds.	10
OssBucket	string	The name of the OSS bucket.	liveBucket****
OssObjectPrefix	string	The naming convention (prefix) for recorded files stored in OSS.	record/{Date}/{UnixTimestamp}_{Sequence}
OssEndpoint	string	The endpoint of the OSS bucket.	cn-oss-****.aliyuncs.com

Note

For information on how to construct the URL to access OSS resources, see Use presigned URLs to download or preview files.

Examples

Success response

JSON format

{
  "RequestId": "62136AE6-7793-45ED-B14A-60D19A9486D3",
  "RecordContentInfoList": {
    "RecordContentInfo": [
      {
        "EndTime": "2015-12-01T07:46:00Z",
        "StartTime": "2015-12-01T07:36:00Z",
        "Duration": 10,
        "OssBucket": "liveBucket****",
        "OssObjectPrefix": "record/{Date}/{UnixTimestamp}_{Sequence}",
        "OssEndpoint": "cn-oss-****.aliyuncs.com"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidStartTime.Mismatch	Specified StartTime does not math the current time.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.