接口功能介绍
用户可在点播模式下通过本接口对媒体库的视频文件进行签名。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /video/file/sign
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| fileId | 是 | String | 必填参数。文件id。 | 34c71dba-f280-4f5e-a05f-f4daed837fef/100000000003.m3u8 | |
| signatureVersion | 否 | String | 可选参数，默认为 s3v4，可选 s3v4/s3v2。 | s3v4 | |
| expiresIn | 是 | Integer | 必填参数，过期时间，由签名一刻算起，过期时间的秒数。如 3600（即一个小时）。 | 3600 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码。 | 0 | |
| message | 是 | String | 错误文本信息，创建成功时，为空字符串。 | "" | |
| data | 是 | Object | 返回数据。 | data |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| fileId | 是 | String | 文件id | 34c71dba-f280-4f5e-a05f-f4daed837fef/100000000003.m3u8 | |
| url | 是 | String | 视频播放的url，返回数据库中当前的url，如果没有调用签名接口签名，返回的是无签名的url，如果有调用则是上一次签名的url。 | https://example.gdoss.xstore.ctyun.cn/vod-transcoded-xxxxx/34c71dba-f280-4f5e-a05f-f4daed837fef/100000000003_signed.m3u8?signature=xxxxx&Expires=1111111 |
请求示例
请求体body
{
"fileId": "34c71dba-f280-4f5e-a05f-f4daed837fef/100000000003.m3u8",
"signatureVersion": "s3v4",
"expiresIn": 3600
}
响应示例
{
"code": 0,
"message": "",
"data": {
"fileId": "34c71dba-f280-4f5e-a05f-f4daed837fef/100000000003.m3u8",
"url": "https://example.gdoss.xstore.ctyun.cn/vod-transcoded-xxxxx/34c71dba-f280-4f5e-a05f-f4daed837fef/100000000003_signed.m3u8?signature=xxxxx&Expires=1111111"
}
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
