ListSystemTemplates-阿里云帮助中心

Queries a list of system templates.

Operation description

Template types:

1: transcoding template.
2: snapshot template.
3: animated image template.
4. image watermark template.
5: text watermark template.
6: subtitle template.
7: AI-assisted content moderation template.
8: AI-assisted intelligent thumbnail template.
9: AI-assisted intelligent erasure template.

Subtypes of transcoding templates:

1 (Normal): regular template.
2 (AudioTranscode): audio transcoding template.
3 (Remux): container format conversion template.
4 (NarrowBandV1): Narrowband HD 1.0 template.
5 (NarrowBandV2): Narrowband HD 2.0 template.

Subtypes of snapshot templates:

1 (Normal): regular template.
2 (Sprite): sprite template.
3 (WebVtt): WebVTT template.

Subtypes of AI-assisted content moderation templates:

1 (Video): video moderation template.
2 (Audio): audio moderation template.
3 (Image): image moderation template.

Subtypes of AI-assisted intelligent erasure templates:

1 (VideoDelogo): logo erasure template.
2 (VideoDetext): subtitle erasure template.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Type	string	Yes	The template type. Separate multiple types with commas (,).	1,2
Subtype	string	No	The subtype ID of the template.	1
Name	string	No	The template name.	SampleTemplate
TemplateId	string	No	The template ID.	**96e8864746a0b6f3**
Status	string	No	The template state. Valid values: Normal, Invisible, and All.	Normal
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 20 Valid values: 1 to 100.	20

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Total	integer	The total number of templates.	20
SystemTemplateList	array<object>	The queried templates.
	object	The information about the system template.
TemplateId	string	The template ID.	S00000001-000000
TemplateName	string	The template name.	FLV-COPY
Type	integer	The type ID of the template.	1
TypeName	string	The type name of the template.	TranscodeTemplate
Subtype	integer	The subtype ID of the template.	1
SubtypeName	string	The subtype name of the template.	Remux
Status	string	The template state.	Normal
TemplateConfig	string	The template parameters.	{"Container":{"Format":"flv"},"Video":{},"Audio":{}}

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Total": 20,
  "SystemTemplateList": [
    {
      "TemplateId": "S00000001-000000",
      "TemplateName": "FLV-COPY",
      "Type": 1,
      "TypeName": "TranscodeTemplate",
      "Subtype": 1,
      "SubtypeName": "Remux",
      "Status": "Normal",
      "TemplateConfig": "{\"Container\":{\"Format\":\"flv\"},\"Video\":{},\"Audio\":{}}"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.