You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

添加或更新推拉流鉴权

最近更新时间：2023.10.12 17:39:57

首次发布时间：2021.11.10 14:58:09

我的收藏

添加或更新推拉流鉴权信息。更新时，会对所有的鉴权参数做全量覆盖更新。

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版更新或添加推拉流鉴权接口。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=UpdateAuthKey&Version=2020-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是UpdateAuthKey接口名称。当前 API 的名称为 UpdateAuthKey。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。

Body

参数类型是否必选示例值描述

Vhost

String

否

live.push.example.com

域名空间名称。

说明

参数 Domain 和 Vhost 传且仅传一个。

Domain

String

否

live.push.example.com

推/拉流域名。

说明

参数 Domain 和 Vhost 传且仅传一个。

AppString否live应用名称，默认为所有应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。

SceneType

String

是

push

鉴权场景类型。

  • push：推流鉴权；
  • pull：拉流鉴权；
AuthDetailListArray of AuthDetailList是-鉴权详情，数量阈值为 100
ValidDurationInteger否60有效时长，单位为 s，默认值为 604800，取值范围为 [60,2592000]

PushPullEnable

Boolean

否

true

鉴权状态。创建推拉流鉴权时，默认值为 false；更新推拉流鉴权时，缺省情况表示不修改推拉流鉴权状态。

  • false：关闭推拉流鉴权；
  • true：开启推拉流鉴权。

AuthDetailList

参数类型是否必选示例值描述
SecretKeyString是1*****1自定义鉴权密钥。支持数字和大小写字母，最大长度 100 个字符
EncryptionAlgorithmString是md5对称加密算法。仅支持 md5、md5_custom

AuthField

JSON Map

否

{
	"volcSecret":"sign",
	"volcTime":"expire"
}

该参数在推/拉流鉴权时生效，表示自定义推拉流地址中，鉴权参数 volcSecret 和 volcTime 的名称。缺省情况下表示：

{
		"volcSecret":"volcSecret",
  	"volcTime":"volcTime"
}

您可以自定义参数名，例如，

{
		"volcSecret":"sign",
  	"volcTime":"expire"
}

EncryptField

Array of String

否

["key","volcTime","Domain"]

该参数在推/拉流鉴权时生效，表示加密字段。使用不同的对称加密算法 EncryptionAlgorithm，加密字段存在差异

  • 当使用 md5 时：默认加密字段为 ["AppName","StreamName","key","expireTime"]，且不支持修改；
  • 当使用 md5_custom 时：默认无加密字段，但推荐至少包含 key 和 volcTime。同时您还可以自定义 Domain、AppName、StreamName 等字段。
    例如，选择 key、volcTime 和 Domain 作为加密字段，则取值为 ["key","volcTime","Domain"]

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

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"
  }
}

错误码

访问公共错误码获取详细信息。