创建云堡垒机实例
功能介绍
创建云堡垒机实例。（创建云堡垒机实例订单前，先调用此接口）
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/cbs/instance/create
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法详见API参考，附录获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
server |
是 |
CBHInstances object |
创建堡垒机实例请求参数。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
flavor_ref |
是 |
String |
待创建云堡垒机规格ID，例如：
|
instance_name |
是 |
String |
云堡垒机实例名称，取值范围：
|
vpc_id |
是 |
String |
待创建云服务器所属虚拟私有云（简称VPC），需要指定已创建VPC的ID，UUID格式。 VPC的ID可以从控制台或者参考《虚拟私有云接口参考》的“查询VPC”章节获取。 例如：03211ecf-697e-4306-a7a0-6e939bf948de |
nics |
是 |
Array of Nics objects |
云堡垒机实例网卡信息。 |
public_ip |
是 |
PublicIp object |
云堡垒机实例弹性公网IP信息。可填写null值 |
security_groups |
是 |
Array of SecurityGroup objects |
安全组信息。 |
availability_zone |
是 |
String |
创建云堡垒机所在的可用区，需要指定可用区名称。 可参考地区和终端节点获取 |
slave_availability_zone |
否 |
String |
创建云堡垒机所在的备机可用区，需要指定备机可用区名称。(当前字段未启用,填写默认值null) 可参考地区和终端节点获取 |
comment |
否 |
String |
云堡垒机实例描述信息。 |
region |
是 |
String |
云服务所在局点ID。 |
hx_password |
是 |
String |
堡垒机实例前端登录密码。密码规则：8-32位,不能包含amdin或nidma及其大写形式,必须包含大小写数字特殊字符四种类型中的三种。 |
bastion_type |
是 |
String |
堡垒机实例类型，填写“OEM”即可。 |
ipv6_enable |
否 |
Boolean |
是否支持IPV6，不填默认为false。 |
enterprise_project_id |
否 |
String |
企业项目ID，不填默认为0。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
instance_key |
Integer |
云堡垒机实例key。 |
slave_instance_key |
Integer |
云堡垒机备机实例key。（当前字段未启用，返回默认值null） |
request_info |
Integer |
返回创建云堡垒机实例信息。 |
job_id |
Integer |
job任务ID。（当前字段未启用，返回默认值null） |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_description |
String |
请求参数错误。 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_description |
String |
校验TOKEN失败。 |
状态码： 403
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_description |
String |
租户无权限操作。 |
状态码： 404
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_description |
String |
没有找到CBH资源。 |
请求示例
{
"server" : {
"flavor_ref" : "cbh.basic.50",
"instance_name" : "CBH-155f",
"vpc_id" : "279e8217-4a8a-4d83-8fd9-b8f14d47170b",
"nics" : [ {
"subnet_id" : "a86217e6-a96d-4803-ae5c-b57da6811249"
} ],
"public_ip" : {
"id" : "cfcab481-0831-4e23-a739-d6cdd0ef3630",
"public_eip" : "123.249.41.4"
},
"security_groups" : [ {
"id" : "1e10bc4f-9a36-4452-a867-8ddb4348c15e"
} ],
"availability_zone" : "cn-north-4a",
"slave_availability_zone" : "cn-north-4b",
"comment" : "success",
"region" : "cn-north-4",
"hx_password" : "12345678",
"bastion_type" : "OEM"
}
}
响应示例
无
状态码
状态码 |
描述 |
|---|---|
200 |
Cbh CreateInstance Success |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。
