All Products
Search
Document Center

ApsaraVideo VOD:ListVodTemplate

Last Updated:Nov 09, 2022

Queries snapshot templates.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:ListVodTemplateList
  • VOD
    acs:vod:*:{#accountId}:*/*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateTypestringYes

The type of the template. Set the value to Snapshot.

Snapshot
AppIdstringNo

The ID of the application. Set the value to app-1000000. For more information, see Overview.

app-****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

2A56B75B-B7E6-48*****27-A9BEAA3E50A8
VodTemplateInfoListarray

The snapshot templates.

object
CreationTimestring

The time when the template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2018-11-30T08:05:59:57Z
IsDefaultstring

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
AppIdstring

The ID of the application.

app-****
TemplateTypestring

The type of the template. Valid values:

  • Snapshot
  • DynamicImage
Snapshot
VodTemplateIdstring

The ID of the template.

7c49f2f42b1c*****0969fcd446690
TemplateConfigstring

The detailed configurations of the template. The value is a JSON-formatted string. For more information about the data structure, see the "SnapshotTemplateConfig" section of the Media processing parameters topic.

{\"SnapshotConfig\":{\"Count\":10,\"SpecifiedOffsetTime\":0,\"Interval\":1},\"SnapshotType\":\"NormalSnapshot\"}
Namestring

The name of the template.

test
ModifyTimestring

The time when the template was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2018-11-30T09:05:59:97Z

Example

Normal return example

JSONFormat

{
  "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

For a list of error codes, visit the API error center.