doc-exports/docs/css/api-ref/css_03_0131.html
Wuwan, Qi 8675132585 CSS API 23.2.1 20230926
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
2023-10-23 09:34:01 +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__section048219337718"><h4 class="sectiontitle">Function</h4><p id="css_03_0131__p174833331471">This API is used to query the certificate list.</p>
</div>
<div class="section" id="css_03_0131__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="css_03_0131__p184842333716">GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificates</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0131__table8485193314720" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0131__row104844331376"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0131__p1348518331977">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__p548615331679">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__p1648613339714">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__p34869331278">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0131__row14856331478"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0131__p04875331677">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__p1148773313718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0131__p1248713331713">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0131__p12487153317715">Project ID. For details about how to obtain the project ID and name, see <a href="css_03_0071.html">Obtaining the Project ID and Name</a>.</p>
</td>
</tr>
<tr id="css_03_0131__row184851033271"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0131__p44887331074">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__p3488833770">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0131__p5488173313715">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0131__p848853320713">ID of the cluster you want to query</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0131__section174894337719"><h4 class="sectiontitle">Request Parameters</h4><p id="css_03_0131__p2048973310714">None</p>
</div>
<div class="section" id="css_03_0131__section84891333471"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0131__p18489733677"><strong id="css_03_0131__b34898337714">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 parameters</caption><thead align="left"><tr id="css_03_0131__row049013331672"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0131__p2049117331977">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__p2491163311713">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__p1491113319713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0131__row149011331672"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0131__p204911233276">certificates</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0131__p19492183314713"><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__p15492183310715">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__row154922330719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0131__p14931533772">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__p1449410331174">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__p104945333711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0131__row349263318719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0131__p7495143312714">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0131__p54956338715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0131__p249543316719">Certificate ID</p>
</td>
</tr>
<tr id="css_03_0131__row11492123313717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0131__p18495193310712">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0131__p749619334714">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0131__p949653317715">Certificate name</p>
</td>
</tr>
<tr id="css_03_0131__row7493183312714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0131__p1049618331978">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0131__p134961733571">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0131__p6497133318711">Type of the SL certificate. The value can be <strong id="css_03_0131__b174971333710">server</strong> or <strong id="css_03_0131__b74971332717">client</strong>. <strong id="css_03_0131__b1749717331670">server</strong> indicates server certificates, and <strong id="css_03_0131__b74971033372">client</strong> indicates CA certificates.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0131__section1849718339712"><h4 class="sectiontitle">Example Requests</h4><p id="css_03_0131__p349714338711">None</p>
</div>
<div class="section" id="css_03_0131__section8497183315715"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0131__p14989338719"><strong id="css_03_0131__b249811330719">Status code: 200</strong></p>
<p id="css_03_0131__p164981933876">Request succeeded.</p>
<pre class="screen" id="css_03_0131__screen194991332718">{
"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__section115091033477"><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__row155105338715"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0131__p1951117335711">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__p351113331576">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0131__row1951018338715"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0131__p951118331675">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0131__p1751163312718">Request succeeded.</p>
</td>
</tr>
<tr id="css_03_0131__row451016331272"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0131__p175123337714">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0131__p8513633173">Invalid request.</p>
<p id="css_03_0131__p1851311331479">Modify the request instead of retrying.</p>
</td>
</tr>
<tr id="css_03_0131__row751012334718"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0131__p351363319718">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0131__p1551315330712">The request cannot be processed due to a conflict.</p>
<p id="css_03_0131__p1851414330718">This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.</p>
</td>
</tr>
<tr id="css_03_0131__row1510123310716"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0131__p75141333573">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0131__p14514173320717">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__section8514153313716"><h4 class="sectiontitle">Error Codes</h4><p id="css_03_0131__p7515733872">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>