yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
8ea25ba1a206b97024b5057748eada2cdae5b9cb
doc-exports/docs/dws/api-ref/ListClusterSnapshots.html
luhuayi 007dffd756 DWS API 8.5.1_20260108 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: luhuayi <luhuayi@huawei.com>
Co-committed-by: luhuayi <luhuayi@huawei.com>
2026-03-06 08:01:27 +00:00

652 lines
54 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002532014005"></a><a name="EN-US_TOPIC_0000002532014005"></a>
<h1 class="topictitle1">Querying the Cluster Snapshot List</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002532014005__section10607132215918"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002532014005__p860711221916">This API is used to query the cluster snapshot list.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014005__section960718222096"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000002532014005__p11608112218919">For details, see <a href="dws_02_0062.html">Calling APIs</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014005__section260813221398"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002532014005__p1360919228917">GET /v1.0/{project_id}/clusters/{cluster_id}/snapshots</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014005__table660913222098" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014005__row116091622994"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002532014005__p26105221793">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000002532014005__p16610132215913">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000002532014005__p361012210915">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000002532014005__p061112221598">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014005__row1160982212917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014005__p36111222194">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014005__p66115221096">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014005__p261292212914">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014005__p161217227912"><strong id="EN-US_TOPIC_0000002532014005__b76131822992">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p8613162215911">Project ID. To obtain the value, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
<p id="EN-US_TOPIC_0000002532014005__p3613722897"><strong id="EN-US_TOPIC_0000002532014005__b156137221294">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p186142022195">N/A</p>
<p id="EN-US_TOPIC_0000002532014005__p16141122492"><strong id="EN-US_TOPIC_0000002532014005__b1261422217910">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p2061412219913">N/A</p>
<p id="EN-US_TOPIC_0000002532014005__p161432211917"><strong id="EN-US_TOPIC_0000002532014005__b8615162218917">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1361515227910">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row206098222096"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014005__p161515221097">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014005__p361514221795">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014005__p6616182212916">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014005__p661612226917"><strong id="EN-US_TOPIC_0000002532014005__b146171225919">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p46172227913">Cluster ID. For details about how to obtain the value, see <a href="dws_02_00068.html">Obtaining the Cluster ID</a>.</p>
<p id="EN-US_TOPIC_0000002532014005__p76171022494"><strong id="EN-US_TOPIC_0000002532014005__b1461742217915">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1961717221593">The value must be a valid DWS cluster ID.</p>
<p id="EN-US_TOPIC_0000002532014005__p116181022691"><strong id="EN-US_TOPIC_0000002532014005__b196180221891">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p36181222692">It is a 36-digit UUID.</p>
<p id="EN-US_TOPIC_0000002532014005__p1961816225911"><strong id="EN-US_TOPIC_0000002532014005__b1961814227912">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p66186227910">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014005__table16191422695" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014005__row1061913221398"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000002532014005__p36204221096">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000002532014005__p10620172218919">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000002532014005__p962014221891">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000002532014005__p46218229915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014005__row176191522493"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1862117221895">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014005__p16621102213913">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014005__p2622182218913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014005__p362211229917"><strong id="EN-US_TOPIC_0000002532014005__b36221223914">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p15623132212915">Size of a single page.</p>
<p id="EN-US_TOPIC_0000002532014005__p7623142215911"><strong id="EN-US_TOPIC_0000002532014005__b162312229920">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p862320221799">N/A</p>
<p id="EN-US_TOPIC_0000002532014005__p16623112212914"><strong id="EN-US_TOPIC_0000002532014005__b662318221891">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p462311221391">Greater than 0</p>
<p id="EN-US_TOPIC_0000002532014005__p362412214913"><strong id="EN-US_TOPIC_0000002532014005__b46248220910">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1262420221099">No limit.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row161919228910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014005__p186244221994">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014005__p4625622397">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014005__p962520221693">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014005__p13626162210914"><strong id="EN-US_TOPIC_0000002532014005__b1562610221191">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p176264221991">Page offset, which starts from 0 (page number minus 1).</p>
<p id="EN-US_TOPIC_0000002532014005__p862618221191"><strong id="EN-US_TOPIC_0000002532014005__b136261422392">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p962615221998">N/A</p>
<p id="EN-US_TOPIC_0000002532014005__p56276221899"><strong id="EN-US_TOPIC_0000002532014005__b146271122595">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1362712221795">Greater than or equal to <strong id="EN-US_TOPIC_0000002532014005__b862718227917">0</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1062719221095"><strong id="EN-US_TOPIC_0000002532014005__b16287221495">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1762872220916">0</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row19619322098"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014005__p46280221299">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014005__p76290225911">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014005__p56295221197">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014005__p186301222299"><strong id="EN-US_TOPIC_0000002532014005__b11630222598">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p663013224915">Sorting field.</p>
<p id="EN-US_TOPIC_0000002532014005__p96301622791"><strong id="EN-US_TOPIC_0000002532014005__b116300221913">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p46315221395">N/A</p>
<p id="EN-US_TOPIC_0000002532014005__p136314221996"><strong id="EN-US_TOPIC_0000002532014005__b66314221398">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1463112223913">N/A</p>
<p id="EN-US_TOPIC_0000002532014005__p56315228918"><strong id="EN-US_TOPIC_0000002532014005__b963142210918">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1863212214911">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row9619522191"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014005__p163232211913">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014005__p16632182213916">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1663342216917">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014005__p06331228918"><strong id="EN-US_TOPIC_0000002532014005__b156331022896">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p963412222916">Sorting rule.</p>
<p id="EN-US_TOPIC_0000002532014005__p86341422593"><strong id="EN-US_TOPIC_0000002532014005__b9634152210910">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p26347224917">N/A</p>
<p id="EN-US_TOPIC_0000002532014005__p1563414221596"><strong id="EN-US_TOPIC_0000002532014005__b46341722596">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p116351422290"><strong id="EN-US_TOPIC_0000002532014005__b11635152218913">asc</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p56358221298"><strong id="EN-US_TOPIC_0000002532014005__b156357228910">desc</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p163532220915"><strong id="EN-US_TOPIC_0000002532014005__b763514221396">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p11635132210919">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014005__section1563612211910"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000002532014005__p136367221697">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014005__section116362229911"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002532014005__p1663752213913"><strong id="EN-US_TOPIC_0000002532014005__b1063718225917">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_ClusterListSnapshotsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014005__row6637162213914"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002532014005__p1563817221190">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000002532014005__p863810228916">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000002532014005__p11639112211920">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014005__row263712220916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p5639192210913">snapshots</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p36391222490">Array of <a href="#EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_ClusterSnapshots">ClusterSnapshots</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1164012218915"><strong id="EN-US_TOPIC_0000002532014005__b5640622399">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p7640222391">List of snapshot objects.</p>
<p id="EN-US_TOPIC_0000002532014005__p564011228910"><strong id="EN-US_TOPIC_0000002532014005__b11641142214916">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p206415224917">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row16637022898"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p156417225912">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p2064102213914">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p264272213916"><strong id="EN-US_TOPIC_0000002532014005__b156421222092">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p186421322893">Project ID. To obtain the value, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
<p id="EN-US_TOPIC_0000002532014005__p56435221898"><strong id="EN-US_TOPIC_0000002532014005__b1464314220912">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p106434221694">N/A</p>
<p id="EN-US_TOPIC_0000002532014005__p2643122299"><strong id="EN-US_TOPIC_0000002532014005__b1364322214917">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p136433221196">N/A</p>
<p id="EN-US_TOPIC_0000002532014005__p126444222918"><strong id="EN-US_TOPIC_0000002532014005__b176449228911">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p16444226913">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row363719221791"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1564418221393">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p11645182213911">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p196455221696"><strong id="EN-US_TOPIC_0000002532014005__b106451322793">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1364632220912">Cluster ID.</p>
<p id="EN-US_TOPIC_0000002532014005__p1064610221893"><strong id="EN-US_TOPIC_0000002532014005__b864616221895">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1464612217919">It is a 36-digit UUID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row06371422396"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p19646132220915">count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p166471228918">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p196471722192"><strong id="EN-US_TOPIC_0000002532014005__b76470223910">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p156473225917">Total number of snapshot objects.</p>
<p id="EN-US_TOPIC_0000002532014005__p1864812215911"><strong id="EN-US_TOPIC_0000002532014005__b116489229917">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p36484221910">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_ClusterSnapshots"></a><a name="en-us_topic_0000002375015197_response_ClusterSnapshots"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_ClusterSnapshots" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ClusterSnapshots</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014005__row106499223916"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p id="EN-US_TOPIC_0000002532014005__p96506223912">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.2"><p id="EN-US_TOPIC_0000002532014005__p26515221911">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="EN-US_TOPIC_0000002532014005__p18651182218919">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014005__row10649192215918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p0651202216917">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1765252211918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p66521221498"><strong id="EN-US_TOPIC_0000002532014005__b1765215228917">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1265320222097">Snapshot ID.</p>
<p id="EN-US_TOPIC_0000002532014005__p16531221498"><strong id="EN-US_TOPIC_0000002532014005__b156531221991">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1665314221695">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row1664913221291"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p66533222915">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p565420221297">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p186541222497"><strong id="EN-US_TOPIC_0000002532014005__b11654162215913">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p13654172213919">Snapshot name.</p>
<p id="EN-US_TOPIC_0000002532014005__p46552221890"><strong id="EN-US_TOPIC_0000002532014005__b1265517221897">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p365512221796">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row116498221594"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p176551228913">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1865613221290">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1165672218917"><strong id="EN-US_TOPIC_0000002532014005__b46569228912">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p186561522292">Snapshot description.</p>
<p id="EN-US_TOPIC_0000002532014005__p865718221296"><strong id="EN-US_TOPIC_0000002532014005__b865712229913">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1657142216912">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row1964918221794"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1365717221690">started</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p156578221393">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p96586224920"><strong id="EN-US_TOPIC_0000002532014005__b6658822294">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p065822210911">Snapshot creation time. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ.</p>
<p id="EN-US_TOPIC_0000002532014005__p186585223919"><strong id="EN-US_TOPIC_0000002532014005__b0659322397">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p36590226915">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row664917221890"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p17659202212918">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p206601522699">Double</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p14660132218915"><strong id="EN-US_TOPIC_0000002532014005__b2066018221299">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p2066019221697">Snapshot size, in GB.</p>
<p id="EN-US_TOPIC_0000002532014005__p16615223919"><strong id="EN-US_TOPIC_0000002532014005__b26617222099">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p666113221092">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row1564962217919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p86611226915">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p9661122214910">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1966213223916"><strong id="EN-US_TOPIC_0000002532014005__b266213224919">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p196633227912">Snapshot status.</p>
<ul id="EN-US_TOPIC_0000002532014005__ul209706513914"><li id="EN-US_TOPIC_0000002532014005__li149709512097"><strong id="EN-US_TOPIC_0000002532014005__b06636229918">Range</strong></li><li id="EN-US_TOPIC_0000002532014005__li59709511298"><strong id="EN-US_TOPIC_0000002532014005__b266311221597">CREATING</strong></li><li id="EN-US_TOPIC_0000002532014005__li19970551196"><strong id="EN-US_TOPIC_0000002532014005__b1266382217911">AVAILABLE</strong></li><li id="EN-US_TOPIC_0000002532014005__li7970051995"><strong id="EN-US_TOPIC_0000002532014005__b266412229915">UNAVAILABLE</strong></li><li id="EN-US_TOPIC_0000002532014005__li6970751692"><strong id="EN-US_TOPIC_0000002532014005__b136648229915">RESTORING</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row364962213919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p0665172210920">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p6665522895">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p366592215916"><strong id="EN-US_TOPIC_0000002532014005__b116655227920">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p2066616221998">ID of the cluster for which the snapshot is created.</p>
<p id="EN-US_TOPIC_0000002532014005__p86661822795"><strong id="EN-US_TOPIC_0000002532014005__b66662022499">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p666613221492">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row156495228911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p96662228915">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p4667722794"><a href="#EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_Datastore">Datastore</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p366710226912"><strong id="EN-US_TOPIC_0000002532014005__b8667222197">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1266822213910">Snapshot version.</p>
<p id="EN-US_TOPIC_0000002532014005__p106684221598"><strong id="EN-US_TOPIC_0000002532014005__b666816229914">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p06687221595">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row9649422493"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1066813221798">cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p966914221192">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p96691822398"><strong id="EN-US_TOPIC_0000002532014005__b1666912215920">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p86694221911">Name of the cluster for which the snapshot is created.</p>
<p id="EN-US_TOPIC_0000002532014005__p86706221199"><strong id="EN-US_TOPIC_0000002532014005__b18670172220918">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1867014221913">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row196499221895"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1467012215913">updated</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p18670202219916">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1067122215910"><strong id="EN-US_TOPIC_0000002532014005__b1567172218910">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p176711022994">The time when the snapshot was updated.</p>
<p id="EN-US_TOPIC_0000002532014005__p166712022992"><strong id="EN-US_TOPIC_0000002532014005__b96721622998">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p146721221896">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row564920221494"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p10672522191">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1967218222912">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1567318229918"><strong id="EN-US_TOPIC_0000002532014005__b967320224911">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p14673822397">Snapshot type.</p>
<p id="EN-US_TOPIC_0000002532014005__p20673722890"><strong id="EN-US_TOPIC_0000002532014005__b86739221392">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1067418227912"><strong id="EN-US_TOPIC_0000002532014005__b18674132217915">MANUAL</strong>: manual snapshot.</p>
<p id="EN-US_TOPIC_0000002532014005__p267410221790"><strong id="EN-US_TOPIC_0000002532014005__b17675112220914">AUTO</strong>: automatic snapshot.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row146491122899"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p393113221918">bak_expected_start_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p11932422995">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p793219221493"><strong id="EN-US_TOPIC_0000002532014005__b193216228917">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p7932922390">Estimated start time of a snapshot.</p>
<p id="EN-US_TOPIC_0000002532014005__p693216221393"><strong id="EN-US_TOPIC_0000002532014005__b5932142220917">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p49323221091">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row664914222098"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p5932622499">bak_keep_day</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p129327221195">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p9932202219913"><strong id="EN-US_TOPIC_0000002532014005__b3932522693">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p11933142218917">Retention days for a snapshot.</p>
<p id="EN-US_TOPIC_0000002532014005__p993311221599"><strong id="EN-US_TOPIC_0000002532014005__b109337221091">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p493316221991">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row1464962213917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p129331522891">bak_period</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p199335222918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1793310221694"><strong id="EN-US_TOPIC_0000002532014005__b1693315226916">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p5933222596">Snapshot policy.</p>
<p id="EN-US_TOPIC_0000002532014005__p1793317229916"><strong id="EN-US_TOPIC_0000002532014005__b199333225912">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1493314224916">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row126498224915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p139349221396">db_user</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p593420221897">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p17934172216912"><strong id="EN-US_TOPIC_0000002532014005__b1193420221598">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1993414223911">Database user.</p>
<p id="EN-US_TOPIC_0000002532014005__p993418221398"><strong id="EN-US_TOPIC_0000002532014005__b109341022190">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p39340221498">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row16491622492"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p093417222913">progress</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p893410221496">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p139346227915"><strong id="EN-US_TOPIC_0000002532014005__b1493452216915">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p79341221498">Snapshot progress.</p>
<p id="EN-US_TOPIC_0000002532014005__p18935722998"><strong id="EN-US_TOPIC_0000002532014005__b169351722192">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p119351522894">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row26491221197"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p993572211916">backup_key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p15935822498">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1193517221097"><strong id="EN-US_TOPIC_0000002532014005__b093517229917">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p139351922697">Snapshot backup key.</p>
<p id="EN-US_TOPIC_0000002532014005__p11935132216910"><strong id="EN-US_TOPIC_0000002532014005__b4935222891">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1293519221192">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row66491922293"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p14935182214916">prior_backup_key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p3936622897">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p169365227920"><strong id="EN-US_TOPIC_0000002532014005__b5936122093">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1293610224917">Backup key of the previous snapshot used by the incremental backup.</p>
<p id="EN-US_TOPIC_0000002532014005__p139361822797"><strong id="EN-US_TOPIC_0000002532014005__b6936102212917">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p129362223917">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row1164962216913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p793611229913">base_backup_key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1193652211918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p14936192211910"><strong id="EN-US_TOPIC_0000002532014005__b149361722790">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p149364221795">Key of the full snapshot backup.</p>
<p id="EN-US_TOPIC_0000002532014005__p6936182212918"><strong id="EN-US_TOPIC_0000002532014005__b693652214917">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p693711221696">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row11649822593"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1893732216913">backup_device</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1093716221690">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p893716221499"><strong id="EN-US_TOPIC_0000002532014005__b39373221292">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p18937132212916">Backup media.</p>
<p id="EN-US_TOPIC_0000002532014005__p39371222596"><strong id="EN-US_TOPIC_0000002532014005__b29374222910">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p39372221792">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row565019221918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p11937722394">total_backup_size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1993714221992">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p993742217919"><strong id="EN-US_TOPIC_0000002532014005__b193752212913">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p3938922390">Total size of snapshots.</p>
<p id="EN-US_TOPIC_0000002532014005__p69381822392"><strong id="EN-US_TOPIC_0000002532014005__b39381822394">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1393815221594">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row56509226918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p49381221918">base_backup_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p993882210916">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1093817227914"><strong id="EN-US_TOPIC_0000002532014005__b10938172216915">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p99381122991">Name of the full snapshot.</p>
<p id="EN-US_TOPIC_0000002532014005__p19938522797"><strong id="EN-US_TOPIC_0000002532014005__b7938152211916">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p139385224919">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row06506221793"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p49388222912">support_inplace_restore</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p169393221193">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1939152218912"><strong id="EN-US_TOPIC_0000002532014005__b1393918229911">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p179392224911">Whether in-place restoration is supported.</p>
<p id="EN-US_TOPIC_0000002532014005__p693911221495"><strong id="EN-US_TOPIC_0000002532014005__b79399227912">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p5939622493">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row11650622896"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p109391322094">fine_grained_backup</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p13939172215912">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p293952216920"><strong id="EN-US_TOPIC_0000002532014005__b1893952220919">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p39401022093">Whether fine-grained backup is used.</p>
<p id="EN-US_TOPIC_0000002532014005__p1694042220919"><strong id="EN-US_TOPIC_0000002532014005__b89403221293">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p994016225918">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row165082217910"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p194019221094">backup_level</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p2940822799">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p19408222912"><strong id="EN-US_TOPIC_0000002532014005__b5940922297">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1794015228916">Backup level.</p>
<p id="EN-US_TOPIC_0000002532014005__p89407221898"><strong id="EN-US_TOPIC_0000002532014005__b1694082213910">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p12940322499">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row36502221191"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p209402221990">fine_grained_backup_detail</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p109410221913"><a href="#EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_FineGrainedSnapshotDetail">FineGrainedSnapshotDetail</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p1394162219912"><strong id="EN-US_TOPIC_0000002532014005__b179415221796">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p10941172218910">Fine-grained backup information.</p>
<p id="EN-US_TOPIC_0000002532014005__p1294116221199"><strong id="EN-US_TOPIC_0000002532014005__b209411022697">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p39419221193">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row86501522492"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p594113221199">guest_agent_version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p12941102214917">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p2094115221492"><strong id="EN-US_TOPIC_0000002532014005__b1694116225919">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p10941112211914">GuestAgent version.</p>
<p id="EN-US_TOPIC_0000002532014005__p4941722394"><strong id="EN-US_TOPIC_0000002532014005__b2942822694">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p169421224910">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row865012214916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1894292215919">cluster_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p189422022399">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p2942132218915"><strong id="EN-US_TOPIC_0000002532014005__b2094217223919">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p4942142219914">Cluster status.</p>
<p id="EN-US_TOPIC_0000002532014005__p189423224920"><strong id="EN-US_TOPIC_0000002532014005__b169421122394">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1394211224916">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_Datastore"></a><a name="en-us_topic_0000002375015197_response_Datastore"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_Datastore" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Datastore</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014005__row10696922894"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p id="EN-US_TOPIC_0000002532014005__p159431222399">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.2"><p id="EN-US_TOPIC_0000002532014005__p1394372211920">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.2.4.1.3"><p id="EN-US_TOPIC_0000002532014005__p8943142216915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014005__row969682216917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p094313221095">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p29436227915">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p5943102217919"><strong id="EN-US_TOPIC_0000002532014005__b1594372217910">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1894372218912">Cluster type.</p>
<p id="EN-US_TOPIC_0000002532014005__p89437225918"><strong id="EN-US_TOPIC_0000002532014005__b1994362217916">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p2943222196">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row18696182210917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p159431221693">version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p159441522092">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p29444222912"><strong id="EN-US_TOPIC_0000002532014005__b1394419221914">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1194417220920">Cluster version.</p>
<p id="EN-US_TOPIC_0000002532014005__p15944722395"><strong id="EN-US_TOPIC_0000002532014005__b9944622198">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p29444225919">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_FineGrainedSnapshotDetail"></a><a name="en-us_topic_0000002375015197_response_FineGrainedSnapshotDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_response_FineGrainedSnapshotDetail" frame="border" border="1" rules="all"><caption><b>Table 6 </b>FineGrainedSnapshotDetail</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014005__row4700822591"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p id="EN-US_TOPIC_0000002532014005__p194418221595">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.2"><p id="EN-US_TOPIC_0000002532014005__p149445221598">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.2.4.1.3"><p id="EN-US_TOPIC_0000002532014005__p8944102218913">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014005__row1370052212918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1694516220910">database</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p159450221499">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p994562211911"><strong id="EN-US_TOPIC_0000002532014005__b109451122994">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1894562219919">Database.</p>
<p id="EN-US_TOPIC_0000002532014005__p209457221912"><strong id="EN-US_TOPIC_0000002532014005__b1394582215912">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p16945162217915">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row15700422693"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p79451221290">schema_list</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1394515220915">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p39459226914"><strong id="EN-US_TOPIC_0000002532014005__b199450221299">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p794519221993">Schema list.</p>
<p id="EN-US_TOPIC_0000002532014005__p09465221912"><strong id="EN-US_TOPIC_0000002532014005__b694619225911">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p094619221914">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row177008221095"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1394610221495">table_list</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014005__p39466227911">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014005__p179466222918"><strong id="EN-US_TOPIC_0000002532014005__b1494632210917">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p894612215920">Table set.</p>
<p id="EN-US_TOPIC_0000002532014005__p12946922896"><strong id="EN-US_TOPIC_0000002532014005__b8946112213919">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p1594612212918">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014005__section199467221899"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="EN-US_TOPIC_0000002532014005__screen16947132219919">GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/snapshots</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014005__section11947102214920"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002532014005__p149479221799"><strong id="EN-US_TOPIC_0000002532014005__b1494717222093">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002532014005__p119471222399">Snapshot list queried.</p>
<pre class="screen" id="EN-US_TOPIC_0000002532014005__screen5947142218912">{
"project_id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
"cluster_id" : "e59d6b86-9072-46eb-a996-13f8b44994c1",
"snapshots" : [ {
"id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
"name" : "snapshot-1",
"description" : "",
"size" : 500,
"status" : "AVAILABLE",
"type" : "MANUAL",
"backup_device" : "obs",
"backup_key" : "20221027_041552",
"bak_expected_start_time" : "1666843740000",
"bak_keep_day" : 3,
"bak_period" : "0 9 4/8 ? * 2,3,4,5,6,7",
"base_backup_key" : "20221025_201556",
"base_backup_name" : "dws-test-20221025201427",
"cluster_id" : "e59d6b86-9072-46eb-a996-13f8b44994c1",
"cluster_name" : "test_1025_02",
"datastore" : {
"type" : "dws",
"version" : "8.2.0"
},
"db_user" : "dbadmin",
"fine_grained_backup" : false,
"guest_agent_version" : "8.2.0",
"prior_backup_key" : "20221026_201555",
"support_inplace_restore" : true,
"total_backup_size" : 813475,
"updated" : "2022-10-27T04:18:57"
} ],
"count" : 2
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014005__section896319228915"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014005__en-us_topic_0000002375015197_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002532014005__row473352213911"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002532014005__p196310221394">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="EN-US_TOPIC_0000002532014005__p396472211918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014005__row1773318221694"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1396419221794">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1396410222917">Snapshot list queried.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row6733142215912"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1096412221896">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1996462218916">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row47332226910"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014005__p19646221590">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014005__p169643221597">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row7733142220917"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014005__p1996412210913">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1496418223912">You do not have required permissions.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row1473312222915"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014005__p5964322790">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1796582215919">No resources found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row773314227912"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014005__p129652229915">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014005__p1796511229913">Internal server error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014005__row127331222594"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014005__p79651222996">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014005__p109659221396">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0023.html">Snapshot Management</a></div>
</div>
</div>
View Git Blame Copy Permalink