Last updated: 2020-12-24 11:19:16

1. API Description

Domain name for API request:

This API is used to query the list of image sprite generating 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: DescribeImageSpriteTemplates.
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 image sprite generating 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.
    ImageSpriteTemplateSet Array of ImageSpriteTemplate List of image sprite generating 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 image sprite generating templates

    Input Example
    &<Public request parameter>

    Output Example

      "Response": {
        "TotalCount": 1,
        "ImageSpriteTemplateSet": [
            "Definition": 10001,
            "Name": "Image sprite generating template 1",
            "CreateTime": "2018-10-01T10:00:00Z",
            "UpdateTime": "2018-10-01T10:00:00Z",
            "Height": 540,
            "SampleType": "Percent",
            "SampleInterval": 10,
            "RowCount": 10,
            "ColumnCount": 5,
            "Width": 960
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"

    5. Developer Resources


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