获取资源组中的所有成员
API 请求
URLs
GET zstack/v1/iam1/resource-ensemble
GET zstack/v1/iam1/resource-ensemble/{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/iam1/resource-ensemble?uuid=14c61568f49a45759c9a75c8fea4f854curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/iam1/resource-ensemble/14c61568f49a45759c9a75c8fea4f854?uuid=14c61568f49a45759c9a75c8fea4f854参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| uuid | String | query | 资源的UUID,资源组中任意成员即可 | 4.10.0 | |
| systemTags (可选) | List | query | 系统标签 | 4.10.0 | |
| userTags (可选) | List | query | 用户标签 | 4.10.0 |
API返回
返回示例
{
"inventory": {
"masterUuid": "14c61568f49a45759c9a75c8fea4f854",
"masterResourceName": "VM1",
"masterResourceType": "VmInstanceVO",
"members": [
{
"uuid": "c1abb7bd0de8489bb183d829c3ccde0e",
"resourceName": "vmcdrom-VM1",
"resourceType": "VmCdRomVO"
},
{},
{}
]
}
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 请求是否成功 | 4.10.0 |
| inventory | ResourceEnsembleInventory | 详情参考inventory | 4.10.0 |
| error | ErrorCode | 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error | 4.10.0 |
inventory
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| masterUuid | String | 资源组中主要资源的UUID | 4.10.0 |
| masterResourceName | String | 资源组中主要资源的名称 | 4.10.0 |
| masterResourceType | String | 资源组中主要资源的类型 | 4.10.0 |
| members | List | 详情参考members | 4.10.0 |
members
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标示该资源 | 4.0.0 |
| resourceName | String | 资源名称 | 4.0.0 |
| resourceType | String | 资源类型 | 4.0.0 |
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
GetResourceEnsembleMembersAction action = new GetResourceEnsembleMembersAction();
action.uuid = "14c61568f49a45759c9a75c8fea4f854";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetResourceEnsembleMembersAction.Result res = action.call();
Python SDK
GetResourceEnsembleMembersAction action = GetResourceEnsembleMembersAction()
action.uuid = "14c61568f49a45759c9a75c8fea4f854"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetResourceEnsembleMembersAction.Result res = action.call()