DescribeCertificates_域名配置_API参考_Web 应用防火墙-阿里云

调用DescribeCertificates接口获取指定域名可选的已有证书，即已在SSL证书中进行管理的证书。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCertificates	要执行的操作。取值：DescribeCertificates。
Domain	String	是	www.example.com	已接入WAF的域名名称。
InstanceId	String	是	waf_elasticity-cn-0xldbqt****	WAF实例ID。说明您可以通过调用DescribeInstanceInfo接口查看当前WAF实例ID。

返回数据


名称	类型	示例值	描述
Certificates	Array		域名相关的已有证书信息。
CertificateId	Long	2329260	证书记录ID。
CertificateName	String	CertName	证书名称。
CommonName	String	*.example.com	证书绑定的域名。
IsUsing	Boolean	false	是否该域名当前所使用的证书。
Sans	List	["*.example.com"]	证书绑定的域名列表。
RequestId	String	D7861F61-5B61-46CE-A47C-6B19160D5EB0	请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCertificates
&Domain=www.example.com
&InstanceId=waf_elasticity-cn-0xldbqt****
&<公共请求参数>

正常返回示例

XML 格式

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeCertificatesResponse>
	<Certificates>
		<Sans>*.example.com</Sans>
		<CertificateId>2329260</CertificateId>
		<CertificateName>CertName</CertificateName>
		<IsUsing>true</IsUsing>
		<CommonName>*.example.com</CommonName>
	</Certificates>
	<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</requestId>
</DescribeCertificatesResponse>

JSON 格式

{
    "Certificates": [
        {
            "Sans": [
                "*.example.com"
            ],
            "CertificateId": 2329260,
            "CertificateName": "CertName",
            "IsUsing": true,
            "CommonName": "*.example.com"
        }
    ],
    "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

错误码

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