DescribeCertificates - 获取指定域名可选证书

获取指定域名可选的已有证书,即已在SSL证书中进行管理的证书。

接口说明

本接口用于查询域名关联的 SSL 证书列表(通过阿里云 SSL 证书服务购买、已上传到 SSL 证书服务进行托管),例如,证书的 ID、名称、关联的域名、SAN(Subject Alternative Name)扩展属性等。请注意,为了确保系统稳定系,对单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

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

授权信息

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

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

请求参数

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

WAF 实例的 ID。

说明 您可以调用 DescribeInstanceInfo 获取当前 WAF 实例的 ID。
waf-cn-zz11sr5****
Domainstring

要查询关联 SSL 证书的域名。

不设置该参数表示查询所有域名关联的 SSL 证书。

www.aliyundoc.com
ResourceGroupIdstring

WAF 实例在资源管理服务中所属的资源组 ID。

不设置该参数表示默认资源组。

rg-aekzz2e****pp7i
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

ECF65091-3704-55D5-BC88-EC208B0E238C
Certificatesobject []

域名关联的 SSL 证书信息。

IsUsingboolean

是否是该域名当前所使用的证书。取值:

  • true:表示是。
  • false:表示否。
false
CertificateNamestring

证书名称。

*.aliyundoc.com
CertificateIdlong

证书 ID。

2329260
CommonNamestring

证书绑定的域名。

*.aliyundoc.com
Sansarray

证书的 SAN 扩展属性列表。

string

证书绑定的其他域名。

*.aliyundoc.com
EndTimelong

证书到期时间,格式为 Unix 时间戳(UTC 时间),单位为毫秒。

1971273600000

示例

正常返回示例

JSON格式

{
  "RequestId": "ECF65091-3704-55D5-BC88-EC208B0E238C",
  "Certificates": [
    {
      "IsUsing": false,
      "CertificateName": "*.aliyundoc.com",
      "CertificateId": 2329260,
      "CommonName": "*.aliyundoc.com",
      "Sans": [
        "*.aliyundoc.com"
      ],
      "EndTime": 1971273600000
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更