Updated on 2026-09-08 GMT+08:00

Backing Up a Cluster

This API is used to back up a cluster.

For details, see Calling APIs.

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, no identity policy-based permission required for calling this API.

POST /api/v3.1/projects/{project_id}/clusters/{cluster_id}/operation/snapshot

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A
cluster_id	Yes	String	Details: Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A

None

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
uid	String	Definition: Task ID Range: N/A
metadata	SnapshotCluserResponseMetadata object	Definition: Backup metadata Range: N/A

**Table 3** SnapshotCluserResponseMetadata
Parameter	Type	Description
apiVersion	String	Definition: API version, which defaults to v3.1 Range: v3.1
kind	String	Definition: Task type Range: N/A

Example of a cluster upgrade backup request

POST /api/v3.1/projects/{project_id}/clusters/{cluster_id}/operation/snapshot

Status code: 200

The cluster backup task is created.

{
  "uid" : "15376f1b-daa6-4e2d-96a6-e9d5d7caeaa2",
  "metadata" : {
    "kind" : "Snapshot",
    "apiVersion" : "v3.1"
  }
}

Status Code	Description
200	The cluster backup task is created.