DescribeSnapshotByTimeOffsetTemplates

Last updated: 2020-11-24 18:53:52

1. API Description

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.

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 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:
  • Preset: preset template;
  • Custom: custom template.
  • 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.

    3. Output Parameters

    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.

    4. Example

    Example1 Getting the list of Time-in-point screenshot templates

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeSnapshotByTimeOffsetTemplates
    &Definitions.0=10001
    &<Public request parameters>

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "SnapshotByTimeOffsetTemplateSet": [
          {
            "Definition": 10001,
            "Type": "Custom",
            "Name": "Time-in-point 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"
      }
    }

    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.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?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help