You need to enable JavaScript to run this app.
导航

查询 DRM 加密配置

最近更新时间2024.03.19 14:42:22

首次发布时间2024.03.19 14:42:22

调用 ListBindEncryptDRM 接口,查询指定域名空间和应用名称的 DRM 加密配置或查看指定域名空间下所有 DRM 加密配置。

注意事项

  • 请求频率:单用户请求频率限制为 1 次/秒
  • 生效时间:配置添加完成后 3~5 分钟后生效。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListBindEncryptDRM接口名称。当前 API 的名称为 ListBindEncryptDRM
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
VhostStringpush.example.com域名空间,即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,查看直播流使用的域名所属的域名空间。
AppStringlive应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示查询符合域名空间取值的所有的 DRM 加密配置。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。

返回参数

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

参数类型示例值描述
DRMBindingListArray of DRMBindingList-DRM 加密配置列表。

DRMBindingList

参数类型示例值描述
VhostStringpush.example.com域名空间,与创建 DRM 加密配置时的取值一致。
AppStringlive应用名称,与创建 DRM 加密配置时的取值一致。

Enable

Boolean

true

当前 DRM 配置是否开启,取值及含义如下所示。

  • true:开启;
  • false:关闭。
EncryptTranscodeSuffixArray of String["_hd"]进行 DRM 加密的转码流对应的转码流后缀配置。

请求示例

POST https://live.volcengineapi.com?Action=ListBindEncryptDRM&Version=2023-01-01
{
    "Vhost": "example.com",
    "App": "apptest"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListBindEncryptDRM",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "DRMBindingList": [
            {
                "Vhost": "vhost.com",
                "App": "app",
                "AccountID": "1000000002",
                "Enable": false,
                "EncryptTranscodeSuffix": [
                    "_hd"
                ]
            }
        ]
    }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误,请联系技术支持
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时,请联系技术支持