查询主体

最近更新时间:2026-04-17 02:37:45

我的收藏

1. 接口描述

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

提交视频特效任务接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAigcElement。
Version String 公共参数,本接口取值:2024-05-23。
Region String 公共参数,详见产品支持的 地域列表
ElementId String
示例值:elem_b9cc80f7-c9aa-41a5-85a6-49c4f0f97f2e

3. 输出参数

参数名称 类型 描述
Name String

主体名称


示例值:xincheng_0
ElementId String

主体id


示例值:elem_b9cc80f7-c9aa-41a5-85a6-49c4f0f97f2e
Description String

主体描述


示例值:这是我的一个主体测试
ReferenceType String

主体参考方式

枚举值:

  • video_refer: 视频角色主体
  • image_refer: 多图主体

示例值:image_refer
Status String

任务状态

枚举值:

  • pending: 执行中
  • failed: 任务失败
  • succeed: 任务成功

示例值:succeed
Provider Array of String

厂商列表


示例值:["kling"]
ElementImageList ElementImageList

主体参考图,可通过多张图片设定主体及其细节

VideoList Array of String

主体参考视频,可通过视频设定主体及其细节


示例值:["https://cos.ap-guangzhou.tencentcos.cn/input/251197765/3f316138-fa8c-4f2d-90f9-ad766e200503_1774581810_0.mp4"]
TagList Array of TagList

为主体配置标签,一个主体可以配置多个标签

ProviderDetails Array of ProviderDetail

厂商聚合字段

CreatedAt String

创建时间


示例值:2026-03-27T21:21:35+08:00
UpdatedAt String

更新时间


示例值:2026-03-27T21:21:39+08:00
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询主体

输入示例

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

{
    "ElementId": "elem_b9cc80f7-c9aa-41a5-85a6-49c4f0f97f2e"
}

输出示例

{
    "Response": {
        "CreatedAt": "2026-03-27T21:21:35+08:00",
        "Description": "这是我的一个主体测试",
        "ElementId": "elem_b9cc80f7-c9aa-41a5-85a6-49c4f0f97f2e",
        "ElementImageList": {
            "FrontalImage": "https://********************cos.ap-guangzhou.tencentcos.cn/material/input/1259088371/b9cc80f7-c9aa-41a5-85a6-49c4f0f97f2e_1774617695_0.jpg******************************************************************************************************************************************************************************************************************b407db7759c28a8",
            "ReferImages": [
                {
                    "ImageUrl": "https://********************cos.ap-guangzhou.tencentcos.cn/material/input/1259088371/b9cc80f7-c9aa-41a5-85a6-49c4f0f97f2e_1774617695_1.jpg******************************************************************************************************************************************************************************************************************38c6535a1490d19"
                }
            ]
        },
        "Name": "xincheng_0",
        "Provider": [
            "kling"
        ],
        "ProviderDetails": [
            {
                "ErrorMessage": "",
                "Provider": "kling",
                "Status": "succeed"
            }
        ],
        "ReferenceType": "image_refer",
        "Status": "succeed",
        "TagList": [
            {
                "TagId": "o_102"
            }
        ],
        "UpdatedAt": "2026-03-27T21:21:39+08:00",
        "VideoList": [],
        "RequestId": "9eec7037-8458-40a3-a31b-536e7c377487"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码