All Products
Search
Document Center

ApsaraVideo VOD:GetVodTemplate

Last Updated:May 22, 2024

Queries a single snapshot template.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:GetVodTemplateRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VodTemplateIdstringYes

The ID of the snapshot template.

7c49f2f4c0969*****fcd446690

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

DE7A1F49-41C1-47*****DF-4CD0C02087DB
VodTemplateInfoobject

The information about the snapshot template.

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
TemplateTypestring

The type of the template. Valid values:

  • Snapshot
  • DynamicImage
Snapshot
VodTemplateIdstring

The ID of the template.

7c49f2f4c09*****69fcd446690
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:57Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "DE7A1F49-41C1-47*****DF-4CD0C02087DB",
  "VodTemplateInfo": {
    "CreationTime": "2018-11-30T08:05:59:57Z",
    "IsDefault": "NotDefault",
    "TemplateType": "Snapshot",
    "VodTemplateId": "7c49f2f4c09*****69fcd446690",
    "TemplateConfig": "{\\\"SnapshotConfig\\\":{\\\"Count\\\":10,\\\"SpecifiedOffsetTime\\\":0,\\\"Interval\\\":1},\\\"SnapshotType\\\":\\\"NormalSnapshot\\\"}",
    "Name": "test",
    "ModifyTime": "2018-11-30T09:05:59:57Z"
  }
}

Error codes

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