DescribeCertificates - Web Application Firewall - Alibaba Cloud ドキュメントセンター

特定のドメイン名にバインドされているSSL証明書を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	データ型	必須／任意	例	説明
アクション	String	必須	DescribeCertificates	実行したい操作。値をDescribeCertificatesに設定します。
ドメイン	String	必須	www.example.com	WAFに追加されるドメイン名。
InstanceId	String	必須	waf_elasticity-cn-0xldbqt ****	WAFインスタンスのID。説明 DescribeInstanceInfo操作を呼び出して、WAFインスタンスのIDを照会できます。

レスポンスパラメーター

パラメーター	データ型	例	説明
証明書	配列		ドメイン名にバインドされているSSL証明書に関する情報。
CertificateId	Long	2329260	SSL証明書のID。
CertificateName	String	CertName	SSL 証明書の名前。
CommonName	String	*.example.com	SSL証明書がバインドされているドメイン名。
IsUsing	Boolean	false	SSL証明書がドメイン名で使用されているかどうかを示します。設定可能な値は以下のとおりです。 true: はい false: いいえ
Sans	List	["*.example.com"]	WAFによって保護され、SSL証明書にバインドされたドメイン名で構成される配列。
RequestId	String	D7861F61-5B61-46CE-A47C-6B19160D5EB0	リクエストの ID です。

例

リクエストの例

http(s):// [エンドポイント]/?Action=DescribeCertificates
&Domai n=www.example.com
&InstanceId=waf_elasticity-cn-0xldbqt ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

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

JSON 形式

{
    "証明書": [
        {
            "サンズ": [
                "*.example.com"
            ],
            "CertificateId": 2329260、
            "CertificateName": "CertName" 、
            "IsUsing": true、
            "CommonName": "* .example.com"
        }
    ],
    "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。