检查部署IP是否可用(CheckStaticProvisionIp)

API请求

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": []
}

Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

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

参数列表

名字	类型	位置	描述	起始版本
clusterUuid	String	body(包含在params结构中)	集群UUID	5.2.0
provisionIp	String	body(包含在params结构中)	部署IP	5.2.0
systemTags (可选)	List	body	系统标签	5.2.0
userTags (可选)	List	body	用户标签	5.2.0

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

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

SDK示例

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

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

上一篇重连弹性裸金属实例(ReconnectBareMetal2Instance)下一篇通过弹性裸金属实例获取硬件信息(InspectBareMetal2ChassisByInstance)