ListVodTemplate - ApsaraVideo VOD - Alibaba Cloud Documentation Center

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 support 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

vod:ListVodTemplate

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateType	string	Yes	The type of the template. Set the value to Snapshot.	Snapshot
AppId	string	No	The ID of the application. Set the value to app-1000000. For more information, see Multi-application.	app-****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	2A56B75B-B7E6-48*****27-A9BEAA3E50A8
VodTemplateInfoList	array<object>	The list of snapshot template data.
	object
CreationTime	string	The time when the template was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-11-30T08:05:59:57Z
IsDefault	string	Indicates whether the template is the default one. Valid values: Default: The template is the default one. NotDefault: The template is not the default one.	NotDefault
AppId	string	The ID of the application.	app-****
TemplateType	string	The type of the template. Valid values: Snapshot: snapshot. DynamicImage: animated image.	Snapshot
VodTemplateId	string	The ID of the template.	7c49f2f42b1c*****0969fcd446690
TemplateConfig	string	The detailed configurations of the template in a JSON string. For more information about the data structure, see SnapshotTemplateConfig.	{\"SnapshotConfig\":{\"Count\":10,\"SpecifiedOffsetTime\":0,\"Interval\":1},\"SnapshotType\":\"NormalSnapshot\"}
Name	string	The name of the template.	test
ModifyTime	string	The time when the template was last modified. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-11-30T09:05:59:97Z

Examples

Success response

JSON format

{
  "RequestId": "2A56B75B-B7E6-48*****27-A9BEAA3E50A8",
  "VodTemplateInfoList": [
    {
      "CreationTime": "2018-11-30T08:05:59:57Z",
      "IsDefault": "NotDefault",
      "AppId": "app-****",
      "TemplateType": "Snapshot",
      "VodTemplateId": "7c49f2f42b1c*****0969fcd446690",
      "TemplateConfig": "{\\\"SnapshotConfig\\\":{\\\"Count\\\":10,\\\"SpecifiedOffsetTime\\\":0,\\\"Interval\\\":1},\\\"SnapshotType\\\":\\\"NormalSnapshot\\\"}",
      "Name": "test",
      "ModifyTime": "2018-11-30T09:05:59:97Z"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.