SearchEditMaterial - 搜索剪辑素材--视频点播-火山引擎

文档中心

立即注册

导航

视频点播

SearchEditMaterial - 搜索剪辑素材

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

调用 SearchEditMaterial 通过素材 ID 查询单个或多个剪辑素材（视频、图片和音频等）。

使用说明

调用 CreateEditMaterial 接口后获得素材 ID。

注意事项

本接口的单用户 QPS 限制为10次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见API QPS 限制。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ProjectId	String	是	`p0c8100d3xxxxphmbbcb8p374kg`	工程 ID。
EditMids	String[]	是	`[]`	剪辑素材 ID 列表。每个字符串必须是有效的素材 ID。
Space	String	是	`vod-v2-test`	剪辑素材所属的空间名称。

返回参数

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

参数	类型	示例值	描述
Total	Integer	`1`	返回查询到的素材数量。
Detail	Object[]	`-`	返回素材的详细信息列表。
EditMid	String	`m0cb600d3xxxx7gp8e6hf0ko790`	素材 ID。
ProjectId	String	`p0c8100d3xxxxphmbbcb8p374kg`	素材所属的工程 ID。
Name	String	`宣传视频素材`	素材的名称。
Type	String	`video`	素材的类型。支持的取值如下所示。 `video`：视频素材； `audio`：音频素材； `image`：图片素材； `text`：文本素材。
Status	String	`Running`	素材的处理状态。支持的取值如下所示。 `Running`：处理中； `Success`：处理成功； `Failed`：处理失败。
Source	String	`vid://v0c2dfxxxxxxxxxxxppfnggtug`	素材的来源地址。支持以下类型：点播 Vid：如果您已将素材上传至视频点播服务并使用 Vid 模式，可通过 `vid://${vid}` 格式指定资源的 Vid。示例：`vid://v02b6d970000bvg5pi6xxxxxx` 点播 DirectUrl：如果您已将素材上传至视频点播服务并使用 DirectUrl 模式，可通过 `directurl://{fileName}` 格式指定资源的 FileName。示例：`directurl://test.mp3` 挂载 TOS：如果您已在点播控制台完成挂载对象存储 TOS，可通过 `tos://{bucketName}/{fileName}` 格式指定资源地址。示例：`tos://example/test.mp3`
Content	Object	`素材展示的是xxx。`	素材的内容信息。
CreatedAt	String	`2025-10-19T10:59:37+08:00`	素材的创建时间，采用 ISO 8601 格式表示，包含时区信息。
UpdatedAt	String	`2025-10-19T10:59:37+08:00`	素材的最后更新时间，采用 ISO 8601 格式表示，包含时区信息。
Extra	String	`-`	素材的扩展信息。

请求示例

POST https://vod.volcengineapi.com?Action=SearchEditMaterial&Version=2018-01-01
{
  "ProjectId": "p0c8xxxxxxxxx8p374kg",
  "EditMids": [
    "m0cb60xxxxxxx0ko790"
  ],
  "Space": "vod-v2-test"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "SearchEditMaterial",
    "Version": "2018-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Total": 1,
    "Detail": [
      {
        "EditMid": "m0cb60xxxxxxx0ko790",
        "ProjectId": "p0c8100xxxxxxxb8p374kg",
        "Name": "",
        "Type": "video",
        "Status": "Running",
        "Source": "vid://v0c2dfxxxxxxxxxxxppfnggtug",
        "CreatedAt": "2025-10-19T10:59:37+08:00",
        "UpdatedAt": "2025-10-19T10:59:37+08:00",
        "Extra": ""
      }
    ]
  }
}

错误码

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