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

查看 DRM 证书管理平台访问密钥和 FairPlay 证书

最近更新时间：2024.03.19 14:41:08

首次发布时间：2024.03.19 14:41:08

我的收藏

调用 DescribeEncryptDRM 接口，查看已配置的 DRM 证书管理平台访问密钥和 FairPlay 证书信息。

注意事项

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

请求说明

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

请求参数

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

Query

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

返回参数

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

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

DRMItem

参数类型示例值描述
APIKeyStringdesnjkfjsedlfndskfnsklndaDRM 证书管理平台 API 访问密钥。
CertificateNameStringtest自定义的 FairPlay 证书名称。
PrivateKeyFileNameStringprivate.cer申请 FairPlay 证书时创建的私钥文件名称。
CertificateFileNameStringfairplay.pemFairPlay 证书文件的名称。
ApplicationSecretKeyStringdandkandkadacdsknkmkmmknk申请 FairPlay 证书过程中 Apple 返回的 ASk（Application Secret Key）字符串。
PrivateKeyStringhufh29893rh2f384hfv82申请 FairPlay 证书时创建的私钥文件密钥。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeEncryptDRM",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "DRMItem": {
            "APIKey": "desnjkfjsedlfndskfnsklnda",
            "CertificateName": "test",
            "PrivateKeyFileName": "private.cer",
            "CertificateFileName": "fairplay.pem",
            "ApplicationSecretKey": "dandkandkadacdsknkmkmmknk",
            "PrivateKey": "hufh29893rh2f384hfv82"
        }
    }
}

错误码

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

状态码错误码错误信息说明
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.内部服务超时，请联系技术支持。