添加 ZCE-X

POST/zstack/v1/zce-x-plugin

Request

cURL

curl --request POST \
  --url '/v1/zce-x-plugin' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/zce-x-plugin"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "zce-x-storage",
    "managementIp": "172.0.0.1",
    "apiPort": 8056
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"zce-x-storage","managementIp":"172.0.0.1","apiPort":8056}}' \
http://localhost:8080/zstack/v1/zce-x-plugin

参数列表

名字	类型	位置	描述	起始版本
name	String	body(包含在`params`结构中)	ZCE-X 的名称	4.10.6
adminToken (可选)	String	body(包含在`params`结构中)	接管 ZCE-X 使用的访问令牌。接管时必填，初始化前则不需要填写	4.10.6
managementIp (可选)	String	body(包含在`params`结构中)	ZCE-X 的管理网 IP	4.10.6
apiPort (可选)	int	body(包含在`params`结构中)	ZCE-X 的 API 端口	4.10.6
resourceUuid (可选)	String	body(包含在`params`结构中)	资源 UUID	4.10.6
tagUuids (可选)	List	body(包含在`params`结构中)	标签 UUID 列表	4.10.6
systemTags (可选)	List	body	系统标签	4.10.6
userTags (可选)	List	body	用户标签	4.10.6

API返回

返回示例

{
  "inventory": {
    "uuid": "77e1393bf5aa4536a018b4c0c4e29c72",
    "name": "zce-x-plugin",
    "managementIp": "127.0.0.1",
    "apiPort": 8056,
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM"
  }
}

名字	类型	描述	起始版本
success	boolean	添加是否成功	4.10.6
inventory	ZceXInventory	详情参考inventory	4.10.6
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.10.6

inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.10.6
name	String	资源名称	4.10.6
managementIp	String	访问 ZCE-X 的 IP 地址	4.10.6
apiPort	int	访问 ZCE-X 的 API 端口	4.10.6
createDate	Timestamp	创建时间	4.10.6
lastOpDate	Timestamp	最后一次修改时间	4.10.6

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	4.10.0
description	String	错误的概要描述	4.10.0
details	String	错误的详细信息	4.10.0
elaboration	String	保留字段，默认为null	4.10.0
opaque	LinkedHashMap	保留字段，默认为null	4.10.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	4.10.0

SDK示例

Java SDK

AddZceXAction action = new AddZceXAction();
action.name = "zce-x-storage";
action.managementIp = "172.0.0.1";
action.apiPort = 8056;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddZceXAction.Result res = action.call();

Python SDK

AddZceXAction action = AddZceXAction()
action.name = "zce-x-storage"
action.managementIp = "172.0.0.1"
action.apiPort = 8056
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddZceXAction.Result res = action.call()