ListLiveRecordJobs-Intelligent Media Services(IMS)-阿里云帮助中心

Queries a paginated list of real-time recording jobs.

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

ice:ListLiveRecordJobs

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The search keyword. You can search by job ID or job name.	ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66
StartTime	string	No	The start time of the query. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2022-07-15T08:00:00Z
EndTime	string	No	The end time of the query. The interval between the end time and the start time cannot exceed 30 days. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2022-07-11T08:00:00Z
Status	string	No	The status of the job. By default, no status filter is applied. Valid values: paused : Paused. initial : Initial. started : Running.	started
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	20
SortBy	string	No	The sorting parameter. By default, jobs are sorted in descending order of creation time. Valid values: asc : Ascending order. desc : Descending order.	desc

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	A27DFFA4-F272-5563-8363-CB0BC42740BA
LiveRecordJobs	array<object>	The list of real-time recording jobs.
	array<object>	LiveRecordJobItemType
RecordOutput	object	The storage address for the recording.
Type	string	The type of the storage address. Valid values: vod : vod oss : oss	oss
Bucket	string	The name of the bucket.	imsbucket1
Endpoint	string	The endpoint of the storage service.	oss-cn-hangzhou.aliyuncs.com
Name	string	The name of the recording job.	Live event recording job 1
NotifyUrl	string	The callback URL.	https://example.com/imsnotify
TemplateId	string	The ID of the recording template.	69e1f9fe-1e97-11ed-ba64-0c42a1b73d66
CreateTime	string	The creation time. The time follows the ISO 8601 standard and is in UTC (ending with Z).	2022-07-20T03:26:36Z
StreamInput	object	The URL of the live stream.
Type	string	The type of the live stream URL.	rtmp
Url	string	The URL of the live stream.	rtmp://example-live.com/live/stream1
JobId	string	The ID of the recording job.	ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66
Status	string	The status of the recording job.	paused
TemplateName	string	The name of the recording template.	test template
TotalCount	integer	The total number of records.	180
PageNo	integer	The page number. Default value: 1.	1
PageSize	integer	The number of entries per page. Default value: 10.	20
SortBy	string	The sorting parameter. By default, jobs are sorted in descending order of creation time.	desc

Examples

Success response

JSON format

{
  "RequestId": "A27DFFA4-F272-5563-8363-CB0BC42740BA",
  "LiveRecordJobs": [
    {
      "RecordOutput": {
        "Type": "oss",
        "Bucket": "imsbucket1",
        "Endpoint": "oss-cn-hangzhou.aliyuncs.com"
      },
      "Name": "Live event recording job 1",
      "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.