lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dcs/api-ref/dcs-api-0312005.html
Chen, Junjie 5e34f6ce26 DCS API-REF Initial Version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2022-12-09 16:44:56 +00:00

732 lines
56 KiB
HTML
Raw Permalink Blame History

<a name="dcs-api-0312005"></a><a name="dcs-api-0312005"></a>
<h1 class="topictitle1">Querying a DCS Instance</h1>
<div id="body10543355"><div class="section" id="dcs-api-0312005__section159181355213"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312005__p168385389118">This API is used to query the details about a specified DCS instance.</p>
</div>
<div class="section" id="dcs-api-0312005__section1522918159341"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312005__p119971881639">GET /v1.0/{project_id}/instances/{instance_id}</p>
<div class="p" id="dcs-api-0312005__p1357023611345"><a href="#dcs-api-0312005__table374812348341">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="dcs-api-0312005__table374812348341"></a><a name="table374812348341"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312005__table374812348341" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312005__row474713417340"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312005__p6747173433414">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312005__p274718343343">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312005__p19747183419347">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312005__p1674783493418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312005__row27471534143414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312005__p147471934113411">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312005__p074763423420">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312005__p67471934133414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312005__p9747934143417">For details on how to obtain the value of this parameter, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row97485345347"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312005__p6747734133415">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312005__p2074783418343">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312005__p37471234153412">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312005__p97482340341">ID of the instance to be queried</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="dcs-api-0312005__section229211578341"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312005__p35711464512"><strong id="dcs-api-0312005__b10963203041319">Request parameters</strong></p>
<p id="dcs-api-0312005__p6572860513">None</p>
<p id="dcs-api-0312005__p457236652"><strong id="dcs-api-0312005__b1046311381414">Example request</strong></p>
<p id="dcs-api-0312005__p155721268514">Request URL:</p>
<pre class="screen" id="dcs-api-0312005__screen777212214167">GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}</pre>
</div>
<div class="section" id="dcs-api-0312005__section9961121793517"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312005__p577010177712"><strong id="dcs-api-0312005__b156813186394">Response parameters</strong></p>
<p class="msonormal" id="dcs-api-0312005__p735917443347"><a href="#dcs-api-0312005__table1257921310816">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="dcs-api-0312005__table1257921310816"></a><a name="table1257921310816"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312005__table1257921310816" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312005__row1257912134819"><th align="left" class="cellrowborder" valign="top" width="22.484848484848484%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312005__p145791113689">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.080808080808083%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312005__p95791013283">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.43434343434344%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312005__p105797137811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312005__row454214964417"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p96664013456">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1866616064514">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p146661905459">DCS instance name.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row16661191012456"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p31401820194511">engine</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p14140120144512">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p2140720144511">DCS instance engine.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row515034414458"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p4738115815451">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p2083117322329">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1973914586454">DCS instance cache capacity. Unit: GB.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1319329466"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1492572218460">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p492517223465">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p489187165218">IP address for connecting to the DCS instance For a cluster instance, multiple IP addresses are returned and separated by commas (,). For example, 192.168.0.1,192.168.0.2.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1754415453418"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1654515418342">domainName</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1349412892616">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p249408182611">Domain name of the instance.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row12545654103410"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p18925182216466">port</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p20925522184612">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p17925522144612">Port number of the cache node.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row11545854183410"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p105235444610">status</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p8521754104614">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p7521754164619">Cache instance status. For details about status, see <a href="dcs-api-0312047.html">DCS Instance Statuses</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row15347152174620"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1919810420457">libos</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p191989410452">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><ul id="dcs-api-0312005__ul01995420451"><li id="dcs-api-0312005__li12199244453"><strong id="dcs-api-0312005__b202793814514199">true</strong>: This instance is a libos instance.</li><li id="dcs-api-0312005__li619911404518"><strong id="dcs-api-0312005__b81551579245">false</strong>: This instance is not a libos instance.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312005__row1960517295472"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p16216144064712">description</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p121634094714">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p221612408473">Brief description of the DCS instance.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row20965121211366"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p3583191317818">max_memory</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p35844135810">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p43202563142827">Total memory size.</p>
<p id="dcs-api-0312005__p56041229105916">Unit: MB.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row59651212143618"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1258418132082">used_memory</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p2584613482">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p64428528142829">Size of the used memory.</p>
<p id="dcs-api-0312005__p19605229135918">Unit: MB.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row2057920131686"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p757915131680">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p165796132817">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p2057913134814">DCS instance ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row357971310814"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1945118112497">resource_spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p19451191111493">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p154521311174912">Resource specifications.</p>
<p id="dcs-api-0312005__p726125315223">For example:</p>
<ul id="dcs-api-0312005__ul15897813419"><li id="dcs-api-0312005__li158958194117"><strong id="dcs-api-0312005__b3157833622">dcs.single_node</strong>: indicates a DCS instance in single-node mode.</li><li id="dcs-api-0312005__li18686191116415"><strong id="dcs-api-0312005__b13392536624">dcs.master_standby</strong>: indicates a DCS instance in master/standby mode.</li><li id="dcs-api-0312005__li162344350511"><strong id="dcs-api-0312005__b71349391523">dcs.cluster</strong>: indicates a DCS instance in cluster mode.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312005__row135804131482"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p3953113011492">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p149531930194915">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1695333094918">Cache engine version.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row19580101316810"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1895313303498">internal_version</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1595373054910">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p10954183034917">Internal DCS version.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row165801713282"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p69547300496">charging_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p17954173012494">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p39546309494">Billing mode. <strong id="dcs-api-0312005__b1693649608141417">0</strong>: pay-per-use.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1690295613612"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1190235616366">capacity_minor</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p9902056103616">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p16903105617368">Cache capacity of a small-scale, single-node DCS instance.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row2058020131089"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p152971744104917">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1129874410491">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p629894418498">VPC ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1758171317816"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p172982440497">vpc_name</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p229864413499">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p19299344184918">VPC name.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row88105517491"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1549357195017">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p949414713501">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p5420602914282">Time at which the DCS instance is created.</p>
<p id="dcs-api-0312005__p46051629195914">For example, 2017-03-31<strong id="dcs-api-0312005__b84850841164">T</strong>12:24:46.297<strong id="dcs-api-0312005__b92569001164">Z</strong>.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row557215250506"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p879125715508">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1379105735016">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p37271648142755">Error code returned when the DCS instance fails to be created or is abnormal.</p>
<p id="dcs-api-0312005__p1605182919594">For details about error codes, see <a href="dcs-api-0312044.html">Error Codes</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row327374913711"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p45920101386">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p115913108389">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p35931013389">User ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row32741349183713"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p612717160389">user_name</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p191275169385">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1412731683814">Username.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row67495272384"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p13545101053910">maintain_begin</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p354520108395">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p28444466142849">Time at which the maintenance time window starts.</p>
<p id="dcs-api-0312005__p4605182945911">Format: hh:mm:ss.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row107502272383"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p654621033913">maintain_end</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p125461810203910">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p66913287142854">Time at which the maintenance time window ends.</p>
<p id="dcs-api-0312005__p760542917593">Format: hh:mm:ss.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row587265193812"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p20912187469">no_password_access</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p7961894611">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p159121810469">An indicator of whether a DCS instance can be accessed in password-free mode.</p>
<ul id="dcs-api-0312005__ul69161804618"><li id="dcs-api-0312005__li29118144619"><strong id="dcs-api-0312005__b101615320389">true</strong>: indicates that a DCS instance can be accessed without a password.</li><li id="dcs-api-0312005__li9911184464"><strong id="dcs-api-0312005__b1393475883819">false</strong>: indicates that a DCS instance can be accessed only after password authentication.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312005__row15872175110382"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p104233584611">access_user</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p642163504620">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p54293513464">Username used for accessing a DCS instance with password authentication.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row287225119387"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p6822171513382">enable_publicip</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p2822161519380">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p158231415163813">An indicator of whether public access is enabled for a DCS Redis instance. Options:</p>
<ul id="dcs-api-0312005__ul8823415143810"><li id="dcs-api-0312005__li882319151389"><strong id="dcs-api-0312005__b492419185376">true</strong>: enabled.</li><li id="dcs-api-0312005__li1582351553816"><strong id="dcs-api-0312005__b118764674314174">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312005__row123497206397"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p054485710450">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p4544135734519">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p2544165734514">ID of the elastic IP address bound to a DCS Redis instance.</p>
<p id="dcs-api-0312005__p11544185754519">The parameter value is <strong id="dcs-api-0312005__b10719165320387">null</strong> if public access is disabled.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row153501720183911"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p204384427459">publicip_address</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p134381542144519">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p343834204511">Elastic IP address bound to a DCS Redis instance.</p>
<p id="dcs-api-0312005__p18438104214452">The parameter value is <strong id="dcs-api-0312005__b010313801513">null</strong> if public access is disabled.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row83501520153920"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p10350320193918">enable_ssl</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p18350152015393">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p125521036125811">An indicator of whether to enable SSL for public access to a DCS Redis instance.</p>
<ul id="dcs-api-0312005__ul55521036185811"><li id="dcs-api-0312005__li055253620588"><strong id="dcs-api-0312005__b17747143010380">true</strong>: enabled.</li><li id="dcs-api-0312005__li17552113695817"><strong id="dcs-api-0312005__b1066833415386">false</strong>: disabled.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312005__row17736134711399"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p6737154712399">service_upgrade</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p182521050113419">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p7253125013415">An indicator of whether an upgrade task has been created for a DCS instance.</p>
<ul id="dcs-api-0312005__ul249561864113"><li id="dcs-api-0312005__li124981118194112"><strong id="dcs-api-0312005__b11358812194113">true</strong>: yes.</li><li id="dcs-api-0312005__li150316188419"><strong id="dcs-api-0312005__b169091618416">false</strong>: no.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312005__row773734712394"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p27371747143918">service_task_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p387120528342">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1787112522346">Upgrade task ID.</p>
<ul id="dcs-api-0312005__ul169679916444"><li id="dcs-api-0312005__li149672096440">If the value of <strong id="dcs-api-0312005__b246813262425">service_upgrade</strong> is set to <strong id="dcs-api-0312005__b164687267426">true</strong>, the value of this parameter is the ID of the upgrade task.</li><li id="dcs-api-0312005__li16967189154416">If the value of <strong id="dcs-api-0312005__b10381123764219">service_upgrade</strong> is set to <strong id="dcs-api-0312005__b1338153717429">false</strong>, the value of this parameter is empty.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312005__row16737144703911"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p173794718395">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1673774743916">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p185862316286">Enterprise project ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row340217117401"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p11402101110409">product_type</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p119811190343">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1898112198347">Edition of DCS for Redis. Options:</p>
<ul id="dcs-api-0312005__ul410913438490"><li id="dcs-api-0312005__li1109443114918"><strong id="dcs-api-0312005__b13688846179">generic</strong>: standard edition</li><li id="dcs-api-0312005__li11091843154913"><strong id="dcs-api-0312005__b87948476">libos</strong>: high-performance edition</li></ul>
</td>
</tr>
<tr id="dcs-api-0312005__row164029118408"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1840291184015">cpu_type</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p49811719103414">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p109817194340">CPU architecture. Options: <strong id="dcs-api-0312005__b13450251078">x86_64</strong> and <strong id="dcs-api-0312005__b1045135110711">aarch_64</strong>.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row174023112409"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p240391119408">storage_type</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p10247256193411">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1024735612348">Memory type. Options: <strong id="dcs-api-0312005__b440113540710">DRAM</strong> and <strong id="dcs-api-0312005__b144028541377">SCM</strong>.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row151972416405"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p17197174154017">cache_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p7981161915341">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p9981161933414">DCS instance type. Options:</p>
<ul id="dcs-api-0312005__ul710514217427"><li id="dcs-api-0312005__li710518217426"><strong id="dcs-api-0312005__b380093713710">single</strong>: single-node</li><li id="dcs-api-0312005__li19105172174210"><strong id="dcs-api-0312005__b33395398720">ha</strong>: master/standby</li><li id="dcs-api-0312005__li111051821194216"><strong id="dcs-api-0312005__b71446401576">cluster</strong>: Redis Cluster</li><li id="dcs-api-0312005__li4105142114219"><strong id="dcs-api-0312005__b209021403711">proxy</strong>: Proxy Cluster</li></ul>
</td>
</tr>
<tr id="dcs-api-0312005__row8197114104014"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p7197164111408">launched_at</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p2197341174016">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p519774154014">Time when the instance started running.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row2123192024114"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p4583181319816">available_zones</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1583161314820">Array</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p11583161312820">AZ where a cache node resides. The value of this parameter in the response contains an AZ ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row312317204414"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p205821013680">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p135827139811">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p358212136818">Subnet ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1912472014414"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p2582913185">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p185823135811">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p35821513888">Security group ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1612492064110"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p694551810489">backend_addrs</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p199451518134816">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p15945201816484">Backend address of a cluster instance.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row152111528134220"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1521102884210">cloud_service_type_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p82801867362">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p12278864360">Cloud service type code.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row202119287424"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p22111728194210">cloud_resource_type_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p152351411163611">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1023511133614">Cloud resource type code.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row135816131388"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p958121319811">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p358111310810">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1758114130820">Product ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row55821713384"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p11582151310813">security_group_name</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p25821513486">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1458214131886">Security group name.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1758218135812"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p165829131586">subnet_name</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p458215131587">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p175823131280">Subnet name.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row206871758182115"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p170935112019">subnet_cidr</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1070915513017">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p37106513011">Subnet segment.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row11582513288"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1189611221388">order_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p6896102212381">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p16896162233813">Order ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1374145316544"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p10126119554">instance_backup_policy</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1612517556">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p22014154142838">Backup policy.</p>
<p id="dcs-api-0312005__p160592914596">This parameter is available for master/standby and cluster DCS instances. For details, see <a href="#dcs-api-0312005__table16210754181112">Table 3</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1257112316457"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1367114611379">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p667117643717">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p46710613371">Instance tag key and value.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1777818117321"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p4780111173215">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p578021193220">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1478010118326">Product specification code.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row83251133143514"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p032573373512">domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p16325183353520">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p10325233143517">Domain name of the instance.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row16948113719363"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p109489378367">readonlyDomainName</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p11948937123616">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p20930238523">Read-only domain name.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row6636114293620"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1563674216366">readonly_domain_name</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p196371642183611">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p5637134233617">Read-only domain name.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row129654203711"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p173035420371">freeze_scene</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1330195416377">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p93055413720">Scenario where the instance is frozen.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row57304481385"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1573034823818">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p9730124803810">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p11730114813386">Update time.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row189361354183816"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p193635413383">task_status</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1893615443816">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p2936125415385">Task status.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row02818223456"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p9286224456">is_free</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p82972211458">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p52982210456">Whether the instance is free of charge.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row13329574572"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p143375719579">az_codes</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p833145710572"><span style="color:#252B3A;">Array of strings</span></p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p63335735719">AZs with available resources.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row5586191019581"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p18587191013581">crr_role</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p158781065816">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1158711055815">Role in cross-region DR.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row6478104212594"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1547884220599">inquery_spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p18478134216591">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p7478144210594">Product specification code.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row98933281812"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1889318281418">support_slow_log_flag</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p168931528719">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p118931282011">Whether slow query logs are supported.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row148311457219"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p54831145228">ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p1448312451023">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p5483204511211">IPv6 address.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row76597501729"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p2065919506213">enable_ipv6</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p116591950420">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p565917501224">Whether IPv6 is enabled.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1644118145415"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p164421714343">description</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p13442131411412">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p6442101413414">Instance description.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row526811191420"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p112681619845">db_number</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p17268201914410">int</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p526861910414">Number of databases in the instance.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row192991839653"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p330014391750">support_acl</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p113002394511">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p530015393517">Whether ACL is supported.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row124306347510"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p1543012345518">task</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p164301734756">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1943023418512">Task response.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row5592181114109"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p9592161118101">enterprise_project_name</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p859318118104">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p959316111108">Enterprise project name.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row0976815131019"><td class="cellrowborder" valign="top" width="22.484848484848484%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312005__p297619155107">sharding_count</p>
</td>
<td class="cellrowborder" valign="top" width="20.080808080808083%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312005__p17976215191013">int</p>
</td>
<td class="cellrowborder" valign="top" width="57.43434343434344%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312005__p1197621561017">Number of shards.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dcs-api-0312005__table16210754181112"></a><a name="table16210754181112"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312005__table16210754181112" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instance_backup_policy</caption><thead align="left"><tr id="dcs-api-0312005__row182101954121116"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.5.2.4.1.1"><p id="dcs-api-0312005__p2166179151216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.5.2.4.1.2"><p id="dcs-api-0312005__p716612971219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.5.2.4.1.3"><p id="dcs-api-0312005__p1316689191219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312005__row1021112544113"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312005__p132111654131120">backup_policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312005__p1340175017132">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dcs-api-0312005__p1521135416113">Backup policy ID.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1221135451110"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312005__p11211154171116">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312005__p8211554191113">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dcs-api-0312005__p1211145414118">Creation time.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row192111854171119"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312005__p172118545111">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312005__p321135415113">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dcs-api-0312005__p321115414119">Update time.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row15407101711137"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312005__p34077178139">policy</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312005__p0407181712135">Object</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dcs-api-0312005__p16346161417191">For details, see <a href="dcs-api-0312004.html#dcs-api-0312004__table12803218151513">Table 3</a> and <a href="dcs-api-0312004.html#dcs-api-0312004__table187492037201518">Table 4</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312005__row1274461151320"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.1 "><p id="dcs-api-0312005__p3745161114132">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.2 "><p id="dcs-api-0312005__p1574501151313">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.5.2.4.1.3 "><p id="dcs-api-0312005__p147451611191314">Tenant ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p class="msonormal" id="dcs-api-0312005__p497818271774"><strong id="dcs-api-0312005__b81841857171518">Example response</strong></p>
<p id="dcs-api-0312005__p330811316333"></p>
</div>
<pre class="screen" id="dcs-api-0312005__screen127516471439">{
"free":null,
"max_memory":1024,
"used_memory":1,
"instance_id":"f1da146b-f567-411a-a4c2-276fb831ca28",
"name":"Test-DCS-Single-9e210c64",
"resource_spec_code":"redis.single.xu1.large.1",
"spec_code":"redis.single.xu1.large.1",
"engine":"Redis","engine_version":"4.0",
"internal_version":null,
"charging_mode":0,
"capacity":1,
"capacity_minor":null,
"vpc_id":"e5d38406-43ca-447f-9564-90953f10313f",
"vpc_name":"vpc-testing",
"ip":"192.168.1.144",
"domainName":"redis-f1da146b-f567-411a-a4c2-276fb831ca28.dcs.com",
"domain_name":"redis-f1da146b-f567-411a-a4c2-276fb831ca28.dcs.com",
"readonlyDomainName":null,
"readonly_domain_name":null,
"port":6379,
"status":"RUNNING",
"freeze_scene":null,
"created_at":"2021-04-18T18:55:43.509Z",
"update_at":"2021-04-18T18:56:06.519Z",
"error_code":null,
"user_id":"e96cb82994ef49648c2bfad79455b0ef",
"user_name":"lboka",
"maintain_begin":"02:00:00",
"maintain_end":"06:00:00",
"no_password_access":"false",
"access_user":null,
"enable_publicip":false,
"publicip_id":null,
"publicip_address":null,
"enable_ssl":false,
"service_upgrade":false,
"service_task_id":"",
"enterprise_project_id":null,
"security_group_id":null,
"tags":[],
"subnet_id":"a2c02283-2e2d-45f5-a9a0-7a8fb8d0d0a7",
"product_type":"generic",
"cpu_type":"x86_64",
"storage_type":"DRAM",
"task_status":null,
"launched_at":"2021-04-18T18:56:06.532Z",
"is_free":null,
"libos":false,
"cache_mode":"single",
"available_zones":["eu-de-02"],
"az_codes":["eu-de-02"],
"backend_addrs":null,
"crr_role":null,
"cloud_service_type_code":"otc.service.type.dcs",
"cloud_resource_type_code":"otc.resource.type.dcs3",
"inquery_spec_code":"redis.single.xu1.large.1",
"support_slow_log_flag":null,
"ipv6":null,
"enable_ipv6":false,
"description":"robot test-cases",
"db_number":0,
"features":{
"support_acl":true
},
"product_id":"redis.single.xu1.large.1-h",
"security_group_name":null,
"subnet_name":"subnet-testing",
"order_id":null,
"subnet_cidr":"192.168.1.0/24",
"task":null,
"instance_backup_policy":null,
"enterprise_project_name":null,
"sharding_count":0
}</pre>
<div class="section" id="dcs-api-0312005__section18373103889"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312005__p83731231387"><a href="#dcs-api-0312005__table183731131183">Table 4</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
<div class="tablenoborder"><a name="dcs-api-0312005__table183731131183"></a><a name="table183731131183"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312005__table183731131183" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312005__row23747312814"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.6.3.2.3.1.1"><p id="dcs-api-0312005__p123741732818">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.6.3.2.3.1.2"><p id="dcs-api-0312005__p133741337815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312005__row14374732815"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.6.3.2.3.1.1 "><p id="dcs-api-0312005__p4374537817">200</p>
</td>
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.6.3.2.3.1.2 "><p id="dcs-api-0312005__p12374834813">Specified instance queried successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312003.html">Lifecycle Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink