全部产品
Search
文档中心

CDN:DescribeDomainCertificateInfo - 查询域名证书信息

更新时间:Aug 06, 2024

调用DescribeDomainCertificateInfo查询指定加速域名证书信息。

接口说明

说明 单用户调用频率:100 次/秒。

调试

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

授权信息

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

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

请求参数

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

加速域名,仅支持单个查询。

example.com

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

证书信息列表。

object
CertExpireTimestring

证书过期时间。

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

证书时长单位。

  • months:月。
  • years:年。
months
Statusstring

证书状态。

  • success:已生效。
  • checking:检测域名是否在阿里云 CDN。
  • cname_error:域名没有切到阿里云 CDN。
  • top_domain_cname_error:顶级域名没有切到阿里云 CDN。
  • domain_invalid:域名包含非法字符。
  • unsupport_wildcard:不支持泛域名。
  • applying:证书申请中。
  • get_token_timeout:证书申请超时。
  • check_token_timeout:校验超时。
  • get_cert_timeout:获取证书超时。
  • failed:证书申请失败。
success
CertUpdateTimestring

证书更新时间。

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

证书匹配的域名。

example.com
ServerCertificateStatusstring

https 开启状态。

  • on:已开启。

  • off:未开启。

on
CertOrgstring

该证书签发的 CA 名称。

Let's Encrypt
DomainNamestring

加速域名。

example.com
CertStartTimestring

证书开始时间。

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

证书类型。

  • free:免费证书。

  • cas:云盾证书。

  • upload:自定义上传。

free
CertNamestring

证书名称。

example.com
DomainCnameStatusstring

域名 CNAME 状态。

  • ok:域名 CNAME 已切到阿里云 CDN。

  • cname_error:域名 CNAME 错误,没有切到阿里云 CDN。

  • top_domain_cname_error:顶级域名 CNAME 错误,没有切到阿里云 CDN。

  • unsupport_wildcard:不支持泛域名。

ok
ServerCertificatestring

证书公钥。

asdadaxxxx
CertIdstring

证书 ID。

9002448
CertRegionstring

证书区域。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "RequestId": "5C1E43DC-9E51-4771-82C0-7D5ECEB547A1",
  "CertInfos": {
    "CertInfo": [
      {
        "CertExpireTime": "2018-06-03T22:03:39Z",
        "CertLife": "months",
        "Status": "success",
        "CertUpdateTime": "2018-06-03T22:03:39Z",
        "CertDomainName": "example.com",
        "ServerCertificateStatus": "on",
        "CertOrg": "Let's Encrypt",
        "DomainName": "example.com",
        "CertStartTime": "2018-06-03T22:03:39Z",
        "CertType": "free",
        "CertName": "example.com",
        "DomainCnameStatus": "ok",
        "ServerCertificate": "asdadaxxxx",
        "CertId": "9002448",
        "CertRegion": "cn-hangzhou"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
403SignatureDoesNotMatchThe signature we calculated does not match the one you provided. Please refer to the API reference about authentication for details.
500InternalErrorThe request processing has failed due to internal error.

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