ListLiveSnapshotTemplates-阿里云帮助中心

Returns a paginated list of Live Snapshot templates.

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:ListLiveSnapshotTemplates

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SearchKeyWord	string	No	The search keyword. You can perform a fuzzy search by template ID or template name. Maximum length: 128 characters.	**a046-263c-3560-978a-fb287782**
TemplateIds	array	No	The template IDs. This parameter does not take effect if `SearchKeyWord` is specified. You can specify a maximum of 200 template IDs.
	string	No		**a046-263c-3560-978a-fb287782**
Type	string	No	The type of the template. By default, templates of all types are queried. Valid values: system : System template custom : Custom template	custom
PageNo	integer	No	The page number. The value must be greater than or equal to 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
SortBy	string	No	The sorting method. By default, results are sorted by creation time in descending order. Valid values: asc : Sorts results by creation time in ascending order. desc : Sorts results by creation time in descending order.	desc

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The ID of the request.	****11-DB8D-4A9A-875B-275798****
TemplateList	array<object>	The list of templates.
	object	A template object.
TemplateId	string	The ID of the template.	**a046-263c-3560-978a-fb287782**
TemplateName	string	The name of the template.	模板1
Type	string	The type of the template. Valid values: system : A system template. custom : A custom template.	custom
TimeInterval	integer	The snapshot interval in seconds.	10
CreateTime	string	The time when the template was created. The time format is UTC.	2022-07-20T02:48:58Z
PageNo	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
SortBy	string	The sort order.	desc
TotalCount	integer	The total number of entries.	100

Examples

Success response

JSON format

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

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	OperationDenied	Your account has not enabled the ICE service.
403	Forbidden	User not authorized to operate on the specified resource.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.