tencent cloud

文档反馈

DescribeImageProcessingTemplates

最后更新时间:2024-03-27 16:09:17

    1. API Description

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

    This API is used to query image processing templates. You can specify the filters as well as the offset to start returning records from.

    A maximum of 20 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 Params. The value used for this API: DescribeImageProcessingTemplates.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Definitions.N No Array of Integer The IDs of the templates to query. Length limit: 100.
    Type No String The template type. Valid values:
  • Preset
  • Custom
  • Offset No Integer The offset. Default value: 0.
    Limit No Integer The number of records to return. Default value: 10. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The total number of records that meet the conditions.
    ImageProcessingTemplateSet Array of ImageProcessingTemplate The information of the queried image processing templates.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying image processing templates

    This example shows you how to query image processing templates.

    Input Example

    https://vod.tencentcloudapi.com/?Action=DescribeImageProcessingTemplates
    &Definitions.0=1008
    &Definitions.1=1009
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "TotalCount": 2,
            "ImageProcessingTemplateSet": [
                {
                    "Definition": 1008,
                    "Comment": "",
                    "Name": "",
                    "Type": "Custom",
                    "CreateTime": "2018-10-01T10:00:00Z",
                    "Operations": [
                        {
                            "Type": "CenterCut",
                            "CenterCut": {
                                "Type": "Circle",
                                "Radius": 30
                            }
                        },
                        {
                            "Type": "Scale",
                            "Scale": {
                                "Type": "ShortEdgeFirst",
                                "ShortEdge": 100
                            }
                        }
                    ]
                },
                {
                    "Definition": 1009,
                    "Comment": "",
                    "Name": "",
                    "Type": "Custom",
                    "CreateTime": "2018-10-01T10:00:00Z",
                    "Operations": [
                        {
                            "Type": "Scale",
                            "Scale": {
                                "Type": "WidthFirst",
                                "Width": 200
                            }
                        }
                    ]
                }
            ],
            "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
        }
    }
    

    5. Developer Resources

    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 Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue.Definitions Invalid parameter: Definitions.
    InvalidParameterValue.Limit Invalid parameter: Limit.
    ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
    UnauthorizedOperation Unauthorized operation.