ListCustomTemplates-阿里云帮助中心

Retrieves a list of user-defined Video on Demand (VOD) media processing 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:ListCustomTemplates

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Type	string	Yes	The type of the template. Valid values: 1: Transcoding Template 2: Screenshot Template 3: Animated GIF Template 4: Image Watermark Template 5: Text Watermark Template 6: Subtitle Template 7: AI Content Moderation 8: AI-powered Smart Cover 9: AI-powered Object Removal	1
Subtype	string	No	The subtype of the template. This parameter applies only when `Type` is set to 1, 2, 7, or 9. Transcoding Template subtypes: 1: Normal (`Normal`) 2: Audio-only (`AudioTranscode`) 3: Remuxing (`Remux`) 4: Narrowband HD 1.0 (`NarrowBandV1`) 5: Narrowband HD 2.0 (`NarrowBandV2`) Screenshot Template subtypes: 1: Normal (`Normal`) 2: Sprite Image (`Sprite`) 3: WebVTT (`WebVtt`) AI Content Moderation subtypes: 1: Video moderation (`Video`) 2: Audio moderation (`Audio`) 3: Image moderation (`Image`) AI-powered Object Removal subtypes: 1: Logo Removal (`VideoDelogo`) 2: Text Removal (`VideoDetext`)	2
Name	string	No	The name of the template.	test-template
TemplateId	string	No	The ID of the template.	**96e8864746a0b6f3**
PageNumber	integer	No	The page number of the results to return.	1
PageSize	integer	No	The number of entries per page.	20
OrderBy	string	No	The sort order of the results. Valid values: `CreationTime:Desc`: Sorts the results by Creation Time in descending order. `CreationTime:Asc`: Sorts the results by Creation Time in ascending order.	CreateTimeDesc

Response elements

Element	Type	Description	Example
	object	The root object of the response.
RequestId	string	The unique identifier for the request.	****11-DB8D-4A9A-875B-275798****
Total	integer	The total number of templates.	20
CustomTemplateList	array<object>	An array of custom template objects.
	array<object>	Details of a custom template.
TemplateId	string	The template ID.	**20b48fb04483915d4f2cd8ac**
TemplateName	string	The template name.	test-template
Type	integer	The template type ID.	1
TypeName	string	The template type name.	TranscodeTemplate
Subtype	integer	The template subtype ID.	2
SubtypeName	string	The template subtype name.	AudioTranscode
Status	string	The template status. Valid values: Normal : The template is in a normal state.	Normal
IsDefault	boolean	Whether the template is a default template. Valid values: true : The template is a default template. false : The template is not a default template.	true
TemplateConfig	string	The template configuration, as a JSON string.	{"Container":{"Format":"mp3"},"Audio":{"Codec":"mp3","Bitrate":"64","Samplerate":"22050","Channels":"2"}}
CreateTime	string	The time when the template was created, in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ.	2022-07-12T16:17:54Z
ModifiedTime	string	The time when the template was last modified, in UTC and formatted as YYYY-MM-DDTHH:mm:ssZ.	2022-07-12T16:17:54Z
FrontendHint	object
TranscodeTemplateHint	object
BitrateControlType	string

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Total": 20,
  "CustomTemplateList": [
    {
      "TemplateId": "****20b48fb04483915d4f2cd8ac****",
      "TemplateName": "test-template",
      "Type": 1,
      "TypeName": "TranscodeTemplate",
      "Subtype": 2,
      "SubtypeName": "AudioTranscode",
      "Status": "Normal",
      "IsDefault": true,
      "TemplateConfig": "{\"Container\":{\"Format\":\"mp3\"},\"Audio\":{\"Codec\":\"mp3\",\"Bitrate\":\"64\",\"Samplerate\":\"22050\",\"Channels\":\"2\"}}",
      "CreateTime": "2022-07-12T16:17:54Z",
      "ModifiedTime": "2022-07-12T16:17:54Z",
      "FrontendHint": {
        "TranscodeTemplateHint": {
          "BitrateControlType": ""
        }
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.