获取指定域名可选的已有证书,即已在SSL证书中进行管理的证书。
使用说明
本接口用于查询域名关联的SSL证书列表(通过阿里云SSL证书服务购买、已上传到SSL证书服务进行托管),例如,证书的ID、名称、关联的域名、SAN(Subject Alternative Name)扩展属性等。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCertificates | 要执行的操作。取值:DescribeCertificates。 |
InstanceId | String | 是 | waf-cn-zz11sr5**** | WAF实例的ID。 说明 您可以调用DescribeInstanceInfo获取当前WAF实例的ID。 |
Domain | String | 否 | www.aliyundoc.com | 要查询关联SSL证书的域名。 不设置该参数表示查询所有域名关联的SSL证书。 |
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | ECF65091-3704-55D5-BC88-EC208B0E238C | 本次请求的ID。 |
Certificates | Array of Certificate | 域名关联的SSL证书信息。 |
|
IsUsing | Boolean | false | 是否是该域名当前所使用的证书。取值:
|
CertificateName | String | *.aliyundoc.com | 证书名称。 |
CertificateId | Long | 2329260 | 证书ID。 |
CommonName | String | *.aliyundoc.com | 证书绑定的域名。 |
Sans | Array of String | *.aliyundoc.com | 证书绑定的其他域名。 |
EndTime | Long | 1971273600000 | 证书到期时间,格式为Unix时间戳(UTC时间),单位为毫秒。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeCertificates
&InstanceId=waf-cn-zz11sr5****
&Domain=www.aliyundoc.com
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeCertificatesResponse>
<RequestId>ECF65091-3704-55D5-BC88-EC208B0E238C</RequestId>
<Certificates>
<IsUsing>false</IsUsing>
<CertificateName>*.aliyundoc.com</CertificateName>
<CertificateId>2329260</CertificateId>
<CommonName>*.aliyundoc.com</CommonName>
<Sans>*.aliyundoc.com</Sans>
</Certificates>
</DescribeCertificatesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "ECF65091-3704-55D5-BC88-EC208B0E238C",
"Certificates" : [ {
"IsUsing" : false,
"CertificateName" : "*.aliyundoc.com",
"CertificateId" : 2329260,
"CommonName" : "*.aliyundoc.com",
"Sans" : [ "*.aliyundoc.com" ]
} ]
}
错误码
访问错误中心查看更多错误码。