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

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeLiveDomainCertificateInfo

系统规定参数。取值:DescribeLiveDomainCertificateInfo

DomainName String example.com

播流域名。

RegionId String cn-shanghai

域名所属地域。

返回数据

名称 类型 示例值 描述
CertInfos Array of CertInfo

证书信息。

CertInfo
CertDomainName String example.com

证书匹配的播流域名。

CertExpireTime String 2018-06-03T22:03:39Z

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

CertLife String 3 months

证书时长。

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

证书名称。

CertOrg String Let's Encrypt

证书组织。

CertType String cas

证书类型。取值:

  • free:免费证书。
  • cas:云盾证书。
  • upload:自定义上传。
DomainName String example.com

播流域名

SSLProtocol String on

HTTPS开启状态。取值:

  • on:已开启。
  • off:未开启。
SSLPub String yourSSLPub

证书公钥。

Status String success

证书状态。取值:

  • success:已生效。
  • checking:检测域名是否在阿里云直播。
  • cname_error:域名没有切到阿里云直播。
  • domain_invalid:域名包含非法字符。
  • unsupport_wildcard:不支持泛域名。
  • applying:证书申请中。
  • failed:证书申请失败。
RequestId String 5C1E43DC-9E51-4771-82C0-7D5ECEB547A1

请求ID。

示例

请求示例

http(s)://live.aliyundoc.com/?Action=DescribeLiveDomainCertificateInfo
&DomainName=example.com
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

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

特殊错误码

ErrorCode 错误码

Message 错误信息

HTTP 状态

语义

InvalidDomain.NotFound

The domain provided does not belong to you.

404

域名不存在或不属于当前用户。