更新时间:2025-09-18 GMT+08:00

创建快照

功能介绍

该接口用于为指定集群创建快照。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/snapshots

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

snapshot

Snapshot object

参数解释

快照对象。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 Snapshot

参数

是否必选

参数类型

描述

name

String

参数解释

快照名称。要求唯一性且必须以字母开头,不区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符,长度为4~64个字符。

取值范围

不涉及。

cluster_id

String

参数解释

指定创建快照的集群ID。

取值范围

不涉及。

description

String

参数解释

快照描述,若不指定,描述为空。快照描述的字符长度不能超过256个字符,且不支持特殊字符!<>'=&"。

取值范围

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

snapshot

SnapshotResp object

参数解释

快照对象。

取值范围

不涉及。

表5 SnapshotResp

参数

参数类型

描述

id

String

参数解释

快照ID。

取值范围

不涉及。

请求示例

为ID为"44b277eb-39be-4921-be31-3d61b43651d7"的集群创建名为snapshot-3的手动快照。

POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots

{
  "snapshot" : {
    "name" : "snapshot-3",
    "cluster_id" : "44b277eb-39be-4921-be31-3d61b43651d7",
    "description" : "Snapshot-3 description"
  }
}

响应示例

状态码:200

创建快照成功。

{
  "snapshot" : {
    "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793"
  }
}

状态码

状态码

描述

200

创建快照成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。