Document navigation

CheckStaticProvisionIp

API Request

URLs

POST zstack/v1/baremetal2/bm-instances/static/provision/ip/check

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "clusterUuid": "25f9e4033cc13338b813cc239347843b",
    "provisionIp": "10.99.0.3"
  },
  "systemTags": [],
  "userTags": []
}

In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"clusterUuid":"25f9e4033cc13338b813cc239347843b","provisionIp":"10.99.0.3"}}' http://localhost:8080/zstack/v1/baremetal2/bm-instances/static/provision/ip/check

Request Parameters

Name Type Location Description Valid Values Starting Version
clusterUuid String body (contained in the params structure) The cluster UUID. 5.2.0
provisionIp String body (contained in the params structure) The provision IP address. 5.2.0
systemTags List body Optional. The system tags. 5.2.0
userTags List body Optional. The user tags. 5.2.0

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

{
    "error": {
        "code": "SYS.1001",
        "description": "A message or a operation timeout",
        "details": "Create VM on KVM timeout after 300s"
    }
}

SDK Sample

Java SDK

CheckStaticProvisionIpAction action = new CheckStaticProvisionIpAction();
action.clusterUuid = "25f9e4033cc13338b813cc239347843b";
action.provisionIp = "10.99.0.3";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CheckStaticProvisionIpAction.Result res = action.call();

Python SDK

action = CheckStaticProvisionIpAction()
action.clusterUuid = "25f9e4033cc13338b813cc239347843b"
action.provisionIp = "10.99.0.3"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()