更新时间:2025-12-10 GMT+08:00

恢复集群

功能介绍

该接口用于使用快照恢复集群。

调用方法

请参见如何调用API。

URI

POST /v1.0/{project_id}/snapshots/{snapshot_id}/actions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

snapshot_id

是

String

参数解释:

待恢复的快照ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

restore

是

Restore object

参数解释:

恢复对象。

取值范围:

不涉及。

表3 Restore

参数

是否必选

参数类型

描述

name

是

String

参数解释:

集群名称。

取值范围:

要求唯一性,必须以字母开头并只包含字母、数字、中划线,下划线,长度为4~64个字符。

subnet_id

否

String

参数解释:

指定子网ID,用于集群网络配置。

取值范围:

默认值与原集群相同。

security_group_id

否

String

参数解释:

指定安全组ID,用于集群网络配置。默认值与原集群相同。

取值范围:

不涉及。

vpc_id

否

String

参数解释:

指定虚拟私有云ID,用于集群网络配置。默认值与原集群相同。

取值范围:

不涉及。

availability_zone

否

String

参数解释:

指定集群可用区。默认值与原集群相同。

取值范围:

不涉及。

port

否

Integer

参数解释:

指定集群服务端口。

取值范围:

不涉及。

public_ip

否

PublicIp object

参数解释:

公网IP地址,如果未指定,则默认不使用公网连接。

取值范围:

不涉及。

enterprise_project_id

否

String

参数解释:

企业项目ID,对集群指定企业项目。如果未指定,则使用默认企业项目“default”的ID,即0。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

0

ipv6_enable

否

Boolean

参数解释:

指定网络协议类型,表明是否支持IPv6,默认不使用IPv6。

取值范围:

不涉及。

number_of_cn

否

Integer

参数解释:

CN部署量。取值范围为3~集群节点数,最大值为20,默认值为3。

取值范围:

不涉及。

表4 PublicIp

参数

是否必选

参数类型

描述

public_bind_type

否

String

参数解释:

弹性IP绑定类型。

约束限制:

不涉及。

取值范围:

auto_assign:自动绑定。

not_use:暂未使用。

bind_existing :使用已有。

默认取值:

null

eip_id

否

String

参数解释:

弹性公网IP的id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

null

ip_type

否

String

参数解释:

弹性公网IP的类型。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

null

eip_address

否

String

参数解释:

弹性公网IP的地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

null

band_width

否

Integer

参数解释:

弹性公网IP的带宽。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

null

status

否

String

参数解释:

弹性公网IP的状态。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

null

error_message

否

String

参数解释:

弹性公网IP的错误码。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

null

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

cluster

Cluster object

参数解释:

集群对象。

取值范围:

不涉及。

job_id

String

参数解释:

异步任务ID。

取值范围:

不涉及。

表6 Cluster

参数

参数类型

描述

id

String

参数解释:

集群ID。

取值范围:

不涉及。

请求示例

恢复快照到新集群dws-1,新集群在az1.dc1可用区下,数据库端口为8000,带子网ID,安全组ID,虚拟私有云ID,公网IP,企业ID等。

POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/actions

{
  "restore" : {
    "name" : "dws-1",
    "subnet_id" : "374eca02-cfc4-4de7-8ab5-dbebf7d9a720",
    "security_group_id" : "dc3ec145-9029-4b39-b5a3-ace5a01f772b",
    "vpc_id" : "85b20d7e-9eb7-4b2a-98f3-3c8843ea3574",
    "availability_zone" : "az1.dc1",
    "port" : 8000,
    "public_ip" : {
      "public_bind_type" : "auto_assign",
      "eip_id" : ""
    },
    "enterprise_project_id" : "aca4e50a-266f-4786-827c-f8d6cc3fbada",
    "number_of_cn" : 3
  }
}

响应示例

状态码:200

恢复集群请求下发成功。

{
  "cluster" : {
    "id" : "7d85f602-a948-4a30-afd4-e84f47471c15"
  },
  "job_id" : "2c9080458942e9c001894430d8ed0abc"
}

状态码

状态码

描述

200

恢复集群请求下发成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。