Help Center/ Cloud Search Service/ API Reference/ API V2/ Snapshot Management/ Disabling Automatic Snapshot Creation
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Disabling Automatic Snapshot Creation

Function

This API is used to disable automatic snapshot creation for an Elasticsearch or OpenSearch cluster. If a cluster does not need automatic backup, you are advised to disable automatic snapshot creation to reduce storage costs.

You can only use this API on Elasticsearch and OpenSearch clusters with automatic snapshot creation enabled.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    css:snapshot:setSnapshotPolicy

    Write

    cluster *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

PUT /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/close

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints

N/A

Range

Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits.

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints

The value is a UUID containing 36 characters.

Range

Cluster ID.

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Disable the automatic backup function.

PUT https://{Endpoint}/v2.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/snapshots/policy/close

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request before retry.

403

Request denied.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

Error Codes

See Error Codes.

Parent topic: Snapshot Management