Queries a list of live stream recording jobs by page.
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 Resourcesis 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:ListLiveRecordJobs | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Keyword | string | No | The search keyword. You can use the job ID or name as the keyword to search for jobs. | ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66 |
| 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. | 2022-07-15T08:00:00Z |
| EndTime | string | No | The end of the time range to query. The maximum time range between EndTime and StartTime cannot exceed 30 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2022-07-11T08:00:00Z |
| Status | string | No | The state of the job. By default, the state is not filtered. Valid values:
| started |
| PageNo | long | No | The page number. Default value: 1. | 1 |
| PageSize | long | No | The number of entries per page. Default value: 10. | 20 |
| SortBy | string | No | The sorting order. By default, the query results are sorted by creation time in descending order. Valid values:
| desc |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "A27DFFA4-F272-5563-8363-CB0BC42740BA",
"LiveRecordJobs": [
{
"RecordOutput": {
"Type": "oss",
"Bucket": "imsbucket1",
"Endpoint": "oss-cn-hangzhou.aliyuncs.com"
},
"Name": "",
"NotifyUrl": "https://example.com/imsnotify",
"TemplateId": "69e1f9fe-1e97-11ed-ba64-0c42a1b73d66",
"CreateTime": "2022-07-20T03:26:36Z",
"StreamInput": {
"Type": "rtmp",
"Url": "rtmp://example-live.com/live/stream1"
},
"JobId": "ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66",
"Status": "paused",
"TemplateName": "test template"
}
],
"TotalCount": 180,
"PageNo": 1,
"PageSize": 20,
"SortBy": "desc"
}Error codes
For a list of error codes, visit the Service error codes.