DescribeProject - 获取剪辑工程--视频点播-火山引擎

文档中心

立即注册

导航

视频点播

DescribeProject - 获取剪辑工程

最近更新时间：2025.10.24 19:49:14首次发布时间：2025.10.24 19:49:14

调用 DescribeProject 获取剪辑工程的详细信息。

请求说明

请求方式：POST
请求地址：https://vod.volcengineapi.com?Action=DescribeProject&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeProject`	接口名称。当前 API 的名称为 `DescribeProject`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数	类型	是否必选	示例值	描述
GroupId	String	是	`g03cexxxxxxxxxxxxxxxxxqt2g`	剪辑工程所属的组 ID。
ProjectId	String[]	是	`p03ef0xxxxxxxxxxxxx4bm0`	剪辑工程 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Result	Object[]	`-`	返回工程信息的数组。
GroupId	String	`g03cexxxxxxxxxxxxxxxxxqt2g`	剪辑工程任务所属的组 ID。
ProjectId	String	`p03ef0xxxxxxxxxxxxx4bm0`	剪辑工程 ID。
ProjectName	String	`hixxhlixxxhs101x516`	工程名称。长度建议控制在 1-128 个字符之间。支持以下字符类型：汉字大小写字母数字中划线（-）下划线（_）
ProjectType	String	`track`	工程类型。
TemplateId	String	`tpl_20251014EXAMPLE453A60AF35ECC902D`	工程模板 ID。
LatestEditParam	JSONMap	`{"editAction":"trim","startTime":"00:00:10","endTime":"00:00:20"}`	工程的最新编辑参数。
Thumbnails	String	`https://example.com/thumbnails/project_thumbnail.jpg`	工程的缩略图 URL，用于展示项目的预览图。
Space	String	`vod-v2-test`	工程所属的点播空间名称。
CallbackType	String	`http`	回调类型，用于指定任务完成后的回调方式。
CallbackUri	String	`https://example.com/api/callback`	任务完成后回调地址。
CreatedAt	String	`2025-10-13T15:16:38+08:00`	工程的创建时间，采用 ISO 8601 格式表示，包含时区信息。
UpdatedAt	String	`2025-10-13T15:33:25+08:00`	工程的最后更新时间，采用 ISO 8601 格式表示，包含时区信息。
Extra	String	`-`	工程的额外信息字段。

请求示例

POST https://vod.volcengineapi.com?Action=DescribeProject&Version=2018-01-01
{
  "GroupId": "g03cxxxxxxxxxx",
  "ProjectId": [
    "p02xxxxxxxxxhss0"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "DescribeProject",
    "Version": "2018-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": [
    {
      "GroupId": "g03cxxxxxxxxxx",
      "ProjectId": "p02xxxxxxxxxhss0",
      "ProjectName": "highxxxxxxxx31516",
      "ProjectType": "track",
      "TemplateId": "xxxxx",
      "LatestEditParam": {
        "Uploader": "edit",
        "Upload": {
          "SpaceName": "yhss",
          "VideoName": "新建项目-5ia9m6feyg"
        },
        "Output": {
          "Alpha": false,
          "Fps": 25,
          "Codec": {
            "VideoCodec": "h264",
            "Preset": "slow",
            "Crf": 23,
            "AudioCodec": "aac",
            "AudioBitrate": 128
          },
          "DisableVideo": true,
          "DisableAudio": false,
          "Cover": {
            "DisableCover": true
          }
        },
        "Canvas": {
          "Width": 1080,
          "Height": 1920
        },
        "Project": {
          "CreateTime": 1760340793055,
          "Name": "highlight_test_yhs10131516",
          "Tag": "TrackEditor",
          "UpdateTime": 1760340805406,
          "Version": "1.0.0"
        },
        "Track": [
          [
            ""
          ]
        ]
      },
      "Thumbnails": "xxxx",
      "Space": "xxxxx",
      "CallbackType": "",
      "CallbackUri": "",
      "CreatedAt": "2025-10-13T15:16:38+08:00",
      "UpdatedAt": "2025-10-13T15:33:25+08:00",
      "Extra": ""
    }
  ]
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。