查询 ZCE-X

GET/zstack/v1/zce-x-plugin

GET/zstack/v1/zce-x-plugin/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/zce-x-plugin?q=name=zce-x

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/zce-x-plugin/7746a57778193dcd9201c12a6dbc20fb

可查询字段

运行CLI命令行工具，输入QueryZceX并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "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
inventories	List	详情参考inventories	4.10.6
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.10.6

inventories

名字	类型	描述	起始版本
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

QueryZceXAction action = new QueryZceXAction();
action.conditions = asList("name=zce-x");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryZceXAction.Result res = action.call();

Python SDK

QueryZceXAction action = QueryZceXAction()
action.conditions = ["name=zce-x"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryZceXAction.Result res = action.call()