yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
e82406468bd497b1c8ef7a5c19ffae22c3972298
doc-exports/docs/dcs/api-ref/ShowInstanceSSLDetail.html
chenjunjie 63188fad94 DCS API 20240705 version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>
2025-03-17 15:42:06 +00:00

239 lines
17 KiB
HTML
Raw Blame History

<a name="ShowInstanceSSLDetail"></a><a name="ShowInstanceSSLDetail"></a>
<h1 class="topictitle1">Querying SSL Encryption of an Instance</h1>
<div id="body1708331107508"><div class="section" id="ShowInstanceSSLDetail__section15991617175613"><h4 class="sectiontitle">Function</h4><p id="ShowInstanceSSLDetail__p2991121785612">This API is used to query SSL encryption of an instance. This API is only supported by DCS Redis 6.0/7.0 instances.</p>
</div>
<div class="section" id="ShowInstanceSSLDetail__section129911177567"><h4 class="sectiontitle">URI</h4><p id="ShowInstanceSSLDetail__p139921517135618">GET /v2/{project_id}/instances/{instance_id}/ssl</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceSSLDetail__table13993151717569" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowInstanceSSLDetail__row129921017135618"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowInstanceSSLDetail__p799391711562">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowInstanceSSLDetail__p1699371716563">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowInstanceSSLDetail__p1599351725610">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowInstanceSSLDetail__p7993191714563">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowInstanceSSLDetail__row99929179569"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowInstanceSSLDetail__p18994111725611">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowInstanceSSLDetail__p9994101713562">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowInstanceSSLDetail__p79947176569">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowInstanceSSLDetail__p1099441710566">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row7992201715569"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowInstanceSSLDetail__p159941117145610">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowInstanceSSLDetail__p1994017195618">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowInstanceSSLDetail__p1699461710561">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowInstanceSSLDetail__p159951717185620">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowInstanceSSLDetail__section17995101716566"><h4 class="sectiontitle">Request Parameters</h4><p id="ShowInstanceSSLDetail__p49951117105610">None</p>
</div>
<div class="section" id="ShowInstanceSSLDetail__section8995101735613"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowInstanceSSLDetail__p19995101716562"><strong id="ShowInstanceSSLDetail__b1699551715616">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceSSLDetail__response_SSLDetailResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ShowInstanceSSLDetail__row999619173566"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowInstanceSSLDetail__p6996131735610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowInstanceSSLDetail__p8996151715568">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowInstanceSSLDetail__p1699610175562">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowInstanceSSLDetail__row1499651719563"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowInstanceSSLDetail__p2099714175562">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowInstanceSSLDetail__p159971517165612">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowInstanceSSLDetail__p999701719562">This parameter is returned with <strong id="ShowInstanceSSLDetail__b4997141775612">true</strong> only when SSL is enabled for the instance.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row399610175568"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowInstanceSSLDetail__p59973177569">ip</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowInstanceSSLDetail__p119971517125616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowInstanceSSLDetail__p1999761710568">IPv4 address used when SSL is enabled.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row2981712165914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowInstanceSSLDetail__p1981112195911">ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowInstanceSSLDetail__p169811215590">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowInstanceSSLDetail__p5981112105914">IPv6 address used when SSL is enabled.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row3996217125613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowInstanceSSLDetail__p99971517185615">port</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowInstanceSSLDetail__p2099871765616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowInstanceSSLDetail__p1998217155611">Port used when SSL is enabled.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row1299616177569"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowInstanceSSLDetail__p0998117135610">domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowInstanceSSLDetail__p5998161719569">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowInstanceSSLDetail__p1099831735618">Domain name used when SSL is enabled.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row1899613178569"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowInstanceSSLDetail__p099871755620">ssl_expired_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowInstanceSSLDetail__p16998121718563">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowInstanceSSLDetail__p1199881719564">SSL certificate validity period (UTC time).</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row99961717145613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowInstanceSSLDetail__p799913175562">ssl_validated</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowInstanceSSLDetail__p19999717185611">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowInstanceSSLDetail__p1699951710565">Whether the SSL certificate is valid.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowInstanceSSLDetail__p139996174567"><strong id="ShowInstanceSSLDetail__b199996173561">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceSSLDetail__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowInstanceSSLDetail__row8999817115616"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowInstanceSSLDetail__p0091855610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowInstanceSSLDetail__p1071813569">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowInstanceSSLDetail__p17017189567">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowInstanceSSLDetail__row8999141712565"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowInstanceSSLDetail__p209184568">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowInstanceSSLDetail__p14091815616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowInstanceSSLDetail__p120118155617">Error message.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row89991417125612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowInstanceSSLDetail__p140318195613">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowInstanceSSLDetail__p31718195613">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowInstanceSSLDetail__p21191819566">Error code.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row9999817125615"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowInstanceSSLDetail__p19161805616">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowInstanceSSLDetail__p10161816567">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowInstanceSSLDetail__p1916189563">Extended error information. This parameter is not used currently and is set to <strong id="ShowInstanceSSLDetail__b8111187563">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowInstanceSSLDetail__p5113189563"><strong id="ShowInstanceSSLDetail__b17217181565">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceSSLDetail__table42111814566" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowInstanceSSLDetail__row18291835616"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="ShowInstanceSSLDetail__p8261814564">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="ShowInstanceSSLDetail__p13319182565">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="ShowInstanceSSLDetail__p193141895611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowInstanceSSLDetail__row152101814568"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowInstanceSSLDetail__p4320188564">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowInstanceSSLDetail__p33151875620">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowInstanceSSLDetail__p12391817569">Error message.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row329187563"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowInstanceSSLDetail__p335187564">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowInstanceSSLDetail__p203101810563">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowInstanceSSLDetail__p34918145618">Error code.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row192161816562"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowInstanceSSLDetail__p15491811564">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowInstanceSSLDetail__p24171855614">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowInstanceSSLDetail__p24518185611">Extended error information. This parameter is not used currently and is set to <strong id="ShowInstanceSSLDetail__b194151820563">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowInstanceSSLDetail__section18431825615"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ShowInstanceSSLDetail__screen115181820561">GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/ssl</pre>
</div>
<div class="section" id="ShowInstanceSSLDetail__section18521815566"><h4 class="sectiontitle">Example Responses</h4><p id="ShowInstanceSSLDetail__p9518182568"><strong id="ShowInstanceSSLDetail__b105101814565">Status code: 200</strong></p>
<p id="ShowInstanceSSLDetail__p85718105618">Instance SSL queried successfully.</p>
<pre class="screen" id="ShowInstanceSSLDetail__screen10517186562">{
"enabled" : true,
"ip" : "192.168.0.5",
"ipv6" : "::1",
"port" : "6379",
"domain_name" : "redis-553a2516-b865-4159-b774-204dc0a36e37.dcs.example.com:6379",
"ssl_expired_at" : "2022-06-15T02:21:18.669Z",
"ssl_validated" : true
}</pre>
<p id="ShowInstanceSSLDetail__p19661820562"><strong id="ShowInstanceSSLDetail__b161618165616">Status code: 400</strong></p>
<p id="ShowInstanceSSLDetail__p1461718105619">Invalid request.</p>
<pre class="screen" id="ShowInstanceSSLDetail__screen126418135612">{
"error_code" : "DCS.4201",
"error_msg" : "Do not support SSL."
}</pre>
<p id="ShowInstanceSSLDetail__p187518185616"><strong id="ShowInstanceSSLDetail__b187218105614">Status code: 500</strong></p>
<p id="ShowInstanceSSLDetail__p1871518175612">Internal service error.</p>
<pre class="screen" id="ShowInstanceSSLDetail__screen19714183561">{
"error_code" : "DCS.5010",
"error_msg" : "Failed to operate SSL in database."
}</pre>
</div>
<div class="section" id="ShowInstanceSSLDetail__section1577181565"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowInstanceSSLDetail__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowInstanceSSLDetail__row198151865614"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowInstanceSSLDetail__p98191819568">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowInstanceSSLDetail__p68121805614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowInstanceSSLDetail__row17821855613"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowInstanceSSLDetail__p4831815613">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowInstanceSSLDetail__p29518145617">Instance SSL queried successfully.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row581518195614"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowInstanceSSLDetail__p095185561">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowInstanceSSLDetail__p129518155615">No SSL info.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row17891885615"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowInstanceSSLDetail__p199618185616">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowInstanceSSLDetail__p791618135615">Invalid request.</p>
</td>
</tr>
<tr id="ShowInstanceSSLDetail__row12861815611"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowInstanceSSLDetail__p1191118145617">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowInstanceSSLDetail__p510111895610">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowInstanceSSLDetail__section71013188564"><h4 class="sectiontitle">Error Codes</h4><p id="ShowInstanceSSLDetail__p181081813562">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="NetworkSecurityManagement.html">Network Security</a></div>
</div>
</div>
View Git Blame Copy Permalink