SearchGlobalProject - 查询所有剪辑工程--视频点播-火山引擎

文档中心

立即注册

导航

视频点播

SearchGlobalProject - 查询所有剪辑工程

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

调用 SearchGlobalProject 查询所有剪辑工程。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Offset	Integer	是	`0`	分页查询时的起始记录位置，表示从第几条记录开始返回。
Limit	Integer	是	`18`	分页查询的每页记录。
SortBy	String	是	`updated_at`	指定返回结果的排序依据字段。
Space	String	是	`test`	工程所属的空间名称。

返回参数

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

参数	类型	示例值	描述
Total	Integer	`17`	符合搜索条件的工程数量。
Detail	Object[]	`-`	包含符合搜索条件的工程详细信息列表。
GroupId	String	`g03ce00d2tun4e1s5kpmo1hxxxx`	工程所属分组的 ID。
ProjectId	String	`p02a100d3maelb8u65acmusxxxx`	工程 ID。
ProjectName	String	`highlight_test_yhs1013xxxx`	工程名称。长度建议控制在1-128个字符之间。支持以下字符类型：汉字大小写字母数字中划线（-）下划线（_）
ProjectType	String	`track`	工程类型。
TemplateId	String	`t01a100d3maelb8u65acmusxxxx`	工程模板 ID。
LatestEditParam	JSONMap	`{"resolution":"1920x1080","duration":"60","format":"mp4"}`	工程的最新编辑参数。
Thumbnails	String	`https://example.com/thumbnails/p02a100d3maelb8u65acmusxxxx.jpg`	工程的缩略图 URL，用于展示工程的预览图。
Space	String	`yhss`	工程所属的空间名称。
CallbackType	String	`http`	任务完成后的回调类型。
CallbackUri	String	`https://example.com/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	`{"version":"1.0","author":"user123","tags":["highlight","test"]}`	工程的额外信息字段。
Tasks	Object[]	`-`	工程关联的任务列表。

请求示例

POST https://vod.volcengineapi.com?Action=SearchGlobalProject&Version=2018-01-01
{
  "Offset": 0,
  "Limit": 18,
  "SortBy": "updated_at",
  "Space": "test"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "SearchGlobalProject",
    "Version": "2018-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Total": 17,
    "Detail": [
      {
        "LatestEditParam": {},
        "GroupId": "g03ce00hqt2g",
        "ProjectId": "p02aushss0",
        "ProjectName": "high31516",
        "ProjectType": "track",
        "Space": "yhss",
        "CreatedAt": "2025-10-13T15:16:38+08:00",
        "UpdatedAt": "2025-10-13T15:33:25+08:00",
        "Extra": "",
        "Tasks": []
      }
    ]
  }
}

错误码

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