帮你快速理解、总结文档立即下载

查询视觉理解模板详情

最近更新时间:2026-10-13 02:47:34
我的收藏

1. 接口描述

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

查询视觉理解模板详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeVLTemplate。
Version 是 String 公共参数,本接口取值:2023-05-17。
Region 否 String 公共参数,此参数为可选参数。
VLTemplateId 是 String

模板 ID


示例值:VT58c*04e3

3. 输出参数

参数名称 类型 描述
Data VLTemplateInfo

视觉理解模板信息

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功示例

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVLTemplate
<公共请求参数>

{
    "VLTemplateId": "VT58c*************************04e3"
}

输出示例

{
    "Response": {
        "Data": {
            "AIModel": "ivc-vl-1.0",
            "AnalysisMode": "image",
            "CreatedAt": "2026-08-17 17:23:42",
            "Describe": "",
            "ImageConfig": {
                "Interval": 10,
                "MultiMode": null,
                "Type": 1
            },
            "Name": "测试模板",
            "Prompt": "图片中有什么",
            "Times": [
                {
                    "BeginTime": "00:00:00",
                    "EndTime": "10:00:00",
                    "WeekDay": 1
                }
            ],
            "UpdatedAt": "2026-08-17 17:23:42",
            "VLTemplateId": "VT58c*************************04e3"
        },
        "RequestId": "6f7a4ac9-7fea-4418-a715-f04fc0a66c83"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue.InvalidTemplateID 无效的视觉理解分析模板ID
InvalidParameterValue.TemplateIDNotExisted 视觉理解分析模板ID不存在