GetLiveSnapshotJob - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries the information a live stream snapshot job.

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

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
JobId	string	The job ID.	**a046-263c-3560-978a-fb287782**
JobName	string	The name of the job.
TemplateId	string	The template ID.	**a046-263c-3560-978a-fb287666**
TemplateName	string	The name of the template.
Status	string	The state of the job. Valid values: init: The job is not started. paused: The job is paused. started: The job is in progress.	started
StreamInput	object	The input information.
Url	string	The URL of the input stream.	rtmp://www.aliyun.com/stream
Type	string	The type of the input stream. The value can only be rtmp.	rtmp
SnapshotOutput	object	The output information.
StorageType	string	The storage type. The value can only be oss.	oss
Endpoint	string	The output endpoint. If the storage type is set to oss, the Object Storage Service (OSS) domain name is returned.	oss-cn-shanghai.aliyuncs.com
Bucket	string	The bucket of the output endpoint. If the storage type is set to oss, the OSS bucket is returned.	testbucket
OverwriteFormat	string	The naming format of the snapshot captured in overwrite mode.	snapshot/{JobId}.jpg
SequenceFormat	string	The naming format of the snapshot captured in time series mode.	snapshot/{JobId}/{UnixTimestamp}.jpg
TimeInterval	integer	The interval between two adjacent snapshots.	5
CallbackUrl	string	The snapshot callback URL.	http://www.aliyun.com/snapshot/callback
LastModified	string	The time when the file was last modified.	2022-02-02T22:22:22Z
CreateTime	string	The time when the file was created.	2022-02-02T22:22:22Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****a046-263c-3560-978a-fb287782****",
  "JobName": "",
  "TemplateId": "****a046-263c-3560-978a-fb287666****",
  "TemplateName": "",
  "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
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.
500	InternalError	The request processing has failed due to some unknown error.

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