All Products
Search
Document Center

ApsaraVideo VOD:ListVodTemplate

Last Updated:Jul 19, 2024

Queries snapshot templates.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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

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

Examples

Sample success responses

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 Service error codes.