Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query the list of sampled 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 Params. The value used for this API: DescribeSampleSnapshotTemplates. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
| Definitions.N | No | Array of Integer | Unique ID filter of sampled 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: |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible entries. |
| SampleSnapshotTemplateSet | Array of SampleSnapshotTemplate | List of sampled screencapturing template details. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://vod.intl.tencentcloudapi.com/?Action=DescribeSampleSnapshotTemplates
&Definitions.0=10001
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"SampleSnapshotTemplateSet": [
{
"Definition": 10001,
"Type": "Custom",
"Name": "Sampled screenshot template 1",
"Comment": "",
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z",
"Format": "jpg",
"Height": 540,
"SampleType": "Percent",
"ResolutionAdaptive": "open",
"FillType": "black",
"SampleInterval": 10,
"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. |
文档反馈