Last updated: 2021-10-27 16:01:45

1. API Description

Domain name for API request:

This API is used to query the information of custom background or watermark images during On-Cloud MixTranscoding. If you do not need to query such information frequently, we recommend you query it in the console via Application Management > Material Management.

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 parameter. The value used for this API: DescribePicture.
Version Yes String Common parameter. The value used for this API: 2019-07-22.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou
SdkAppId Yes Integer Application ID
PictureId No Integer Image ID. If it is left empty, the IDs of all images under the application are returned.
PageSize No Integer Number of records per page. 10 is used if it is left empty.
PageNo No Integer Page number. 1 is used if it is left empty.

3. Output Parameters

Parameter Name Type Description
Total Integer Number of records returned
PictureInfo Array of PictureInfo Image information list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying image parameters

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "Total": 2,
    "PictureInfo": [
        "PictureId": 1,
        "Height": 12,
        "Width": 13,
        "XPosition": 14,
        "YPosition": 15,
        "SdkAppId": 123456
        "PictureId": 2,
        "Height": 22,
        "Width": 23,
        "XPosition": 24,
        "YPosition": 25,
        "SdkAppId": 123456
    "RequestId": "83ca6fdd-cf4c-46a9-a577-74c3497ad3fa"

5. Developer Resources


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
AuthFailure.UnRealNameAuthenticated Identity verification has not been completed, so this operation is not allowed.
InternalError Internal error.
InternalError.DBError An error occurred while querying the database.
InvalidParameter.SdkAppId SdkAppId is incorrect.
MissingParameter Missing parameter.
UnknownParameter Unknown parameter error.