Help Center> Cloud Search Service> API Reference> APIs Related to Snapshot Management> Modifying Basic Configurations of a Cluster Snapshot
View PDF

Modifying Basic Configurations of a Cluster Snapshot

Function

This API is used to modify the basic configurations of a cluster snapshot. The basic configurations include the OBS bucket and IAM agency.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining the Project ID and Account ID.

cluster_id

Yes

String

ID of the cluster where index data is to be backed up.

Request

Table 2 describes the request parameters.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

bucket

Yes

String

OBS bucket used for index data backup. If there is snapshot data in an OBS bucket, only the OBS bucket is used and cannot be changed.

agency

Yes

String

IAM agency used to access OBS.

Response

None

Examples

Example request

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/setting
{
    "bucket":"test-bucket",
    "agency":"usearch"
}

Status Code

Table 3 describes the status code.

Table 3 Status code

Status Code

Code

Status Code Description

200

OK

The request is processed successfully.

406

Not Acceptable

The server cannot fulfill the request according to the content characteristics of the request.

412

Precondition Failed

The server does not meet one of the preconditions that the requester puts on the request.

504

Gateway Timeout

A gateway timeout error occurred.