DetachBareMetal2GatewayFromCluster

API Request

URLs
DELETE zstack/v1/baremetal2/clusters/{clusterUuid}/gateways/{gatewayUuid}
Headers
Authorization: OAuth the-session-uuid
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/baremetal2/clusters/d2b8680d85ec3ffe9e25764059f74ef3/gateways/2576cacdeef53f13963547db023b6679
Request Parameters
Name Type Location Description Valid Value Starting Version
clusterUuid String url The cluster UUID. 4.0.0
gatewayUuid String url The gateway UUID. 4.0.0
systemTags List body Optional. The system tags. 4.0.0
userTags List body Optional. The user tags. 4.0.0

API Response

Sample Response
{
  "inventory": {
    "username": "username",
    "password": "password",
    "sshPort": 22.0,
    "zoneUuid": "43aca62381ee4237a4cb59d164420ce6",
    "name": "BM_GATEWAY",
    "uuid": "3d93240bb6db464db7a8354b817b4ef8",
    "description": "This is a bare metal gateway.",
    "managementIp": "192.168.0.10",
    "state": "Enabled",
    "status": "Connected",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 4.0.0
inventory BareMetal2GatewayInventory See inventory. 4.0.0
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 4.0.0
description String The brief description of the error. 4.0.0
details String The details about the error. 4.0.0
elaboration String The reserved field. Default value: null. 4.0.0
opaque LinkedHashMap The reserved field. Default value: null. 4.0.0
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 4.0.0
#inventory
Name Type Description Starting Version
attachedClusterUuids List The attached cluster UUIDs. 4.0.0
username String The username of the gateway. 4.0.0
sshPort Integer The SSH port. 4.0.0
zoneUuid String The zone UUID. 4.0.0
name String The name of the gateway. 4.0.0
uuid String The UUID of the gateway. 4.0.0
clusterUuid String The cluster UUID. 4.0.0
description String The detailed description of the gateway. 4.0.0
managementIp String The IP address of the management node. 4.0.0
hypervisorType String The virtualization type. 4.0.0
state String The state of the gateway. 4.0.0
status String The connection status of the gateway. 4.0.0
totalCpuCapacity Long The total processing capacity of CPU. 4.0.0
availableCpuCapacity Long The available processing capacity of CPU. 4.0.0
cpuSockets Integer 4.0.0
totalMemoryCapacity Long The total memory size. 4.0.0
availableMemoryCapacity Long The available memory size. 4.0.0
cpuNum Integer The number of CPU cores. 4.0.0
createDate Timestamp The time when the gateway was created. 4.0.0
lastOpDate Timestamp The time when the was gateway last modified. 4.0.0
provisionNic BareMetal2GatewayProvisionNicInventory See provisionNic. 4.0.0
#provisionNic
Name Type Description Starting Version
uuid String The NIC UUID. 4.0.0
networkUuid String The deployment network UUID. 4.0.0
interfaceName String The name of the NIC. 4.0.0
ip String The IP address of the NIC. 4.0.0
netmask String The netmask of the NIC. 4.0.0
gateway String The gateway IP address. 4.0.0
metadata String 4.0.0
createDate Timestamp The time when the NIC was created. 4.0.0
lastOpDate Timestamp The time when the NIC was last modified. 4.0.0

SDK Sample

Java SDK
DetachBareMetal2GatewayFromClusterAction action = new DetachBareMetal2GatewayFromClusterAction();
action.clusterUuid = "d2b8680d85ec3ffe9e25764059f74ef3";
action.gatewayUuid = "2576cacdeef53f13963547db023b6679";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DetachBareMetal2GatewayFromClusterAction.Result res = action.call();
Python SDK
DetachBareMetal2GatewayFromClusterAction action = DetachBareMetal2GatewayFromClusterAction()
action.clusterUuid = "d2b8680d85ec3ffe9e25764059f74ef3"
action.gatewayUuid = "2576cacdeef53f13963547db023b6679"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DetachBareMetal2GatewayFromClusterAction.Result res = action.call()