ListCustomTemplates-Intelligent Media Services(IMS)-阿里云帮助中心

Queries custom 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 templatetype. Valid values: 1: transcode template 2: snapshot template 3: animated image template 4: image watermark template 5: text watermark template 6: subtitle template 7: AI content moderation 8: AI smart cover 9: AI smart erasure	1
Subtype	string	No	The template subtype ID. Valid values: Transcode template subtypes: 1: normal transcode template (Normal) 2: audio transcode template (AudioTranscode) 3: remux (Remux) 4: Narrowband HD 1.0 (NarrowBandV1) 5: Narrowband HD 2.0 (NarrowBandV2) Snapshot template subtypes: 1: normal snapshot or static snapshot (Normal) 2: sprite snapshot (Sprite) 3: WebVTT snapshot (WebVtt) AI content moderation template subtypes: 1: video moderation (Video) 2: audio moderation (Audio) 3: image moderation (Image) AI smart erasure template subtypes: 1: icon erasure (VideoDelogo) 2: subtitle erasure (VideoDetext)	2
Name	string	No	The template name.	test-template
TemplateId	string	No	The template ID.	**96e8864746a0b6f3**
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The page size.	20
OrderBy	string	No	The sort order. Valid values: CreateTimeDesc: descending order by creation time CreateTimeAsc: ascending order by creation time	CreateTimeDesc

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Total	integer	The total number of templates.	20
CustomTemplateList	array<object>	The list of templates.
	array<object>	The custom template information.
TemplateId	string	The template ID.	**20b48fb04483915d4f2cd8ac**
TemplateName	string	The template name.	test-template
Type	integer	The templatetype ID.	1
TypeName	string	The templatetype name.	TranscodeTemplate
Subtype	integer	The template subtype ID.	2
SubtypeName	string	The template subtype name.	AudioTranscode
Status	string	The template status. Valid values: Normal : Normal	Normal
IsDefault	boolean	Specifies whether the template is the default template. Valid values: false : false true : true	true
TemplateConfig	string	The template parameters.	{"Container":{"Format":"mp3"},"Audio":{"Codec":"mp3","Bitrate":"64","Samplerate":"22050","Channels":"2"}}
CreateTime	string	The time when the template was created. The time is in ISO 8601 format and uses UTC (ending with Z).	2022-07-12T16:17:54Z
ModifiedTime	string	The time when the template was modified. The time is in ISO 8601 format and uses UTC (ending with Z).	2022-07-12T16:17:54Z
FrontendHint	object	The reserved information for frontend display.
TranscodeTemplateHint	object	The hint information for the transcode template.
BitrateControlType	string	The bitrate control type.

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.