tencent cloud

APIs

ListVLPlans

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-26 11:47:41

1. API Description

Domain name for API request: iss.intl.tencentcloudapi.com.

Get the visual understanding plan list.

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: ListVLPlans.
Version Yes String Common Params. The value used for this API: 2023-05-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Name No String

Plan name, exact match

PageNumber No Integer

Page number. Default value: 1.

PageSize No Integer

Number of items per page. Default: 20. Maximum: 200.

3. Output Parameters

Parameter Name Type Description
Data Array of VLPlanInfo

Plan list

TotalCount Integer

Total quantity.

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 Successful Example

Input Example

POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListVLPlans
<Common request parameters>

{
"Name": "Mingchu Liangzao Recognition Plan"
    "PageNumber": 1,
    "PageSize": 20
}

Output Example

{
    "Response": {
        "Data": [
            {
                "Callback": {
                    "Enable": true,
                    "Token": "************************************",
                    "Url": "http://************************"
                },
                "ChannelCount": 0,
                "CreatedAt": "2026-07-27 17:19:15",
"Describe": "Mingchu Liangzao Recognition",
                "FileExpires": 7,
"Name": "Mingchu Liangzao Recognition Plan"
                "UpdatedAt": "2026-07-27 17:19:15",
                "VLPlanId": "VP7219*************************6f1",
                "VLTemplateId": "VTa911*************************6c2"
            }
        ],
        "TotalCount": 1,
        "RequestId": "16b41217-9532-4fd8-86e7-b333cca1177b"
    }
}

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
InvalidParameterValue.InvalidPageNumber Invalid PageNumber
InvalidParameterValue.InvalidPageSize Invalid PageSize

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック