Help Center/ Cloud Search Service/ API Reference/ APIs/ Snapshot Management/ Querying the Automatic Snapshot Creation Policy

Updated on 2024-10-17 GMT+08:00

View PDF

Querying the Automatic Snapshot Creation Policy

Function

This API is used to query the automatic snapshot creation policy.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
cluster_id	Yes	String	ID of the cluster where snapshots are to be automatically created.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
keepday	Integer	Customize the number of snapshots to be retained.
period	String	Time when a snapshot is created every day.
prefix	String	Snapshot name prefix, which needs to be manually entered.
bucket	String	Name of the OBS bucket where snapshots are stored.
basePath	String	Storage path of the snapshot in the OBS bucket.
agency	String	Agency used to access OBS buckets.
enable	String	Whether to enable the automatic snapshot creation policy. true: The automatic snapshot creation policy is enabled. false: The automatic snapshot creation policy is disabled.
frequency	String	Frequency of automatically creating snapshots.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "keepday" : 2,
  "frequency" : "DAY",
  "period" : "16:00 GMT+08:00",
  "prefix" : "snapshot",
  "bucket" : "es-backup",
  "basePath" : "css_repository/tests",
  "agency" : "usearch",
  "enable" : "true"
}