全部产品
Search

搜索本产品

    视频点播：DescribeVodDomainCertificateInfo - 查询域名证书

    文档中心

    视频点播：DescribeVodDomainCertificateInfo - 查询域名证书

    更新时间：Nov 05, 2024

    调用本接口获取指定加速域名的证书信息。

    接口说明

    目前服务地域仅支持：华东 2（上海）。

    调试

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

    授权信息

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

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

    请求参数

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

    点播加速域名。

    		example.com

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

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

    证书信息。

    CertInfoobject
    CertExpireTimestring

    证书过期时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

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

    证书时长。单位：months（月），years（年）。

    		3 months
    Statusstring

    证书状态。

    • success：已生效
    • checking：检测域名是否在阿里云点播
    • cname_error：域名没有切到阿里云点播
    • domain_invalid：域名包含非法字符
    • unsupport_wildcard：不支持泛域名
    • applying：证书申请中
    • failed：证书申请失败
    说明 仅当CertType为free时，该字段才会返回值，其他类型的证书该字段返回为空。
    		success
    CertDomainNamestring

    证书匹配的域名。

    		example.com
    ServerCertificateStatusstring

    HTTPS 证书开启状态。

    • on：已开启
    • off：未开启
    		on
    CertOrgstring

    证书组织。

    		Let's Encrypt
    DomainNamestring

    加速域名。

    		example.com
    CertTypestring

    证书类型。取值：

    • free：免费证书
    • cas：云盾证书
    • upload：自定义上传
    		free
    CertNamestring

    证书名称。

    		cert-example.com

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-08-21OpenAPI 返回结构发生变更查看变更详情

    接口错误码

    下表列举了本接口特有的错误码。

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