添加网关节点(AddBareMetal2Gateway)
API请求
URLs
POST zstack/v1/baremetal2/gatewaysHeaders
Authorization: OAuth the-session-uuidBody
{
"params": {
"username": "userName",
"password": "password",
"sshPort": 22.0,
"name": "gateway",
"managementIp": "127.0.0.1",
"clusterUuid": "5b08798053343ec686244dc3a36bbccf"
},
"systemTags": [],
"userTags": []
}Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"username":"userName","password":"password","sshPort":22.0,"name":"gateway","managementIp":"127.0.0.1","clusterUuid":"5b08798053343ec686244dc3a36bbccf"}}' http://localhost:8080/zstack/v1/baremetal2/gateways参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| username | String | body(包含在params结构中) | 用户名 | 4.0.0 | |
| password | String | body(包含在params结构中) | 密码 | 4.0.0 | |
| sshPort (可选) | int | body(包含在params结构中) | SSH端口 | 4.0.0 | |
| name | String | body(包含在params结构中) | 资源名称 | 4.0.0 | |
| description (可选) | String | body(包含在params结构中) | 资源的详细描述 | 4.0.0 | |
| managementIp | String | body(包含在params结构中) | 管理网络IP地址 | 4.0.0 | |
| clusterUuid | String | body(包含在params结构中) | 集群UUID | 4.0.0 | |
| resourceUuid (可选) | String | body(包含在params结构中) | 资源UUID | 4.0.0 | |
| tagUuids (可选) | List | body(包含在params结构中) | 标签UUID列表 | 4.0.0 | |
| systemTags (可选) | List | body | 系统标签 | 4.0.0 | |
| userTags (可选) | List | body | 用户标签 | 4.0.0 |
API返回
返回示例
{
"inventory": {
"zoneUuid": "24b761ab09f7349684387fdf822aaee7",
"name": "example",
"uuid": "f893fe1c941939738a0ec271880d8e53",
"clusterUuid": "4191157f33ab34d0a55b8e30444a1367",
"description": "example",
"managementIp": "192.168.0.1",
"hypervisorType": "KVM",
"state": "Enabled",
"status": "Connected",
"totalCpuCapacity": 4.0,
"availableCpuCapacity": 2.0,
"totalMemoryCapacity": 4.0,
"availableMemoryCapacity": 4.0
}
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| error | ErrorCode | 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error | 4.0.0 |
| inventory | BareMetal2ChassisOfferingInventory | 详情参考inventory | 4.0.0 |
#error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 | 4.0.0 |
| description | String | 错误的概要描述 | 4.0.0 |
| details | String | 错误的详细信息 | 4.0.0 |
| elaboration | String | 保留字段，默认为null | 4.0.0 |
| opaque | LinkedHashMap | 保留字段，默认为null | 4.0.0 |
| cause | ErrorCode | 根错误，引发当前错误的源错误，若无原错误，该字段为null | 4.0.0 |
#inventory
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| zoneUuid | String | 区域UUID | 4.0.0 |
| name | String | 资源名称 | 4.0.0 |
| uuid | String | 资源的UUID，唯一标示该资源 | 4.0.0 |
| clusterUuid | String | 集群UUID | 4.0.0 |
| description | String | 资源的详细描述 | 4.0.0 |
| managementIp | String | 4.0.0 | |
| hypervisorType | String | 4.0.0 | |
| state | String | 4.0.0 | |
| status | String | 4.0.0 | |
| totalCpuCapacity | Long | 4.0.0 | |
| availableCpuCapacity | Long | 4.0.0 | |
| totalMemoryCapacity | Long | 4.0.0 | |
| availableMemoryCapacity | Long | 4.0.0 | |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
SDK示例
Java
SDK
AddBareMetal2GatewayAction action = new AddBareMetal2GatewayAction();
action.username = "userName";
action.password = "password";
action.sshPort = 22.0;
action.name = "gateway";
action.managementIp = "127.0.0.1";
action.clusterUuid = "5b08798053343ec686244dc3a36bbccf";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddBareMetal2GatewayAction.Result res = action.call();Python
SDK
AddBareMetal2GatewayAction action = AddBareMetal2GatewayAction()
action.username = "userName"
action.password = "password"
action.sshPort = 22.0
action.name = "gateway"
action.managementIp = "127.0.0.1"
action.clusterUuid = "5b08798053343ec686244dc3a36bbccf"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddBareMetal2GatewayAction.Result res = action.call()