文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›开发手册ZCF
文档目录

管理节点相关接口

查询管理节点(QueryManagementNode)

API请求

URLs
GET zstack/v1/management-nodes
GET zstack/v1/management-nodes/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth f5db0d0f90104a79b02c8f1c34dfc13b" \
-X GET http://localhost:8080/zstack/v1/management-nodes?q=uuid=2c0761c3720f4d2c93435f1b8edb1297
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 5ffa91907f3c4d0392d7daa73b1a0627" \
-X GET http://localhost:8080/zstack/v1/management-nodes/bc27558979364d7c9b34a7317965e0be

可查询字段

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

API返回

返回示例
{
  "inventories": [
    {
      "uuid": "188b2c6376c34d3687c5a7a19685ffa6",
      "hostName": "127.0.0.1",
      "joinDate": "May 11, 2017 1:22:44 PM",
      "heartBeat": "May 11, 2017 1:22:44 PM"
    }
  ]
}
名字 类型 描述 起始版本
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 0.6
inventories List 详情参考inventories 0.6
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 0.6
description String 错误的概要描述 0.6
details String 错误的详细信息 0.6
elaboration String 保留字段，默认为null 0.6
opaque LinkedHashMap 保留字段，默认为null 0.6
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 0.6
#inventories
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 0.6
hostName String 宿主机名称 0.6
joinDate Timestamp 加入时间 0.6
heartBeat Timestamp 心跳时间 0.6

SDK示例

Java SDK
ueryManagementNodeAction action = new QueryManagementNodeAction();
action.conditions = asList("uuid=7c2075262bb44872b6ceaef5ee94b089");
action.sessionId = "293267e661d8400ca3808ff5f445a6e8";
QueryManagementNodeAction.Result res = action.call();
Python SDK
QueryManagementNodeAction action = QueryManagementNodeAction()
action.conditions = ["uuid=3bcbd030e10746eeba9f8ea938f2647a"]
action.sessionId = "21526cb97ac541b6b27192b4c671ec08"
QueryManagementNodeAction.Result res = action.call()

获取当前版本(GetVersion)

API请求

