API请求
URLs
GET zstack/v1/container/management/endpointGET zstack/v1/container/management/endpoint/{uuid}Headers
Authorization: OAuth the-session-uuidCurl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/container/management/endpoint?q=uuid=cc5d714a283439ccbdfbe5bd2dfdf928curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/container/management/endpoint/13ed1b2a57243d089a432be9c63a21ed可查询字段
运行zstack-cli命令行工具,输入QueryContainerManagementEndpoint并按Tab键查看所有可查询字段以及可跨表查询的资源名。
API返回
返回示例
{
"inventories": [
{
"uuid": "e1ca68742cf63d13be781dc9f5e6b0a1",
"managementIp": "127.0.0.1",
"managementPort": 8080,
"vendor": "zaku"
}
]
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 5.3.0 | |
| error | ErrorCode | 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error | 5.3.0 |
| inventories | List | 详情参考inventories | 5.3.0 |
#error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 | 5.1.8 |
| description | String | 错误的概要描述 | 5.1.8 |
| details | String | 错误的详细信息 | 5.1.8 |
| elaboration | String | 保留字段,默认为null | 5.1.8 |
| opaque | LinkedHashMap | 保留字段,默认为null | 5.1.8 |
| cause | ErrorCode | 根错误,引发当前错误的源错误,若无原错误,该字段为null | 5.1.8 |
#inventories
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标示该资源 | 5.3.0 |
| name | String | 资源名称 | 5.3.0 |
| description | String | 资源的详细描述 | 5.3.0 |
| accessKeyId | String | 5.3.0 | |
| managementIp | String | 容器管理节点的IP地址 | 5.3.0 |
| managementPort | Integer | 容器管理节点的端口 | 5.3.0 |
| vendor | String | 容器管理节点的厂商 | 5.3.0 |
| createDate | Timestamp | 创建时间 | 5.3.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 5.3.0 |
SDK示例
Java
SDK
QueryContainerManagementEndpointAction action = new QueryContainerManagementEndpointAction();
action.conditions = asList("uuid=19061d927c793327b839e6cc7c2dff31");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryContainerManagementEndpointAction.Result res = action.call();Python
SDK
QueryContainerManagementEndpointAction action = QueryContainerManagementEndpointAction()
action.conditions = ["uuid=1e540422f5c53628873c01c0ff1c5328"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryContainerManagementEndpointAction.Result res = action.call()