DescribeLiveDomainCertificateInfo - 查询指定直播域名证书信息

获取指定直播域名证书信息。

接口说明

先获取直播域名,再调用本接口获取指定直播域名证书信息。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveDomainCertificateInfoget
*全部资源
*

请求参数

名称类型必填描述示例值
DomainNamestring

播流域名或推流域名。

example.com

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

5C1E43DC-9E51-4771-82C0-7D5ECEB547A1
CertInfosarray<object>

证书信息。

CertInfoobject
Statusstring

个人测试证书(免费版)状态。取值:

  • success:已生效。
  • checking:检测域名是否在阿里云直播。
  • cname_error:域名没有切到阿里云直播。
  • domain_invalid:域名包含非法字符。
  • unsupport_wildcard:不支持泛域名。
  • applying:证书申请中。
  • failed:证书申请失败。
说明 status 只有在域名证书为个人测试证书(免费版)时有意义。当域名证书不是个人测试证书(免费版)时,会返回空值。
success
CertLifestring

证书时长。

  • 有效期大于 12 个月的,显示 XX year(s) XX month(s)。例如,2 years 3 months 表示有效期为 2 年 3 个月。
  • 有效期小于 12 个月的,显示为 XX month(s)。例如,3 months 表示有效期为 3 个月。
3 months
CertExpireTimestring

证书过期时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2018-06-03T22:03:39Z
SSLPubstring

证书公钥。

yourSSLPub
SSLProtocolstring

HTTPS 开启状态。取值:

  • on:已开启。
  • off:未开启。
on
CertTypestring

证书类型。取值:

  • free:个人测试证书(免费版)。
  • cas:云盾证书。
  • upload:自定义上传。
cas
CertDomainNamestring

证书匹配的播流域名或推流域名。

example.com
CertNamestring

证书名称。

Cert-****
CertOrgstring

证书组织。

Let's Encrypt
DomainNamestring

播流域名或推流域名。

example.com

示例

正常返回示例

JSON格式

{
  "RequestId": "5C1E43DC-9E51-4771-82C0-7D5ECEB547A1",
  "CertInfos": {
    "CertInfo": [
      {
        "Status": "success",
        "CertLife": "3 months",
        "CertExpireTime": "2018-06-03T22:03:39Z",
        "SSLPub": "yourSSLPub",
        "SSLProtocol": "on",
        "CertType": "cas",
        "CertDomainName": "example.com",
        "CertName": "Cert-****",
        "CertOrg": "Let's Encrypt",
        "DomainName": "example.com"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-29OpenAPI 描述信息更新查看变更详情

特殊错误码

ErrorCode 错误码Message 错误信息HTTP 状态语义
InvalidDomain.NotFoundThe domain provided does not belong to you.404域名不存在或不属于当前用户。