发起API请求

更新时间:2025-05-28 15:52:08

本节提供关于如何构建和发起CDNetworks流媒体处理服务API调用的完整指南。在开始前,请确保您的账户已开通流媒体处理服务,并准备好正确的AccessKey和AccessKey Secret密钥对。

请求结构

所有流媒体处理服务的API请求都遵循统一的请求结构,包含特定的HTTP方法、已定义完成的URI、必要请求头以及包含处理参数的请求体。

请求方法

当前流媒体处理服务API仅支持使用POSTHTTP方法来提交处理请求。

请求URI

流媒体处理服务API的基础URI结构如下:

http://<API Address>/fops

URI各组成部分说明如下表:

参数 说明
通信协议 当前仅支持通过HTTP协议向媒体处理服务API发送请求
API地址 即对象存储控制台中的"管理域名",可通过对象存储 > 存储空间 > 概览 > 管理域名查看
资源路径 除非特定API功能另有说明,流媒体处理请求的资源路径固定为/fops

URI示例

请求头

每个流媒体处理服务API请求必须在请求头中包含身份验证信息,以验证请求者的身份。该信息通过Authorization请求头提供,具体由您的AccessKey和生成的EncodeSign组成。

Authorization: <AccessKey>:<EncodeSign>

关于如何生成身份验证凭证(EncodeSign)的详细说明,请参阅鉴权方法文档

请求体

请求体用于指示流媒体处理服务需要处理的媒体文件及处理类型至关重要,请求体的格式应采用application/x-www-form-urlencoded格式,并包含以下参数:

bucket=[Bucket]&key=[Key]&fops=[Fops]&notifyURL=[NotifyURL]&force=[Force]&separate=[Separate]

各参数详细说明如下表:

参数 必填 说明
bucket 对象存储中包含待处理文件的空间名称
key 待处理文件的名称
fops 处理参数列表,fops参数用于指定您希望对视频或音频执行的流媒体处理类型。您需要根据具体的处理需求来定制fops参数。关于如何针对不同任务构建fops参数的详细说明,请参阅以下章节:
视频转码
封装
HLS标准化加密
智控高清
音视频拼接
notifyURL 回调地址。处理结果通知接收URL。当流媒体处理任务失败或完成时,将向该地址发送通知。
请求体中需进行URL安全Base64编码。
关于回调的更多详细信息,请参阅回调通知
force 是否覆盖已存在文件,是否强制执行数据处理。该参数用于避免对已处理的文件进行重复操作。:
0- 目标文件已存在时不处理
1 - 目标文件存在时仍强制执行处理并覆盖
默认值为0
separate 通知方式,处理是否分开通知:
0- 所有处理任务完成后统一发送回调通知
1 - 每个处理任务完成后单独发送回调通知
默认值为0

请求示例

curl -v -X POST --url "http://mgrDomain/fops"
-d "bucket=aW1hZ2Vz&key=bGVodS5tcDQ==&fops=YXZ0aHVtYi9mbHYvcy80ODB4Mzg0fHNhdmVhcy9hVzFoWjJWek9tZHFhQzVtYkhZPQ=="
-H "Authorization:86622e227a50d49d858c2494a935bc2e4ac543a7:Y2JmMGY0YTNhZmQxZmVlZGM2ZTA0YTdjNTcyOWQ1NjRkNTExYjg0Yg==" 
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!