All Products
Search
Document Center

Intelligent Media Services:ListLiveSnapshotTemplates

Last Updated:Dec 16, 2024

Queries a list of live stream snapshot templates by page.

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:ListLiveSnapshotTemplates
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SearchKeyWordstringNo

The search keyword. You can use the template ID or name as the keyword to search for templates. If you search for templates by name, fuzzy match is supported.

  • It cannot exceed 128 characters in length.
****a046-263c-3560-978a-fb287782****
TemplateIdsarrayNo

The template IDs.

  • If you specify the SearchKeyWord parameter, this condition does not take effect.
  • The maximum length of the array is 200.
stringNo
****a046-263c-3560-978a-fb287782****
TypestringNo

The type of the template. By default, all types are queried.

Valid values:

  • system
  • custom
custom
PageNointegerNo

The page number. Valid values: [1,n). Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 100. Default value: 10.

10
SortBystringNo

The sorting order. By default, the query results are sorted by creation time in descending order.

Valid values:

  • asc: sorts the query results by creation time in ascending order.
  • desc: sorts the query results by creation time in descending order.
desc

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The request ID.

******11-DB8D-4A9A-875B-275798******
TemplateListarray<object>

The list of the templates.

TemplateInfoobject
TemplateIdstring

The template ID.

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

The template name.

Typestring

The type of the template.

Valid values:

  • system
  • custom
custom
TimeIntervalinteger

The interval between two adjacent snapshots. Unit: seconds.

10
CreateTimestring

The time when the job was created.

2022-07-20T02:48:58Z
PageNointeger

The number of the returned page.

1
PageSizeinteger

The number of entries per page.

10
SortBystring

The sorting order of the results by creation time.

desc
TotalCountlong

The total number of entries returned.

100

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "TemplateList": [
    {
      "TemplateId": "****a046-263c-3560-978a-fb287782****",
      "TemplateName": "",
      "Type": "custom",
      "TimeInterval": 10,
      "CreateTime": "2022-07-20T02:48:58Z"
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "SortBy": "desc",
  "TotalCount": 100
}

Error codes

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

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