文档首页/ 云堡垒机 CBH/ API参考/ API说明/ 网络管理/ 切换堡垒机虚拟私有云
更新时间:2024-08-08 GMT+08:00

切换堡垒机虚拟私有云

功能介绍

切换堡垒机虚拟私有云

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/cbs/instance/vpc

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

获取方法详见API参考,附录"获取项目ID"

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

可参考"IAM获取IAM用户Token"获取

表3 请求Body参数

参数

是否必选

参数类型

描述

server_id

String

需要切换vpc的实例id

network

NetworkInfoCreate object

切换云堡垒机实例vpc所需网络信息。

表4 NetworkInfoCreate

参数

是否必选

参数类型

描述

vpc_id

String

待创建云服务器所属虚拟私有云(简称VPC),需要指定已创建VPC的ID,UUID格式。

VPC的ID可以从控制台或者参考《虚拟私有云接口参考》的“查询VPC”章节获取。

例如:03211ecf-xxxx-4306-xxxx-6e939bfxxxxx

subnet_id

String

子网ID,字母数字下划线连接符组成。

public_ip

PublicIp object

云堡垒机实例弹性公网IP信息。可填写null值

security_groups

Array of SecurityGroup objects

安全组信息。

private_ip

PrivateIp object

云堡垒机实例指定公网IP信息。

表5 PublicIp

参数

是否必选

参数类型

描述

id

String

弹性IP和EIP只能有一个,弹性IP或EIP的ID。

public_eip

String

弹性IP地址。

表6 SecurityGroup

参数

是否必选

参数类型

描述

id

String

云堡垒机实例安全组ID,字母数字下划线连接符组成。

表7 PrivateIp

参数

是否必选

参数类型

描述

ip

String

私网IP地址。

slave_ip

String

备机私网IP地址。

floating_ip

String

浮动IP地址。

响应参数

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

请求参数错误。

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

校验TOKEN失败。

状态码: 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

租户无权限操作。

状态码: 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_description

String

没有找到CBH资源。

请求示例

{
  "server_id" : "0f2c69d1-e420-4ae1-9b43-ab8699883678",
  "network" : {
    "vpc_id" : "760071b3-34a3-4359-bf18-3af24e77c1cf",
    "subnet_id" : "90b6be71-e72a-4d5a-8838-5924bce3c583",
    "private_ip" : {
      "ip" : "192.168.0.3",
      "slave_ip" : null,
      "floating_ip" : null
    },
    "public_ip" : null,
    "security_groups" : [ {
      "id" : "21321412321321321"
    } ]
  }
}

响应示例

状态码

状态码

描述

200

Switch Cbh Instance Vpc Success

400

Bad Request

401

Unauthorized

403

访问拒绝

404

Not Found

错误码

请参见错误码