tencent cloud

APIs

ListVideoSnapshotTemplate

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-10-26 11:48:26

1. API Description

Domain name for API request: iss.intl.tencentcloudapi.com.

This API is used to search the screenshot template details list.

A maximum of 5 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: ListVideoSnapshotTemplate.
Version Yes String Common Params. The value used for this API: 2023-05-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Name No String

Template name

Type No Integer

Screenshot type

Enumeration values:

  • 1: Real-time frame capture
  • 2: Low frequency frame capture
Sort No String

Sorting parameter

Default value: update_time

Order No String

Sort order

Enumeration values:

  • desc: in descending order
  • asc: in ascending order

Default value: desc

PageNumber No Integer

Page number

Default value: 1

PageSize No Integer

Number of items per page

Default value: 20

3. Output Parameters

Parameter Name Type Description
Data ListVideoSnapshotTemplateData

Screenshot template result list

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.

4. Example

Example1 Success

Input Example

POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListVideoSnapshotTemplate
<Common request parameters>

{
    "Sort": "update_time",
    "Order": "desc",
    "PageNumber": 1,
    "PageSize": 20
}

Output Example

{
    "Response": {
        "Data": {
            "List": [
                {
                    "CreateTime": "2026-01-25 12:15:00",
                    "Interval": 3600,
                    "MultiMode": {
                        "Enable": true,
                        "Interval": 180,
                        "Total": 5
                    },
"Name": "Low frequency frame capture template"
                    "TemplateId": "035f4**************8*******c1ca5aa4a",
                    "Times": [
                        {
                            "BeginTime": "9:00:00",
                            "EndTime": "12:00:00",
                            "WeekDay": 2
                        }
                    ],
                    "Type": 2,
                    "UpdateTime": "2026-01-25 12:15:00"
                }
            ],
            "Order": "desc",
            "PageNumber": 1,
            "PageSize": 20,
            "Sort": "update_time",
            "TotalCount": 2
        },
        "RequestId": "af39813c-96eb-4c48-b07f-1b31cfe5a9d3"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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
InvalidParameterValue.PageSizeExceedLimit Page size exceeds the limit
InvalidParameterValue.UnsupportedSnapshotType Unsupported screenshot type
InvalidParameterValue.UnsupportedSortRule Unsupported sorting rule.
ResourceNotFound Resource does not exist.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan