DescribeSampleSnapshotTemplates

Last updated: 2020-01-13 11:47:22

PDF

1. API Description

Domain name for API request: mps.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.

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: DescribeSampleSnapshotTemplates
Version Yes String Common parameter. The value used for this API: 2019-06-12
Region No String Common parameter. This parameter is not required for this API.
Definitions.N No Array of Integer Unique ID filter of sampled screencapturing templates. Array length limit: 100.
Offset No Integer Paging 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.
  • 3. Output Parameters

    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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of sampled screencapturing templates

    Input Example

    https://mps.tencentcloudapi.com/?Action=DescribeSampleSnapshotTemplates
    &Definitions.0=10001
    &<Common request parameter>

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "SampleSnapshotTemplateSet": [
          {
            "Definition": 10001,
            "Type": "Custom",
            "Name": "Sampled screencapturing template 1",
            "Comment": "",
            "CreateTime": "2018-10-01T10:00:00Z",
            "UpdateTime": "2018-10-01T10:00:00Z",
            "Format": "jpg",
            "Height": 540,
            "SampleType": "Percent",
            "SampleInterval": 10,
            "Width": 960
          }
        ],
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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.InvalidMpsUser Operation failed: unauthorized MPS user.
    InternalError Internal error.