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

Retrieves a single live snapshot 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:GetLiveSnapshotJob

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
JobId	string	Yes	The job ID.	**a046-263c-3560-978a-fb287782**

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
JobId	string	The job ID.	**a046-263c-3560-978a-fb287782**
JobName	string	The job name.	Snapshot job 1
TemplateId	string	The template ID.	**a046-263c-3560-978a-fb287666**
TemplateName	string	The template name.	Template 1
Status	string	The job status. Valid values: init : Not started. paused : Stopped. started : Running.	started
StreamInput	object	The input information.
Url	string	The input URL.	rtmp://www.aliyun.com/stream
Type	string	The input type. Currently, only RTMP is supported. Valid values: rtmp : rtmp	rtmp
SnapshotOutput	object	The output information.
StorageType	string	The storage type. Currently, only OSS is supported. Valid values: oss : oss	oss
Endpoint	string	The output endpoint. The OSS domain name is returned when the type is oss.	oss-cn-shanghai.aliyuncs.com
Bucket	string	The bucket of the output endpoint. The OSS bucket is returned when the type is oss.	testbucket
OverwriteFormat	string	The overwrite snapshot format.	snapshot/{JobId}.jpg
SequenceFormat	string	The sequence snapshot format.	snapshot/{JobId}/{UnixTimestamp}.jpg
TimeInterval	integer	The snapshot interval. Unit: seconds.	5
CallbackUrl	string	The snapshot callback URL.	http://www.aliyun.com/snapshot/callback
LastModified	string	The last modified time.	2022-02-02T22:22:22Z
CreateTime	string	The creation time. The time is in ISO 8601 format and in UTC (ending with Z).	2022-02-02T22:22:22Z

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****a046-263c-3560-978a-fb287782****",
  "JobName": "Snapshot job 1",
  "TemplateId": "****a046-263c-3560-978a-fb287666****",
  "TemplateName": "Template 1",
  "Status": "started",
  "StreamInput": {
    "Url": "rtmp://www.aliyun.com/stream",
    "Type": "rtmp"
  },
  "SnapshotOutput": {
    "StorageType": "oss",
    "Endpoint": "oss-cn-shanghai.aliyuncs.com",
    "Bucket": "testbucket"
  },
  "OverwriteFormat": "snapshot/{JobId}.jpg",
  "SequenceFormat": "snapshot/{JobId}/{UnixTimestamp}.jpg",
  "TimeInterval": 5,
  "CallbackUrl": "http://www.aliyun.com/snapshot/callback",
  "LastModified": "2022-02-02T22:22:22Z",
  "CreateTime": "2022-02-02T22:22:22Z"
}

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	JobNotFound	No such job.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.