最近更新时间：2023.09.25 21:09:56
首次发布时间：2021.11.10 14:58:09
调用接口查询推拉流鉴权信息。
说明
该接口数据历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询推拉流鉴权接口。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeAuth | 接口名称。当前 API 的名称为 DescribeAuth。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Vhost | String | 否 |
| 域名空间名称。 说明 参数 |
Domain | String | 否 |
| 推/拉流域名。 说明 参数 |
| App | String | 否 | live | 应用名称，默认为所有应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成 |
SceneType | String | 是 |
| 鉴权场景类型。
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AuthList | Array of AuthList | - | 推/拉流鉴权列表 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Vhost | String | pull.example.com | 域名空间名称 |
| Domain | String | pull.example.com | 推/拉流域名 |
| App | String | live | 应用名称 |
SceneType | String |
| 鉴权场景类型。
|
AuthStatus | Boolean |
| 鉴权状态
|
| AuthDetailList | Object of AuthDetailList | - | 鉴权详情 |
| ValidDuration | Integer | 604800 | 有效时长，单位为 s |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| SecretKey | String | 1asd111 | 自定义鉴权密钥 |
| EncryptionAlgorithm | String | md5 | 对称加密算法 |
AuthField | JSON Map |
| 自定义推拉流地址中，鉴权参数 |
| EncryptField | Array 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" } ] } }
访问公共错误码获取详细信息。