vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/api-ref/dws_02_0025.html
Lu, Huayi 24f47208ec DWS API 831.100 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-10-07 10:18:56 +00:00

405 lines
34 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001185833136"></a><a name="EN-US_TOPIC_0000001185833136"></a>
<h1 class="topictitle1">Querying Snapshot Details</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_s89d994cb1803492fb7ab0b764e10efc5"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_aa4a586dad1a140f1b8b2aa21cee1a45e">This API is used to query snapshot details by using the snapshot ID.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_s7407bbbf9740421f9f01edb6677acb7b"><h4 class="sectiontitle">URI</h4><pre class="screen" id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_screen9294195620593">GET /v1.0/{project_id}/snapshots/{snapshot_id}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833136__table1140642919442" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833136__row1540472934415"><th align="left" class="cellrowborder" valign="top" width="17.09%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001185833136__p340412298442"><strong id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_b84235270617228">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.700000000000001%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001185833136__p8404132918443"><strong id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_b6167984116271">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.67%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001185833136__p17404112944417"><strong id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_b5968132015284">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.540000000000006%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001185833136__p84046290447"><strong id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_b14846921172817">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833136__row12405142954417"><td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833136__p164041229104410">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.700000000000001%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833136__p8404182910443">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.67%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833136__p640532924413">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.540000000000006%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833136__p2405182918449"><span id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_text1640910983412">Project ID</span>. For details about how to obtain the ID, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row17406202912449"><td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001185833136__p184056293447">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.700000000000001%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001185833136__p18405229194416">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.67%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001185833136__p140515297441">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.540000000000006%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001185833136__p20405192914414">Snapshot ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833136__section89351121184611"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000001185833136__p5591103874611">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833136__section1699845574613"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833136__table1549441910478" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833136__row249481918476"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0000001185833136__p13494151918476"><strong id="EN-US_TOPIC_0000001185833136__b585138720">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.2"><p id="EN-US_TOPIC_0000001185833136__p17495171913472"><strong id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_b136129416412">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.2.4.1.3"><p id="EN-US_TOPIC_0000001185833136__p1549518191471"><strong id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_b4260153618282">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833136__row149541914477"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p114951919164716">snapshot</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p194958196474"><a href="#EN-US_TOPIC_0000001185833136__table8495161919476">SnapshotDetail</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p1849517198475">Snapshot object</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833136__table8495161919476"></a><a name="table8495161919476"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833136__table8495161919476" frame="border" border="1" rules="all"><caption><b>Table 3 </b>SnapshotDetail</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833136__row0495919194716"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001185833136__p84961819144718"><strong id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_b367911994115">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001185833136__p94962019124710"><strong id="EN-US_TOPIC_0000001185833136__b857720145">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001185833136__p54961819194712"><strong id="EN-US_TOPIC_0000001185833136__b1852768825">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833136__row349616198471"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p17496119194717">id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p449671914717">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p18496171911474">Snapshot ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row1449615199471"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p16496151912470">name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p949691911471">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p124966190474">Snapshot name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row24961919184719"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p13497131916478">description</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p649712195478">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p149771974713">Snapshot description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row144973194471"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p849771954717">started</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1849717198470">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p194971419154717">Time when a snapshot starts to be created. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row17497919144715"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p134971219184719">finished</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p114973192472">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p11497319184717">Time when a snapshot is complete. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row1849716193475"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p3498119154711">size</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p649801954719">Double</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p13498719104718">Snapshot size, in GB</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row649871934717"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p1649819190473">status</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p84984196472">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p1749871954711">Snapshot status:</p>
<ul id="EN-US_TOPIC_0000001185833136__ul1049871974711"><li id="EN-US_TOPIC_0000001185833136__li104988198477">CREATING</li><li id="EN-US_TOPIC_0000001185833136__li19498101915470">AVAILABLE</li><li id="EN-US_TOPIC_0000001185833136__li1498151954715">UNAVAILABLE</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row10498201994711"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p349811913474">type</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1349913196479">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p1649971919475">Snapshot type. It can be:</p>
<ul id="EN-US_TOPIC_0000001185833136__ul24991719154716"><li id="EN-US_TOPIC_0000001185833136__li44991519154710"><strong id="EN-US_TOPIC_0000001185833136__b4468124515151">MANUAL</strong></li><li id="EN-US_TOPIC_0000001185833136__li16499121912470"><strong id="EN-US_TOPIC_0000001185833136__b11214144621514">AUTOMATED</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row7499719104714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p174992019154714">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p184998197479">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p1349912199476">ID of the cluster for which snapshots are created.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row249931916479"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p20499191918471">cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p34992195471">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p105001119104715">Name of the cluster for which the snapshot is created</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row9500151934718"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p18500719164711">backup_key</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p14500181984713">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p350011195475">Key generated during backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row550061916478"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p19500101913479">prior_backup_key</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p18500719104710">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p1250020192470">Backup key of the previous snapshot used by the incremental backup The value <strong id="EN-US_TOPIC_0000001185833136__b5855120974510">FULL</strong> indicates a full snapshot.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row19501121934716"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p115011419154716">base_backup_key</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p18501111954716">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p950151918470">Backup key of a full snapshot</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row650131914715"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p7501151964715">backup_device</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p450114193474">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p75011419204719">Backup media</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row25021519194717"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p155025199476">total_backup_size</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1350281994716">Long</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p1250201964716">Accumulated size of a snapshot, from the full backup to the incremental backup. Unit: KB</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row1350271924720"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p0502161944711">base_backup_name</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p950261984716">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p05027198473">Name of a full snapshot</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row95032019134719"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p25039199470">support_inplace_restore</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p250341984720">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p0503141919473">Whether data can be restored to the original cluster</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row550311994715"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p55035192471">fine_grained_backup</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p105031019134715">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p15503121944710">Whether the backup is a fine-grained backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row18503191964715"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p45031719144716">fine_grained_backup_detail</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p250312191470"><a href="#EN-US_TOPIC_0000001185833136__table4509171964717">FineGrainedSnapshotDetail</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p10504819104710">Fine-grained backup information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row350421910477"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p17504171913472">guest_agent_version</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p15504111914471">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p3504171994718">GuestAgent version</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row4504121964716"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p35041719194718">cluster_status</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p17504819124719">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p450417193479">Cluster status</p>
<ul id="EN-US_TOPIC_0000001185833136__ul115047198477"><li id="EN-US_TOPIC_0000001185833136__li175041519114712"><p id="EN-US_TOPIC_0000001185833136__p15504101914718"><a name="EN-US_TOPIC_0000001185833136__li175041519114712"></a><a name="li175041519114712"></a><strong id="EN-US_TOPIC_0000001185833136__b12113506514510">AVAILABLE</strong></p>
</li><li id="EN-US_TOPIC_0000001185833136__li1504121920475"><p id="EN-US_TOPIC_0000001185833136__p1450431964714"><a name="EN-US_TOPIC_0000001185833136__li1504121920475"></a><a name="li1504121920475"></a><strong id="EN-US_TOPIC_0000001185833136__b15986379364510">UNAVAILABLE</strong></p>
</li><li id="EN-US_TOPIC_0000001185833136__li250515199470"><p id="EN-US_TOPIC_0000001185833136__p95054193479"><a name="EN-US_TOPIC_0000001185833136__li250515199470"></a><a name="li250515199470"></a><strong id="EN-US_TOPIC_0000001185833136__b16534057924510">FROZEN</strong></p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row550581974710"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p20505419114715">bak_expected_start_time</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1950581920474">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p15061219174716">Estimated snapshot start time</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row950641914472"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p2050681912478">bak_keep_day</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p20507419114714">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p550721918476">Backup retention days</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row14507319124718"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p4507171984717">bak_period</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p17507119154710">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p750721910471">Cluster policy</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row1350721994713"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p1750817197478">db_user</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p11508019154713">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p15081019124714">Backup user</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row950851954714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p195082190478">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p9508161914718"><a href="#EN-US_TOPIC_0000001185833136__table15111519194718">DataStore</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p4508111919475">Database version</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row250861934718"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p6508191974714">progress</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p150891913475">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p050821911476">Backup progress</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row1650816196473"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p35091219184718">backup_level</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1850911994711">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p18509141919477">Backup level</p>
<ul id="EN-US_TOPIC_0000001185833136__ul1150910191475"><li id="EN-US_TOPIC_0000001185833136__li15509111924718">cluster</li><li id="EN-US_TOPIC_0000001185833136__li10509619154716">schema</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833136__table4509171964717"></a><a name="table4509171964717"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833136__table4509171964717" frame="border" border="1" rules="all"><caption><b>Table 4 </b>FineGrainedSnapshotDetail</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833136__row6509171964719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000001185833136__p0510111911471"><strong id="EN-US_TOPIC_0000001185833136__b984310655">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000001185833136__p951011915475"><strong id="EN-US_TOPIC_0000001185833136__b1850246647">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000001185833136__p1951061915471"><strong id="EN-US_TOPIC_0000001185833136__b678682043">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833136__row19510119194714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p17510121914714">database</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p11510101954715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p1251021912476">Database backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row1551013192476"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p25108199474">schema_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p751081984712">Array of String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p1451101912476">Backup schema set</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row175118191477"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p05116197478">table_list</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1151115195478">Array of String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p165111719124716">Backup table set</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001185833136__table15111519194718"></a><a name="table15111519194718"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833136__table15111519194718" frame="border" border="1" rules="all"><caption><b>Table 5 </b>DataStore</caption><thead align="left"><tr id="EN-US_TOPIC_0000001185833136__row14511161964713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="EN-US_TOPIC_0000001185833136__p1751271994712"><strong id="EN-US_TOPIC_0000001185833136__b1989523853">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="EN-US_TOPIC_0000001185833136__p5512161924710"><strong id="EN-US_TOPIC_0000001185833136__b966171673">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="EN-US_TOPIC_0000001185833136__p145121819144717"><strong id="EN-US_TOPIC_0000001185833136__b1481611854">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833136__row115125198472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p4512119174714">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p15512171915474">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p165121119164719">Database type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row051231964719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001185833136__p11512119164715">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001185833136__p155121319124714">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001185833136__p1151314196479">Database version</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_sc41be71f816145c98a3a0cbc0570f81c"><h4 class="sectiontitle">Request Message</h4><pre class="screen" id="EN-US_TOPIC_0000001185833136__screen5769413343">GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/b5c45780-1006-49e3-b2d5-b3229975bbc7</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_sb51fdf6952534594a77e5ca943b4d031"><h4 class="sectiontitle">Response Message</h4><pre class="screen" id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_s418bd57bf5324e399222016675a7ed0c">{
"snapshot": {
"id": "2a4d0f86-67cd-408a-8b66-017454fb7793",
"name": "snapshot-1",
"description": "snapshot description",
"started": "2016-08-23T03:59:23Z",
"finished": "2016-08-23T04:01:40Z",
"size": 500,
"status": "AVAILABLE",
"type": "MANUAL",
"cluster_id": "4f87d3c4-9e33-482f-b962-e23b30d1a18c"
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001098656798_s0432ac0acf0e4c35952c6e583e5d13a4"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001185833136__en-us_topic_0000001437658185_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001185833136__row436718421919"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000001185833136__p83731417193">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="EN-US_TOPIC_0000001185833136__p1937910410197"><strong id="EN-US_TOPIC_0000001185833136__b1660929350">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001185833136__row163678421915"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833136__p12384104161913">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1639111412194">The snapshot details are queried.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row736716416195"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833136__p1839616461910">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1040214419199">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row5368124111915"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833136__p04078431918">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1741317471910">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row1936819461915"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833136__p164197461914">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833136__p242412414198">You do not have required permissions.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row136811431914"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833136__p114301418197">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833136__p1243614417192">No resources found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row23681141192"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833136__p17441144191911">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833136__p10447104161912">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001185833136__row1368248199"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001185833136__p1345410415199">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001185833136__p84595413191">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 APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink