查询 HLS 密钥获取配置--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

查询 HLS 密钥获取配置

最近更新时间：2024.08.12 12:14:14首次发布时间：2024.08.12 12:14:14

调用 DescribeEncryptHLS 接口，查询 HLS 标准加密使用的自建密钥管理服务地址和视频直播更新密钥的周期。

注意事项

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

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=DescribeEncryptHLS&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeEncryptHLS`	接口名称。当前 API 的名称为 `DescribeEncryptHLS`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

返回参数

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

参数	类型	示例值	描述
URL	String	`http://example.kms.com/get_key?`	客户自建密钥管理服务后，客户端向密钥管理服务请求获取密钥的地址。
CycleTime	Float	`60`	视频直播服务端生成密钥的更新周期，单位为秒，取值范围为 [60,604800]。

请求示例

POST https://live.volcengineapi.com?Action=DescribeEncryptHLS&Version=2023-01-01

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeEncryptHLS",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "URL": "http://example.kms.com/get_key?",
        "CycleTime": 60
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。