Last updated: 2020-09-17 18:02:25

1. API Description

Domain name for API request:

This API is used to create a custom sampled screencapturing template. Up to 16 templates can be created.

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: CreateSampleSnapshotTemplate.
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.
SampleType Yes String Sampled screencapturing type. Valid values:
  • Percent: By percent.
  • Time: By time interval.
  • SampleInterval Yes Integer Sampling interval.
  • If SampleType is Percent, sampling will be performed at an interval of the specified percentage.
  • If SampleType is Time, sampling will be performed at the specified time interval in seconds.
  • Name No String Name of a sampled screencapturing template. Length limit: 64 characters.
    Width No Integer Image width in px. Value range: [128, 4,096].
    Height No Integer Image height in px. Value range: [128, 4,096].
    ResolutionAdaptive No String
    Format No String Image format. Valid values: jpg; png. Default value: jpg.
    Comment No String Template description. Length limit: 256 characters.
    FillType No String

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Unique ID of a sampled screencapturing template.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a sampled screencapturing template

    Input Example
    &Name=Sampled screencapturing template 1
    &<Common request parameter>

    Output Example

      "Response": {
        "Definition": 1008,
        "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.


    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.
    InvalidParameterValue.Comment Parameter error: template description.
    InvalidParameterValue.Format Incorrect parameter value: Format.
    InvalidParameterValue.Height Parameter error: height.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.Resolution Parameter error: Incorrect resolution.
    InvalidParameterValue.SampleInterval Incorrect parameter value: SampleInterval.
    InvalidParameterValue.SampleType Incorrect parameter value: SampleType.
    InvalidParameterValue.Width Parameter error: Wwdth.
    LimitExceeded.TooMuchTemplate Limit reached: the number of templates exceeds the limit.

    Was this page helpful?

    Was this page helpful?

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