SubmitLiveSnapshotJob - Intelligent Media Services - Alibaba Cloud Documentation Center

Submits a live stream snapshot job. If the job is submitted during stream ingest, it automatically starts in asynchronous mode. Otherwise, it does not start.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:SubmitLiveSnapshotJob		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
JobName	string	Yes	The name of the job. It cannot exceed 128 characters in length.
StreamInput	object	Yes	The information about the input stream.
Url	string	Yes	The URL of the input stream. It cannot exceed 255 characters in length.	rtmp://www.aliyun.com/stream
Type	string	Yes	The type of the input stream. The value can only be rtmp.	rtmp
SnapshotOutput	object	Yes	The information about the output snapshot.
StorageType	string	Yes	The storage type of the snapshot. The value can only be oss.	oss
Endpoint	string	Yes	The output endpoint of the snapshot.	oss-cn-shanghai.aliyuncs.com
Bucket	string	Yes	The bucket of the snapshot output endpoint.	testbucket
TemplateId	string	Yes	The template ID.	**a046-263c-3560-978a-fb287782**
CallbackUrl	string	No	The snapshot callback URL. It cannot exceed 255 characters in length. Both HTTP and HTTPS URLs are supported.	http://www.aliyun.com/snapshot/callback

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	MissingParameter	%s
400	InvalidParameter	%s
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.
500	InternalError	The request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.