(Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot
Function
This API is used to configure basic settings for automatic Elasticsearch or OpenSearch cluster snapshot creation, including automatically creating an IAM agency and the OBS bucket and file path used for storing snapshots. This API also enables cluster snapshots. Cluster snapshots enhance data protection and restoration capabilities for clusters.
Constraints
-
This API automatically creates an OBS bucket and agency for the snapshot. If there are multiple clusters, an OBS bucket will be created for each cluster via this API. As a result, the OBS quota may be insufficient, and many OBS buckets are difficult to maintain. You are advised to use the API Enabling or Modifying the Cluster Snapshot Function.
-
When snapshots are enabled for a cluster, the API will use the previous configuration to ensure consistency. If snapshots are enabled for the first, the system automatically creates an OBS bucket and file path and preferentially uses an existing agency. If there are no agencies, the system automatically creates an agency named css-obs-agency.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/auto_setting
| 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 ID of the cluster to be backed up. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints N/A Range The value is a UUID containing 36 characters. Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Automatically configure basic settings of a cluster snapshot.
POST https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/auto_setting 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. |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
