Domain name for API request: vod.tencentcloudapi.com.
This API is used to query the list of time point screencapturing templates and supports paged queries by filters.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeSnapshotByTimeOffsetTemplates. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-17. |
| Region | No | String | Common parameter. This parameter is not required for this API. |
| Definitions.N | No | Array of Integer | Unique ID filter of time point screencapturing templates. Array length limit: 100. |
| Offset | No | Integer | Paged offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
| Type | No | String | Template type filter. Valid values: |
| SubAppId | No | Integer | ID of a subapplication in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible entries. |
| SnapshotByTimeOffsetTemplateSet | Array of SnapshotByTimeOffsetTemplate | List of time point screencapturing template details. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://vod.tencentcloudapi.com/?Action=DescribeSnapshotByTimeOffsetTemplates
&Definitions.0=10001
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"SnapshotByTimeOffsetTemplateSet": [
{
"Definition": 10001,
"Type": "Custom",
"Name": "Point-in-time screenshot template 1",
"Comment": "",
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z",
"Format": "jpg",
"Height": 540,
"Width": 960
}
],
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameterValue.Definitions | Invalid parameter: Definitions. |
| InvalidParameterValue.Limit | Invalid parameter: Limit. |
| InvalidParameterValue.Type | Incorrect Type parameter value. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?