doc-exports/docs/css/api-ref/css_03_0131.html
Zheng, Xiu 99a2d77599 css api 23.5.1 20240520
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com>
Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
2024-06-07 17:47:08 +00:00

158 lines
10 KiB
HTML

<a name="css_03_0131"></a><a name="css_03_0131"></a>
<h1 class="topictitle1">Querying the Certificate List</h1>
<div id="body0000001715677381"><div class="section" id="css_03_0131__section107263106558"><h4 class="sectiontitle">Function</h4><p id="css_03_0131__p1572781014554">This API is used to query the certificate list.</p>
</div>
<div class="section" id="css_03_0131__section11727171055515"><h4 class="sectiontitle">URI</h4><p id="css_03_0131__p13728101095512">GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificates</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0131__table372941075516" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="css_03_0131__row14728131025512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0131__p18729910175511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0131__p1572912108556">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0131__p97301710115511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0131__p1730151045513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0131__row15728171055516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0131__p2073061018557">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0131__p18731161020551">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0131__p157311410155515">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0131__p10731121025510">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
<tr id="css_03_0131__row147286109555"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0131__p1773221035513">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0131__p17732201018550">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0131__p0732191085518">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0131__p16733141085515">ID of the cluster to be queried</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0131__section77332104556"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0131__p16733110115518">None</p>
</div>
<div class="section" id="css_03_0131__section673441017557"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0131__p473421018551"><strong id="css_03_0131__b52796733723810">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0131__response_ListElbCertResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameter</caption><thead align="left"><tr id="css_03_0131__row12734191015514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0131__p97362102552">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0131__p7736101045517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0131__p87361410105513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0131__row5735191011551"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0131__p1273715105558">certificates</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0131__p273781017553"><a href="#css_03_0131__response_CertificatesResource">CertificatesResource</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0131__p173791015558">Certificate list information</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="css_03_0131__response_CertificatesResource"></a><a name="response_CertificatesResource"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0131__response_CertificatesResource" frame="border" border="1" rules="all"><caption><b>Table 3 </b>CertificatesResource</caption><thead align="left"><tr id="css_03_0131__row7738191012558"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0131__p157395109557">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0131__p15739111045512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="css_03_0131__p7739171015514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0131__row9738101018552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0131__p5739171017551">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0131__p1974021019554">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0131__p9740121055516">Certificate ID</p>
</td>
</tr>
<tr id="css_03_0131__row17738110115519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0131__p2740110145519">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0131__p6740810125516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0131__p874041005517">Certificate name</p>
</td>
</tr>
<tr id="css_03_0131__row273815100557"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0131__p177411210115519">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0131__p147415107556">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0131__p1574118105556">SL certificate type. The value can be <strong id="css_03_0131__b632010165916">server</strong> (server certificate) or <strong id="css_03_0131__b1014581215916">client</strong> (CA certificates).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0131__section1474101019551"><h4 class="sectiontitle">Request Example</h4><p id="css_03_0131__p874241013557">None</p>
</div>
<div class="section" id="css_03_0131__section1574291019557"><h4 class="sectiontitle">Response Example</h4><p id="css_03_0131__p1074218107559"><strong id="css_03_0131__b93763615523810">Status code: 200</strong></p>
<p id="css_03_0131__p87421910145519">The request is processed successfully.</p>
<pre class="screen" id="css_03_0131__screen1074361045511">{
"certificates" : [ {
"id" : "8c415d2e2f4c4fdbbfc9c21c98d7832b",
"name" : "server1",
"type" : "server"
}, {
"id" : "8c415d2e2f4c4fdbbfc9c21c98d7832b",
"name" : "ca1",
"type" : "client"
}, {
"id" : "8c415d2e2f4c4fdbbfc9c21c98d7832b",
"name" : "server-css",
"type" : "server"
} ]
}</pre>
</div>
<div class="section" id="css_03_0131__section1174513105554"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0131__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0131__row3746910145514"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0131__p4747191011556">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="css_03_0131__p16747110115515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0131__row1574611011554"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0131__p14748181015550">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0131__p177488107551">The request is processed successfully.</p>
</td>
</tr>
<tr id="css_03_0131__row14746710105519"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0131__p27481210105514">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0131__p15748121075511">Invalid request.</p>
<p id="css_03_0131__p474816104558">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0131__row12746510195514"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0131__p1774971045515">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0131__p15749111005519">The request cannot be processed due to a conflict.</p>
<p id="css_03_0131__p5749111015550">This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.</p>
</td>
</tr>
<tr id="css_03_0131__row14746101010552"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0131__p18750410185519">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0131__p275031019552">The server does not meet one of the requirements that the requester puts on the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0131__section7750111011559"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0131__p16750141010558">See <a href="css_03_0076.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0125.html">Load Balancing</a></div>
</div>
</div>