最近更新时间:2023.09.25 21:09:56
首次发布时间:2021.11.10 14:58:09
添加或更新推拉流鉴权信息。更新时,会对所有的鉴权参数做全量覆盖更新。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版更新或添加推拉流鉴权接口。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateAuthKey | 接口名称。当前 API 的名称为 UpdateAuthKey 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 否 |
| 域名空间名称。 说明 参数 |
Domain | String | 否 |
| 推/拉流域名。 说明 参数 |
App | String | 否 | live | 应用名称,默认为所有应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。 |
SceneType | String | 是 |
| 鉴权场景类型。
|
AuthDetailList | Array of AuthDetailList | 是 | - | 鉴权详情,数量阈值为 100 |
ValidDuration | Integer | 否 | 60 | 有效时长,单位为 s,默认值为 604800,取值范围为 [60,2592000] |
PushPullEnable | Boolean | 否 |
| 鉴权状态。创建推拉流鉴权时,默认值为 false;更新推拉流鉴权时,缺省情况表示不修改推拉流鉴权状态。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
SecretKey | String | 是 | 1*****1 | 自定义鉴权密钥。支持数字和大小写字母,最大长度 100 个字符 |
EncryptionAlgorithm | String | 是 | md5 | 对称加密算法。仅支持 md5、md5_custom |
AuthField | JSON Map | 否 |
| 该参数在推/拉流鉴权时生效,表示自定义推拉流地址中,鉴权参数
您可以自定义参数名,例如,
|
EncryptField | Array of String | 否 |
| 该参数在推/拉流鉴权时生效,表示加密字段。使用不同的对称加密算法
|
本接口无特有的返回参数。更多信息请见返回结构。
POST https://live.volcengineapi.com?Action=UpdateAuthKey&Version=2020-08-01 { "Vhost": "live.push.example.com", "App": "live", "SceneType": "push", "AuthDetailList": [ { "EncryptionAlgorithm": "md5", "SecretKey": "1*****1", "AuthField": { "volcSecret": "sign", "volcTime": "expire" } } ], "ValidDuration": 100, "PushPullEnable": true }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "UpdateAuthKey", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" } }
访问公共错误码获取详细信息。