获取雪碧图模板列表

最近更新时间:2024-09-13 01:54:58

我的收藏

1. 接口描述

接口请求域名: mps.tencentcloudapi.com 。

查询雪碧图模板,支持根据条件,分页查询。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeImageSpriteTemplates。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
Definitions.N Array of Integer 雪碧图模板唯一标识过滤条件,数组长度限制:100。
示例值:["10001\r\n"]
Offset Integer 分页偏移量,默认值:0。
示例值:0
Limit Integer 返回记录条数,默认值:10,最大值:100。
示例值:0
Type String 模板类型过滤条件,可选值:
  • Preset:系统预置模板;
  • Custom:用户自定义模板。

  • 示例值:“”
    Name String 雪碧图模板标识过滤条件,长度限制:64 个字符。
    示例值:“”

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的记录总数。
    示例值:1
    ImageSpriteTemplateSet Array of ImageSpriteTemplate 雪碧图模板详情列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取雪碧图模板列表

    输入示例

    https://mps.tencentcloudapi.com/?Action=DescribeImageSpriteTemplates
    &Definitions.0=10001
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "ImageSpriteTemplateSet": [
                {
                    "Definition": 1,
                    "Type": "abc",
                    "Name": "abc",
                    "Width": 1,
                    "Height": 1,
                    "ResolutionAdaptive": "abc",
                    "SampleType": "abc",
                    "SampleInterval": 1,
                    "RowCount": 1,
                    "ColumnCount": 1,
                    "CreateTime": "abc",
                    "UpdateTime": "abc",
                    "FillType": "abc",
                    "Comment": "abc",
                    "Format": "abc"
                }
            ],
            "RequestId": "abc"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.InvalidMpsUser 操作失败:非法 mps 用户。
    InternalError 内部错误。
    InvalidParameterValue.Limit 参数错误:Limit。
    InvalidParameterValue.Type 参数错误:Type 参数值错误。