forked from docs/doc-exports
zhengxiu
93d856d5c5
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: zhengxiu <zhengxiu@huawei.com> Co-committed-by: zhengxiu <zhengxiu@huawei.com>
92 lines
7.3 KiB
HTML
92 lines
7.3 KiB
HTML
<a name="EN-US_TOPIC_0000001960397669"></a><a name="EN-US_TOPIC_0000001960397669"></a>
|
|
|
|
<h1 class="topictitle1">How Do I Query the Snapshot Information of a CSS Cluster?</h1>
|
|
<div id="body0000001338543977"><p id="EN-US_TOPIC_0000001960397669__p1565065911219">You can query snapshot information only if cluster snapshots are enabled and some snapshots have been created.</p>
|
|
<p id="EN-US_TOPIC_0000001960397669__en-us_topic_0000001965497093_en-us_topic_0000001268394289_p8060118">You can check them on the CSS management console or query them by running commands on Kibana or OpenSearch Dashboards.</p>
|
|
<div class="section" id="EN-US_TOPIC_0000001960397669__section15360172683111"><h4 class="sectiontitle">Querying Snapshots on the CSS Management Console</h4><ol id="EN-US_TOPIC_0000001960397669__ol191988083415"><li id="EN-US_TOPIC_0000001960397669__li21132214340"><span id="EN-US_TOPIC_0000001960397669__ph191131526342">Log in to the CSS management console.</span></li><li id="EN-US_TOPIC_0000001960397669__li1811410211349">In the navigation pane on the left, expand <strong id="EN-US_TOPIC_0000001960397669__b172786311743157">Clusters</strong>. Select a cluster type based on the target cluster. The cluster list is displayed.</li><li id="EN-US_TOPIC_0000001960397669__li5603104417112">In the cluster list, click the name of the target cluster. The cluster information page is displayed.</li><li id="EN-US_TOPIC_0000001960397669__li1455416406347">Click the <strong id="EN-US_TOPIC_0000001960397669__b97730774443157">Cluster Snapshots</strong> tab.</li><li id="EN-US_TOPIC_0000001960397669__li41185314345">In the cluster snapshot task list, click the target snapshot name, and check snapshot information in the displayed dialog box.</li></ol>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001960397669__section169254511258"><h4 class="sectiontitle">Querying Snapshots by Running Commands</h4><ol id="EN-US_TOPIC_0000001960397669__ol1192513511255"><li id="EN-US_TOPIC_0000001960397669__li20918195120253"><span id="EN-US_TOPIC_0000001960397669__ph13918251132516">Log in to the CSS management console.</span></li><li id="EN-US_TOPIC_0000001960397669__li891825162512">In the navigation pane on the left, expand <strong id="EN-US_TOPIC_0000001960397669__b177209762743157">Clusters</strong>. Select a cluster type based on the target cluster. The cluster list is displayed.</li><li id="EN-US_TOPIC_0000001960397669__li29191151202520">For an Elasticsearch cluster, click <span class="uicontrol" id="EN-US_TOPIC_0000001960397669__uicontrol145141979543157"><b>Kibana</b></span> in the <strong id="EN-US_TOPIC_0000001960397669__b97860511843157">Operation</strong> column to log in to Kibana. For an OpenSearch cluster, click <span class="uicontrol" id="EN-US_TOPIC_0000001960397669__uicontrol108005980243157"><b>Dashboards</b></span> in the <strong id="EN-US_TOPIC_0000001960397669__b85060083843157">Operation</strong> column to log in to OpenSearch Dashboards.</li><li id="EN-US_TOPIC_0000001960397669__li1191955182514">Expand the menu in the upper-left corner, and choose <strong id="EN-US_TOPIC_0000001960397669__b140079525243157">Dev Tools</strong>.</li><li id="EN-US_TOPIC_0000001960397669__li8921115110250">Run the following command to query the snapshot repository information, that is, the basic cluster snapshot settings.<pre class="screen" id="EN-US_TOPIC_0000001960397669__screen10920145119255">GET _snapshot/_all</pre>
|
|
<p id="EN-US_TOPIC_0000001960397669__p89201751182516">Example response:</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001960397669__screen392155110256">{
|
|
"repo_auto": {
|
|
"type": "obs",
|
|
"settings": {
|
|
"bucket": "123xxx", // OBS bucket name
|
|
"chunk_size": "2g", // Chunk size in snapshots (unit: GB)
|
|
"endpoint": "obs.xxx.example.com:443", // OBS VPC endpoint
|
|
"max_restore_bytes_per_sec": "0MB", // Maximum recovery rate (per second)
|
|
"compress": "true", // Whether to enable data compression
|
|
"base_path": "css_repository/css-xxx", // Backup path
|
|
"region": "xxx", // Region
|
|
"max_snapshot_bytes_per_sec": "40MB" // Maximum backup rate (per second)
|
|
}
|
|
}
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001960397669__li16925205120256">Run the following command to query the snapshot list:<pre class="screen" id="EN-US_TOPIC_0000001960397669__screen392265142511">GET _snapshot/repo_auto/_all</pre>
|
|
<p id="EN-US_TOPIC_0000001960397669__p4922125192514">Example output (two snapshots are returned):</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001960397669__screen292316510259">{
|
|
"snapshots": [
|
|
{
|
|
"snapshot": "snapshot-2dc3", // Snapshot name
|
|
"uuid": "VW5y2NBJS9iPh7YcGLxxxx", // Snapshot ID
|
|
"version_id": xxxxxxx, // Internal cluster version
|
|
"version": "x.x.x", // Cluster version
|
|
"indices": [ // Backed up indexes
|
|
".opendistro_security"
|
|
],
|
|
"data_streams": [ ], // Data streams
|
|
"include_global_state": true, // Whether to include the global cluster status
|
|
"state": "SUCCESS", // Snapshot status
|
|
"start_time": "2025-08-30T01:41:57.068Z", // Snapshot start time
|
|
"start_time_in_millis": 1756518117068, // Snapshot start time in milliseconds
|
|
"end_time": "2025-08-30T01:41:57.469Z", // Snapshot end time
|
|
"end_time_in_millis": 1756518117469, // Snapshot end time in milliseconds
|
|
"duration_in_millis": 401, // Snapshot creation duration (from start to completion) in milliseconds
|
|
"failures": [ ], // Failed shards during snapshot creation
|
|
"shards": { // Shard statistics
|
|
"total": 1, // Total number of shards
|
|
"failed": 0, // Number of failed shards
|
|
"successful": 1 // Number of successful shards
|
|
}
|
|
},
|
|
{
|
|
"snapshot": "snapshot-dd37",
|
|
"uuid": "FD4VcooLS8yjPY3w0-x-xx",
|
|
"version_id": xxxxxxx,
|
|
"version": "x.x.x",
|
|
"indices": [
|
|
".kibana",
|
|
".opendistro_security"
|
|
],
|
|
"data_streams": [ ],
|
|
"include_global_state": true,
|
|
"state": "SUCCESS",
|
|
"start_time": "2025-08-30T01:54:55.750Z",
|
|
"start_time_in_millis": 1756518895750,
|
|
"end_time": "2025-08-30T01:54:55.950Z",
|
|
"end_time_in_millis": 1756518895950,
|
|
"duration_in_millis": 200,
|
|
"failures": [ ],
|
|
"shards": {
|
|
"total": 2,
|
|
"failed": 0,
|
|
"successful": 2
|
|
}
|
|
}
|
|
]
|
|
}</pre>
|
|
<p id="EN-US_TOPIC_0000001960397669__p9924195162511">To query information about a specified snapshot, run the following command:</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001960397669__screen89241851102520">GET _snapshot/repo_auto/{snapshot_name}</pre>
|
|
<p id="EN-US_TOPIC_0000001960397669__p692416517259">Replace <em id="EN-US_TOPIC_0000001960397669__i1127194617290">snapshot_name</em> with the actual snapshot name. Wildcard matching is supported.</p>
|
|
</li><li id="EN-US_TOPIC_0000001960397669__li15925125162513">(Optional) Run the following command to delete a specified snapshot:<pre class="screen" id="EN-US_TOPIC_0000001960397669__screen13925195110259">DELETE _snapshot/repo_auto/{snapshot_name}</pre>
|
|
<p id="EN-US_TOPIC_0000001960397669__p3925115192520">Exercise caution when choosing snapshots to delete.</p>
|
|
</li></ol>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_02_0147.html">CSS Cluster Backup and Restoration</a></div>
|
|
</div>
|
|
</div>
|
|
|