CreateImageSpriteTemplate

Last updated: 2020-01-13 11:52:11

    1. API Description

    Domain name for API request: mps.tencentcloudapi.com.

    This API is used to create a custom image sprite generating template. Up to 16 templates can be created.

    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: CreateImageSpriteTemplate
    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.
    Width Yes Integer Subimage width of an image sprite in px. Value range: [128, 4,096].
    Height Yes Integer Subimage height of an image sprite in px. Value range: [128, 4,096].
    SampleType Yes String Sampling 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.
  • RowCount Yes Integer Subimage row count of an image sprite.
    ColumnCount Yes Integer Subimage column count of an image sprite.
    Name No String Name of an image sprite generating template. Length limit: 64 characters.

    3. Output Parameters

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

    4. Example

    Example1 Creating an image sprite generating template

    Input Example

    https://mps.tencentcloudapi.com/?Action=CreateImageSpriteTemplate
    &Name=Image sprite generating template 1
    &Width=54
    &Height=96
    &SampleType=Percent
    &SampleInterval=10
    &RowCount=5
    &ColumnCount=10
    &<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.

    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.
    InvalidParameterValue.ColumnCount Incorrect parameter value: ColumnCount.
    InvalidParameterValue.Height Parameter error: height.
    InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
    InvalidParameterValue.RowCount Incorrect parameter value: RowCount.
    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
    Help