All Products
Search
Document Center

Intelligent Media Services:GetLiveSnapshotTemplate

Last Updated:Dec 16, 2024

Queries the information about a live stream snapshot template.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:GetLiveSnapshotTemplate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdstringYes

The template ID.

****a046-263c-3560-978a-fb287782****

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The request ID.

******11-DB8D-4A9A-875B-275798******
TemplateIdstring

The template ID.

****a046-263c-3560-978a-fb287782****
TemplateNamestring

The template name.

Typestring

The type of the template.

Valid values:

  • system
  • custom
custom
OverwriteFormatstring

The naming format of the snapshot captured in overwrite mode.

snapshot/{JobId}.jpg
SequenceFormatstring

The naming format of the snapshot captured in time series mode.

snapshot/{JobId}/{UnixTimestamp}.jpg
TimeIntervalinteger

The interval between two adjacent snapshots.

5
LastModifiedstring

The time when the template was created.

2022-02-02T22:22:22Z
CreateTimestring

The time when the configuration was modified.

2022-02-02T22:22:22Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "TemplateId": "****a046-263c-3560-978a-fb287782****",
  "TemplateName": "",
  "Type": "custom",
  "OverwriteFormat": "snapshot/{JobId}.jpg",
  "SequenceFormat": "snapshot/{JobId}/{UnixTimestamp}.jpg",
  "TimeInterval": 5,
  "LastModified": "2022-02-02T22:22:22Z",
  "CreateTime": "2022-02-02T22:22:22Z"
}

Error codes

HTTP status codeError codeError message
400MissingParameter%s
400InvalidParameter%s
403UserDisableUser is disable.
403ForbiddenUser not authorized to operate on the specified resource.
403OperationDeniedYour account has not enabled the ICE service.
404TemplateNotFoundNo such template.
500InternalErrorThe request processing has failed due to some unknown error.

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