Call GetTemplateParams to query parameters for replaceable materials - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Obtain the replaceable material parameter information of a template, including the parameter name, default material value, and material thumbnail. Currently, only advanced templates are supported.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	No	The template ID.	**20b48fb04483915d4f2cd8ac**

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	**2876-6263-4B75-8F2C-CD0F7FCF**
TemplateId	string	The template ID.	****419c8741c1b4325f035b****
ParamList	array<object>	The queried parameters.
	object	The template parameters.
Key	string	The parameter name.	video1
Type	string	The material type. Valid values: Video Text Image Valid values: Video : Text : Image :	Image
CoverUrl	string	The thumbnail URL of the original material.	https://ice-materials-*.alicdn.com//*****20221**.jpg
MediaUrl	string	The URL of the original material.	https://ice-materials-*.alicdn.com//*****2022111618012453120c2a81*****.mp4
Content	string	The original subtitle content.	Subtitle Test
X	integer	The horizontal distance of the original material relative to the top-left corner of the video, in absolute pixel values. This value is returned only for standard templates created in the console.	100
Y	integer	The vertical distance of the original material relative to the top-left corner of the video, in absolute pixel values. This value is returned only for standard templates created in the console.	100
Width	integer	The width of the original material in the output video, in absolute pixel values. This value is returned only for standard templates created in the console.	300
Height	integer	The height of the original material in the output video, in absolute pixel values. This value is returned only for standard templates created in the console.	300
TimelineIn	number	In-point of the original material segment relative to the timeline, in seconds. This value is returned only for standard templates created in the console.	5.5
TimelineOut	number	Out-point of the original material segment relative to the timeline, in seconds. This value is returned only for standard templates created in the console.	8.5

Examples

Success response

JSON format

{
  "RequestId": "****2876-6263-4B75-8F2C-CD0F7FCF****",
  "TemplateId": "******419c8741c1b4325f035b******",
  "ParamList": [
    {
      "Key": "video1",
      "Type": "Image",
      "CoverUrl": "https://ice-materials-***.alicdn.com/***/********20221****.jpg",
      "MediaUrl": "https://ice-materials-***.alicdn.com/***/********2022111618012453120c2a81*******.mp4",
      "Content": "字幕Test ",
      "X": 100,
      "Y": 100,
      "Width": 300,
      "Height": 300,
      "TimelineIn": 5.5,
      "TimelineOut": 8.5
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.