yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
14cbe517527a516f7d70b121f4bf6f28273b6dcc
doc-exports/docs/wafd/api-ref/ListCertificates.html
qinweiwei 14cbe51752 wafd API 20260210 version 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: qinweiwei <qinweiwei@huawei.com>
Co-committed-by: qinweiwei <qinweiwei@huawei.com>
2026-04-21 11:31:19 +00:00

420 lines
31 KiB
HTML
Raw Blame History

<a name="ListCertificates"></a><a name="ListCertificates"></a>
<h1 class="topictitle1">Querying the Certificate List</h1>
<div id="body1708331107508"><div class="section" id="ListCertificates__topic1781000000"><h4 class="sectiontitle">Function</h4><p id="ListCertificates__topic1781000002">This API is used to query the certificate list.</p>
</div>
<div class="section" id="ListCertificates__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="ListCertificates__topic1781000004">GET /v1/{project_id}/waf/certificate</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__topic1781000005" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListCertificates__topic1781000013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListCertificates__topic1781000015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListCertificates__topic1781000017">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListCertificates__topic1781000019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListCertificates__topic1781000021">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000023"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListCertificates__topic1781000025">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListCertificates__topic1781000027">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListCertificates__topic1781000029">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListCertificates__topic1781000031">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__topic1781000032" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListCertificates__topic1781000040"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListCertificates__topic1781000042">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListCertificates__topic1781000044">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListCertificates__topic1781000046">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListCertificates__topic1781000048">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000050"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListCertificates__topic1781000052">page</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListCertificates__topic1781000054">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListCertificates__topic1781000056">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListCertificates__topic1781000058">Page.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000059"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListCertificates__topic1781000061">pagesize</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListCertificates__topic1781000063">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListCertificates__topic1781000065">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListCertificates__topic1781000067">Number of records on each page. The maximum value is 100. If this parameter is not specified, the default value -1 is used. All certificates are queried regardless of the value of Page.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000068"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListCertificates__topic1781000070">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListCertificates__topic1781000072">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListCertificates__topic1781000074">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListCertificates__topic1781000076">Certificate name. Fuzzy search is supported.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000077"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListCertificates__topic1781000079">host</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListCertificates__topic1781000081">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListCertificates__topic1781000083">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListCertificates__topic1781000085">Whether to obtain the domain name associated with the certificate. The value can be true or false.</p>
<ul id="ListCertificates__topic1781000086"><li id="ListCertificates__topic1781000087"><p id="ListCertificates__topic1781000088"><a name="ListCertificates__topic1781000087"></a><a name="topic1781000087"></a>true: When a certificate is queried, the domain name associated with the certificate is also queried. The returned certificate information contains the associated domain name.</p>
</li><li id="ListCertificates__topic1781000089"><p id="ListCertificates__topic1781000090"><a name="ListCertificates__topic1781000089"></a><a name="topic1781000089"></a>false: When a certificate is queried, the domain name associated with the certificate is not queried. The returned certificate information does not contain the associated domain name.</p>
</li><li id="ListCertificates__topic1781000091"><p id="ListCertificates__topic1781000092"><a name="ListCertificates__topic1781000091"></a><a name="topic1781000091"></a>Default value: false</p>
</li></ul>
</td>
</tr>
<tr id="ListCertificates__topic1781000093"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListCertificates__topic1781000095">exp_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListCertificates__topic1781000097">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListCertificates__topic1781000099">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListCertificates__topic1781000101">Certificate status. The value can be:</p>
<ul id="ListCertificates__topic1781000102"><li id="ListCertificates__topic1781000103"><p id="ListCertificates__topic1781000104"><a name="ListCertificates__topic1781000103"></a><a name="topic1781000103"></a>0: The certificate is valid.</p>
</li><li id="ListCertificates__topic1781000105"><p id="ListCertificates__topic1781000106"><a name="ListCertificates__topic1781000105"></a><a name="topic1781000105"></a>1: The certificate has expired.2: The certificate will expire within one month.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListCertificates__topic1781000107"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListCertificates__topic1781000116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListCertificates__topic1781000118">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListCertificates__topic1781000120">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListCertificates__topic1781000122">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListCertificates__topic1781000124">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000126"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListCertificates__topic1781000128">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListCertificates__topic1781000130">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListCertificates__topic1781000132">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListCertificates__topic1781000134">User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000135"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListCertificates__topic1781000137">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListCertificates__topic1781000139">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListCertificates__topic1781000141">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListCertificates__topic1781000143">Content type. Default value: application/json;charset=utf8</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListCertificates__topic1781000144"><h4 class="sectiontitle">Response Parameters</h4><p id="ListCertificates__topic1781000146"><strong id="ListCertificates__topic1781000147">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__response_ListCertificateResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListCertificates__topic1781000154"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListCertificates__topic1781000156">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListCertificates__topic1781000158">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListCertificates__topic1781000160">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000162"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListCertificates__topic1781000164">items</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListCertificates__topic1781000166">Array of <a href="#ListCertificates__response_ListCertificateBody">ListCertificateBody</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListCertificates__topic1781000169">Certificate list</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000170"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListCertificates__topic1781000172">total</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListCertificates__topic1781000174">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListCertificates__topic1781000176">Total number of certificates</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListCertificates__response_ListCertificateBody"></a><a name="response_ListCertificateBody"></a><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__response_ListCertificateBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ListCertificateBody</caption><thead align="left"><tr id="ListCertificates__topic1781000183"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListCertificates__topic1781000185">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListCertificates__topic1781000187">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListCertificates__topic1781000189">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000191"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000193">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000195">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000197">Certificate ID</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000198"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000200">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000202">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000204">Certificate name</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000205"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000207">certificateid</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000209">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000211">Certificate ID, which is a redundant parameter. Please ignore it.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000212"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000214">certificatename</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000216">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000218">Certificate name, which is a redundant parameter. Please ignore it.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000221">expire_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000223">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000225">Timestamp when the certificate expires (unit: ms). This parameter is returned in the response body only when the value of <strong id="ListCertificates__topic1781000226">host</strong> in the URL request is <strong id="ListCertificates__topic1781000227">true</strong>.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000228"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000230">exp_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000232">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000234">Certificate expiration status. This parameter is returned in the response body only when the value of host in the URL request is true. The value can be:</p>
<ul id="ListCertificates__topic1781000235"><li id="ListCertificates__topic1781000236"><p id="ListCertificates__topic1781000237"><a name="ListCertificates__topic1781000236"></a><a name="topic1781000236"></a>0: The certificate is valid.</p>
</li><li id="ListCertificates__topic1781000238"><p id="ListCertificates__topic1781000239"><a name="ListCertificates__topic1781000238"></a><a name="topic1781000238"></a>1: The certificate has expired.</p>
</li><li id="ListCertificates__topic1781000240"><p id="ListCertificates__topic1781000241"><a name="ListCertificates__topic1781000240"></a><a name="topic1781000240"></a>2: The certificate is about to expire.</p>
</li></ul>
</td>
</tr>
<tr id="ListCertificates__topic1781000242"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000244">timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000246">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000248">Timestamp when the certificate is uploaded</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000251">bind_host</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000253">Array of <a href="#ListCertificates__response_BindHost">BindHost</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000256">Domain name associated with the certificate. This parameter is returned in the response body only when the value of host in the URL request is true.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000257"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000259">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000261">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000263">Enterprise project ID.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000264"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000266">share_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000268">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000270">Sharing status. This parameter is redundant and can be ignored.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000271"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCertificates__topic1781000273">cert_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCertificates__topic1781000275">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCertificates__topic1781000277">Certificate type. This parameter is redundant and can be ignored.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListCertificates__response_BindHost"></a><a name="response_BindHost"></a><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__response_BindHost" frame="border" border="1" rules="all"><caption><b>Table 6 </b>BindHost</caption><thead align="left"><tr id="ListCertificates__topic1781000284"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ListCertificates__topic1781000286">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ListCertificates__topic1781000288">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ListCertificates__topic1781000290">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000292"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListCertificates__topic1781000294">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListCertificates__topic1781000296">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListCertificates__topic1781000298">Domain name ID. It is the unique identifier generated by WAF for a domain name when you add the domain name to WAF</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000299"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListCertificates__topic1781000301">hostname</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListCertificates__topic1781000303">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListCertificates__topic1781000305">Domain name</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000306"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListCertificates__topic1781000308">waf_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListCertificates__topic1781000310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListCertificates__topic1781000312">WAF mode of the domain name. The value is premium.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListCertificates__topic1781000313"><strong id="ListCertificates__topic1781000314">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__response_RestErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListCertificates__topic1781000321"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="ListCertificates__topic1781000323">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="ListCertificates__topic1781000325">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="ListCertificates__topic1781000327">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000329"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListCertificates__topic1781000331">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListCertificates__topic1781000333">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListCertificates__topic1781000335">Error code</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000336"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListCertificates__topic1781000338">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListCertificates__topic1781000340">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListCertificates__topic1781000342">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListCertificates__topic1781000343"><strong id="ListCertificates__topic1781000344">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__response_RestErrorResponse_1" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListCertificates__topic1781000351"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="ListCertificates__topic1781000353">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="ListCertificates__topic1781000355">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="ListCertificates__topic1781000357">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000359"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListCertificates__topic1781000361">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListCertificates__topic1781000363">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListCertificates__topic1781000365">Error code</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000366"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ListCertificates__topic1781000368">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ListCertificates__topic1781000370">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ListCertificates__topic1781000372">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListCertificates__topic1781000373"><strong id="ListCertificates__topic1781000374">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__response_RestErrorResponse_2" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ListCertificates__topic1781000381"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.1"><p id="ListCertificates__topic1781000383">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.2"><p id="ListCertificates__topic1781000385">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.11.2.4.1.3"><p id="ListCertificates__topic1781000387">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000389"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ListCertificates__topic1781000391">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ListCertificates__topic1781000393">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ListCertificates__topic1781000395">Error code</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000396"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ListCertificates__topic1781000398">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ListCertificates__topic1781000400">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ListCertificates__topic1781000402">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListCertificates__topic1781000403"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ListCertificates__topic1781000405">GET https://{Endpoint}/v1/{project_id}/waf/certificate?page=1&amp;pagesize=10&amp;host=true&amp;enterprise_project_id=0</pre>
</div>
<div class="section" id="ListCertificates__topic1781000406"><h4 class="sectiontitle">Example Responses</h4><p id="ListCertificates__topic1781000408"><strong id="ListCertificates__topic1781000409">Status code: 200</strong></p>
<p id="ListCertificates__topic1781000410">Request succeeded.</p>
<pre class="screen" id="ListCertificates__topic1781000411">{
"total" : 1,
"items" : [ {
"id" : "dc443ca4f29c4f7e8d4adaf485be317b",
"name" : "demo",
"certificateid" : "dc443ca4f29c4f7e8d4adaf485be317b,",
"certificatename" : "demo,",
"timestamp" : 1643181401751
} ]
}</pre>
</div>
<div class="section" id="ListCertificates__topic1781000412"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCertificates__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListCertificates__topic1781000418"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListCertificates__topic1781000420">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListCertificates__topic1781000422">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCertificates__topic1781000424"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListCertificates__topic1781000426">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListCertificates__topic1781000428">Request succeeded.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000429"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListCertificates__topic1781000431">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListCertificates__topic1781000433">Request failed</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000434"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListCertificates__topic1781000436">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListCertificates__topic1781000438">The token does not have required permissions.</p>
</td>
</tr>
<tr id="ListCertificates__topic1781000439"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListCertificates__topic1781000441">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListCertificates__topic1781000443">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListCertificates__topic1781000444"><h4 class="sectiontitle">Error Codes</h4><p id="ListCertificates__topic1781000446">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Certificate Management</a></div>
</div>
</div>
View Git Blame Copy Permalink