测试 ZCE-X 连接性

PUT/zstack/v1/zce-x-plugin/test-connection

Request

cURL

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

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/zce-x-plugin/test-connection"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "zceXTestConnection": {
    "managementIp": "172.0.0.1",
    "port": 8056,
    "url": "/api/v1/cluster/time"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"zceXTestConnection":{"managementIp":"172.0.0.1","port":8056,"url":"/api/v1/cluster/time"}}' \
http://localhost:8080/zstack/v1/zce-x-plugin/test-connection

参数列表

名字	类型	位置	描述	起始版本
managementIp (可选)	String	body(包含在`zceXTestConnection`结构中)	ZCE-X 的管理节点 IP	4.10.7
port (可选)	Integer	body(包含在`zceXTestConnection`结构中)	ZCE-X API 服务端口	4.10.7
uuid (可选)	String	body(包含在`zceXTestConnection`结构中)	ZCE-X VO 的 UUID	4.10.16
url (可选)	String	body(包含在`zceXTestConnection`结构中)	ZCE-X 测试连接使用 URL	4.10.7
adminToken (可选)	String	body(包含在`zceXTestConnection`结构中)	ZCE-X 的 access-token, 如果要检查 access-token 是否可用的话可以填入	4.10.16
systemTags (可选)	List	body	系统标签	4.10.7
userTags (可选)	List	body	用户标签	4.10.7

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

ZceXTestConnectionAction action = new ZceXTestConnectionAction();
action.managementIp = "172.0.0.1";
action.port = 8056;
action.url = "/api/v1/cluster/time";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ZceXTestConnectionAction.Result res = action.call();

Python SDK

action = ZceXTestConnectionAction()
action.managementIp = "172.0.0.1"
action.port = 8056
action.url = "/api/v1/cluster/time"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()