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

Submits a real-time snapshot task. If the task is submitted during an active stream, it is automatically started asynchronously. Otherwise, the task remains in an unstarted state.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobName	string	Yes	The task name. Maximum length: 128.	Screenshot task1
StreamInput	object	Yes	The stream input information.
Type	string	Yes	The stream input type. Currently, only rtmp is supported. Valid values: rtmp : rtmp	rtmp
Url	string	Yes	The stream input URL. Maximum length: 255.	rtmp://www.aliyun.com/stream
SnapshotOutput	object	Yes	The snapshot output information.
Bucket	string	Yes	The bucket of the snapshot output endpoint.	testbucket
Endpoint	string	Yes	The snapshot output endpoint.	oss-cn-shanghai.aliyuncs.com
StorageType	string	Yes	The snapshot storage type. Currently, only oss is supported. Valid values: oss : oss	oss
TemplateId	string	Yes	The template ID.	**a046-263c-3560-978a-fb287782**
CallbackUrl	string	No	The snapshot callback URL. Maximum length: 255. HTTP and HTTPS are supported.	http://www.aliyun.com/snapshot/callback

Response elements

Element	Type	Description	Example
	object	The response data.
JobId	string	The task ID.	**a046-263c-3560-978a-fb287666**
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****

Examples

Success response

JSON format

{
  "JobId": "****a046-263c-3560-978a-fb287666****",
  "RequestId": "******11-DB8D-4A9A-875B-275798******"
}

Error codes

HTTP status code	Error code	Error message
400	MissingParameter	%s
400	InvalidParameter	%s
500	InternalError	The request processing has failed due to some unknown error.
403	UserDisable	User is disable.
403	Forbidden	User not authorized to operate on the specified resource.
403	OperationDenied	Your account has not enabled the ICE service.
404	TemplateNotFound	No such template.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.