GetCustomTemplate - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries the information about a custom template.

Operation description

You can call this operation to query the information about a template with the ID specified by the TemplateId parameter. You can also query the information about the default template. If TemplateId is specified, other parameters are ignored and the template whose ID is specified is queried. If TemplateId is not specified, the default template is queried based on other parameters. In this case, Type is required.

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:GetCustomTemplate	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	No	The template ID.	**96e8864746a0b6f3**
Type	integer	No	The ID of the template type that is used to query the default template. This parameter is required if TemplateId is not specified.	1
Subtype	integer	No	The template subtype.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
CustomTemplate	object	The template information.
TemplateId	string	The template ID.	**20b48fb04483915d4f2cd8ac**
TemplateName	string	The template name.
Type	integer	The type ID of the template.	2
TypeName	string	The type name of the template.	SnapshotTemplate
Subtype	integer	The subtype ID of the template.	1
SubtypeName	string	The subtype name of the template.	Normal
Status	string	The template state.	Normal
IsDefault	boolean	Indicates whether the template is the default template.	true
TemplateConfig	string	The template parameters.	{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}
CreateTime	string	The time when the template was created.	2022-01-01T10:00:00Z
ModifiedTime	string	The time when the template was last modified.	2022-01-01T11:00:00Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "CustomTemplate": {
    "TemplateId": "****20b48fb04483915d4f2cd8ac****",
    "TemplateName": "",
    "Type": 2,
    "TypeName": "SnapshotTemplate",
    "Subtype": 1,
    "SubtypeName": "Normal",
    "Status": "Normal",
    "IsDefault": true,
    "TemplateConfig": "{\"Type\":\"Normal\",\"FrameType\":\"normal\",\"Time\":0,\"Count\":10}",
    "CreateTime": "2022-01-01T10:00:00Z",
    "ModifiedTime": "2022-01-01T11:00:00Z\n",
    "FrontendHint": {
      "TranscodeTemplateHint": {
        "BitrateControlType": ""
      }
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-07-18	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2022-07-11	Add Operation	View Change Details