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=DescribeAuth&Version=2020-08-01

请求参数

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

Query

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

Body

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

Vhost

String

pull.example.com

域名空间名称。

说明

参数 DomainVhost 传且仅传一个。

Domain

String

pull.example.com

推/拉流域名。

说明

参数 DomainVhost 传且仅传一个。

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

SceneType

String

push

鉴权场景类型。

  • push:推流鉴权;
  • pull:拉流鉴权;

返回参数

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

参数类型示例值描述
AuthListArray of AuthList-推/拉流鉴权列表

AuthList

参数类型示例值描述
VhostStringpull.example.com域名空间名称
DomainStringpull.example.com推/拉流域名
AppStringlive应用名称

SceneType

String

push

鉴权场景类型。

  • push:推流鉴权;
  • pull:拉流鉴权;

AuthStatus

Boolean

false

鉴权状态

  • false:关闭推拉流鉴权;
  • true:开启推拉流鉴权。
AuthDetailListObject of AuthDetailList-鉴权详情
ValidDurationInteger604800有效时长,单位为 s

AuthDetailList

参数类型示例值描述
SecretKeyString1asd111自定义鉴权密钥
EncryptionAlgorithmStringmd5对称加密算法

AuthField

JSON Map

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

自定义推拉流地址中,鉴权参数 volcSecret 和 volcTime 的名称

EncryptFieldArray of String["key","volcTime","Domain"]加密字段

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeAuth&Version=2020-08-01
{
  "Vhost": "vhost-lh-pull-test.example.com",
  "SceneType": "push"
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "20210829114930010210039045250DAD6E",
    "Action": "DescribeAuth",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "AuthList": [
      {
        "App": "test",
        "AuthDetailList": [
          {
            "AuthField": {},
            "EncryptField": [],
            "EncryptionAlgorithm": "md5",
            "SecretKey": "1asd111"
          }
        ],
        "AuthStatus": false,
        "Domain": "",
        "SceneType": "push",
        "ValidDuration": 604800,
        "Vhost": "vhost-lh-pull-test.example.com"
      }
    ]
  }
}

错误码

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