URLs
PUT zstack/v1/management-nodes/actions
Body
{
  "getVersion": {},
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-X PUT -d '{"getVersion":{}}' http://localhost:8080/zstack/v1/management-nodes/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
systemTags (可选) List body 系统标签 0.6
userTags (可选) List body 用户标签 0.6

API返回

返回示例
{
  "version": "1.9.x"
}
名字 类型 描述 起始版本
version String 管理节点当前版本 0.6
success boolean 成功标志 0.6
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 0.6
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 0.6
description String 错误的概要描述 0.6
details String 错误的详细信息 0.6
elaboration String 保留字段，默认为null 0.6
opaque LinkedHashMap 保留字段，默认为null 0.6
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 0.6

SDK示例

Java SDK
GetVersionAction action = new GetVersionAction();
GetVersionAction.Result res = action.call();
Python SDK
GetVersionAction action = GetVersionAction()
GetVersionAction.Result res = action.call()

获取当前时间(GetCurrentTime)

API请求

URLs
PUT zstack/v1/management-nodes/actions
Body
{
  "getCurrentTime": {},
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-X PUT -d '{"getCurrentTime":{}}' http://localhost:8080/zstack/v1/management-nodes/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
systemTags (可选) List body 系统标签 0.6
userTags (可选) List body 用户标签 0.6

API返回

返回示例
{
  "currentTime": {
    "MillionSeconds": 1.494480176967E12,
    "Seconds": 1.494480176E9
  }
}
名字 类型 描述 起始版本
currentTime Map 管理节点当前时间 0.6
success boolean 成功标志 0.6
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 0.6
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 0.6
description String 错误的概要描述 0.6
details String 错误的详细信息 0.6
elaboration String 保留字段，默认为null 0.6
opaque LinkedHashMap 保留字段，默认为null 0.6
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 0.6

SDK示例

Java SDK
GetCurrentTimeAction action = new GetCurrentTimeAction();
GetCurrentTimeAction.Result res = action.call();
Python SDK
GetCurrentTimeAction action = GetCurrentTimeAction()
GetCurrentTimeAction.Result res = action.call()

获取管理节点当前的时区信息（GetPlatformTimeZone）

API请求

URLs
GET zstack/v1/management-nodes/platform-timezone
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/management-nodes/platform-timezone?
参数列表
名字 类型 位置 描述 可选值 起始版本
systemTags (可选) List body 系统标签 4.1.0
userTags (可选) List body 用户标签 4.1.0

API返回

返回示例
{
  "timezone": "Asia/Shanghai",
  "offset": "+8:00"
}
名字 类型 描述 起始版本
timezone String 时区名称 4.1.0
offset String 与GMT时间的时差 4.1.0
success boolean 4.1.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.1.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 4.1.0
description String 错误的概要描述 4.1.0
details String 错误的详细信息 4.1.0
elaboration String 保留字段，默认为null 4.1.0
opaque LinkedHashMap 保留字段，默认为null 4.1.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.1.0

SDK示例

Java SDK
GetPlatformTimeZoneAction action = new GetPlatformTimeZoneAction();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetPlatformTimeZoneAction.Result res = action.call();
Python SDK
GetPlatformTimeZoneAction action = GetPlatformTimeZoneAction()
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetPlatformTimeZoneAction.Result res = action.call()

检查管理节点是否能正常开始工作(IsReadyToGo)

API请求

URLs
GET zstack/v1/management-nodes/ready
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 61f9cb0129d749ebbd3d6052bfc759b2" \
-X GET http://localhost:8080/zstack/v1/management-nodes/ready?
参数列表
名字 类型 位置 描述 可选值 起始版本
managementNodeId (可选) String query 0.6
systemTags (可选) List query 系统标签 0.6
userTags (可选) List query 用户标签 0.6

API返回

返回示例：
{
  "managementNodeId": "28ff5884cbf83d48b2e50203a5f2e636"
}
名字 类型 描述 起始版本
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 0.6
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 0.6
description String 错误的概要描述 0.6
details String 错误的详细信息 0.6
elaboration String 保留字段，默认为null 0.6
opaque LinkedHashMap 保留字段，默认为null 0.6
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 0.6

SDK示例

Java SDK
IsReadyToGoAction action = new IsReadyToGoAction();
action.sessionId = "4feaf1772217415a876735801e468fac";
IsReadyToGoAction.Result res = action.call();
Python SDK
IsReadyToGoAction action = IsReadyToGoAction()
action.sessionId = "432b9a5c589c4c09b33b79d8272528be"
IsReadyToGoAction.Result res = action.call()

获取管理节点操作系统信息(GetManagementNodeOS)

API请求

URLs
PUT zstack/v1/management/actions
Body
{
  "getManagementNodeOS": {},
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-X PUT -d '{"getManagementNodeOS":{}}' http://localhost:8080/zstack/v1/management/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
systemTags (可选) List query 系统标签 4.1.0
userTags (可选) List query 用户标签 4.1.0

API返回

返回示例：
{
  "name": "Linux",
  "version": "5.4.0-33-generic"
}
名字 类型 描述 起始版本
name String 资源名称 4.1.0
version String 4.1.0
success boolean 4.1.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.1.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 4.1.0
description String 错误的概要描述 4.1.0
details String 错误的详细信息 4.1.0
elaboration String 保留字段，默认为null 4.1.0
opaque LinkedHashMap 保留字段，默认为null 4.1.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.1.0

SDK示例

Java SDK
GetManagementNodeOSAction action = new GetManagementNodeOSAction();
GetManagementNodeOSAction.Result res = action.call();
Python SDK
GetManagementNodeOSAction action = GetManagementNodeOSAction()
GetManagementNodeOSAction.Result res = action.call()

获取管理节点CPU架构类型(GetManagementNodeArch)

API请求

URLs
PUT zstack/v1/management-nodes/actions
Body
{
  "getManagementNodeArch": {},
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-X PUT -d '{"getManagementNodeArch":{}}' http://localhost:8080/zstack/v1/management-nodes/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
systemTags (可选) List query 系统标签 4.1.0
userTags (可选) List query 用户标签 4.1.0

API返回

返回示例：
{
  "architecture": "x86_64"
}
名字 类型 描述 起始版本
name String 资源名称 4.1.0
version String 4.1.0
success boolean 4.1.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.1.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 4.1.0
description String 错误的概要描述 4.1.0
details String 错误的详细信息 4.1.0
elaboration String 保留字段，默认为null 4.1.0
opaque LinkedHashMap 保留字段，默认为null 4.1.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.1.0

SDK示例

Java SDK
GetManagementNodeArchAction action = new GetManagementNodeArchAction();
GetManagementNodeArchAction.Result res = action.call();
Python SDK
GetManagementNodeArchAction action = GetManagementNodeArchAction()
GetManagementNodeArchAction.Result res = action.call()
上一篇容量管理相关接口下一篇灾备服务(Plus)
开发手册 | 4.8.38 | ZStack Cloud · ZCF | ZStack 资源中心