Updated on 2024-04-23 GMT+08:00

Cluster Backup

Function

Cluster backup

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

uid

String

Task ID

metadata

SnapshotCluserResponseMetadata object

Backup metadata

Table 3 SnapshotCluserResponseMetadata

Parameter

Type

Description

apiVersion

String

API version, which defaults to v3.1

kind

String

Task type

Example Requests

Example of a cluster upgrade backup request

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

Example Responses

Status code: 200

The cluster backup task is created.

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

Status Codes

Status Code

Description

200

The cluster backup task is created.

Error Codes

See Error Codes.