Help Center/ Cloud Search Service/ API Reference/ Snapshot Management/ Modifying Basic Configurations of a Cluster Snapshot
Updated on 2023-03-15 GMT+08:00

Modifying Basic Configurations of a Cluster Snapshot

Function

This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.

You can also use this API to enable the snapshot function.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting

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 a Project ID and Name.

cluster_id

Yes

String

ID of the cluster whose snapshot basic configuration you want to modify.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

bucket

Yes

String

Name of the OBS bucket used for backup.

agency

Yes

String

IAM agency used to access OBS.

basePath

Yes

String

Storage path of the snapshot in the OBS bucket.

Response Parameters

None

Example Requests

{
  "bucket" : "test-bucket",
  "agency" : "usearch",
  "basePath" : "css_repository/Es-name"
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

406

The server could not fulfill the request according to the content characteristics of the request.

412

The server did not meet one of the preconditions contained in the request.

504

A gateway timeout error occurred.

Error Codes

See Error Codes.