GetLiveRecordJob - - Alibaba Cloud Documentation Center

Queries the information about a live stream recording job.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The ID of the recording job.	ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66

Response elements

Element	Type	Description	Example
	object	The response parameters.
RecordJob	object	The details of the recording job.
NotifyUrl	string	The callback URL.	https://example.com/imsnotify
CreateTime	string	The time when the job was created.	2022-07-20T02:48:58Z
StreamInput	object	The URL of the live stream.
Type	string	The type of the live stream. The value can only be rtmp. Valid values: rtmp : rtmp	rtmp
Url	string	The URL of the live stream.	rtmp://example.com/app/stream
RecordOutput	object	The storage address of the recording.
Type	string	The type of the storage address. Valid values: vod oss Valid values: vod : vod oss : oss	oss
Bucket	string	The bucket name.	imsbucket1
Endpoint	string	The endpoint of the storage service.	oss-cn-shanghai.aliyuncs.com
TemplateId	string	The ID of the recording template.	69e1f9fe-1e97-11ed-ba64-0c42a1b73d66
TemplateName	string	The name of the recording template.	test template
Name	string	The name of the recording job.	Live Event Recording Task 1
JobId	string	The ID of the recording job.	ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66
Status	string	The state of the recording job. Valid values: paused: The job is paused. initial: The job is not started. started: The job is in progress. Valid values: paused : paused initial : initial started : started	paused
RequestId	string	The request ID.	B57A046C-CE33-5FBB-B57A-D2B89ACF6907

Examples

Success response

JSON format

{
  "RecordJob": {
    "NotifyUrl": "https://example.com/imsnotify",
    "CreateTime": "2022-07-20T02:48:58Z",
    "StreamInput": {
      "Type": "rtmp",
      "Url": "rtmp://example.com/app/stream"
    },
    "RecordOutput": {
      "Type": "oss",
      "Bucket": "imsbucket1",
      "Endpoint": "oss-cn-shanghai.aliyuncs.com"
    },
    "TemplateId": "69e1f9fe-1e97-11ed-ba64-0c42a1b73d66",
    "TemplateName": "test template",
    "Name": "Live event recording task 1",
    "JobId": "ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66",
    "Status": "paused"
  },
  "RequestId": "B57A046C-CE33-5FBB-B57A-D2B89ACF6907"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.