Queries all recording index files in the specified period of time.
Debugging
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 |
---|---|---|---|---|
ice:ListLiveRecordFiles | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
EndTime | string | No | The end of the time range to query. The maximum time range to query is four days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2017-12-22T08:00:00Z |
StartTime | string | No | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2017-12-21T08:00:01Z |
JobIds | array | No | The list of job IDs. | |
string | No | The ID of the recording job. | 9E83D5D0-8D72-5E7D-B61A-**** | |
PageNo | integer | No | The page number of the page to return. Default value: 1. | 1 |
PageSize | integer | No | The number of entries per page. Valid values: 5 to 30. Default value: 10. | 10 |
SortBy | string | No | The sorting order of the index files by creation time. Valid values: asc: The query results are displayed in ascending order. This is the default value. desc: The query results are displayed in descending order. | asc |
RecordFormat | string | No | The format of the recording file. Valid values: M3U8, FLV, and MP4 | m3u8 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "DE24625C-7C0F-4020-8448-****",
"PageNo": 1,
"SortBy": "asc",
"PageSize": "10",
"TotalCount": "100",
"Files": [
{
"RecordUrl": "http://****/atestObject****.m3u8",
"StartTime": "2015-12-01T07:36:00Z",
"EndTime": "2015-12-01T07:36:10Z",
"Duration": 100,
"Width": 480,
"Height": 640,
"CreateTime": "2016-05-27T09:40:56Z",
"RecordOutput": "{ \"Type\": \"oss\", \"Endpoint\":\"oss-cn-shanghai.aliyuncs.com\", \"Bucket\": \"test-bucket\" }",
"RecordId": "c4d7f0a4-b506-43f9-8de3-07732c3f****",
"StreamUrl": "LiveStream***",
"JobName": "LiveRecordJob***",
"Format": "m3u8",
"JobId": "c4d7f0a4-b506-43f9-8de3-07732c3f****"
}
]
}
Error codes
For a list of error codes, visit the Service error codes.