获取可选择的主存储(GetCandidatePrimaryStoragesForCreatingVm)

获取创建云主机可选择的主存储。用户可通过指定云主机参数,来获取当前参数下可选择的主存储。

API请求

URLs
GET zstack/v1/vm-instances/candidate-storages
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vm-instances/candidate-storages?imageUuid=5f977e1354aa300bb27e0584d52bb09a&l3NetworkUuids=0276c5ffc04731d6b671c972272bd10a&dataDiskOfferingUuids=0b2b7ff196113ed79dad6bf815a6033e&dataDiskOfferingUuids=cfad76f5d345387d9215773fcd5389c5&clusterUuid=90fac86c000b335396f995bef052fb41
参数列表
名字 类型 位置 描述 可选值 起始版本
imageUuid String query 镜像UUID 2.1
l3NetworkUuids List query 三层网络UUID 2.1
rootDiskOfferingUuid (可选) String query 根云盘使用的云盘规格UUID,镜像类型为ISO时可选且必选 2.1
dataDiskOfferingUuids (可选) List query 数据云盘使用的云盘规格UUID 2.1
zoneUuid (可选) String query 区域UUID 2.1
clusterUuid (可选) String query 集群UUID 2.1
defaultL3NetworkUuid (可选) String query 默认三层网络UUID 2.1
systemTags (可选) List query 系统标签 2.1
userTags (可选) List query 用户标签 2.1

API返回

返回示例
{
  "rootVolumePrimaryStorages": [
    {
      "uuid": "971ff3d5e8864cf691a8251022f400e2",
      "name": "example",
      "url": "/zstack_ps",
      "description": "example",
      "totalCapacity": 3.221225472E11,
      "availableCapacity": 2.147483648E11,
      "totalPhysicalCapacity": 3.221225472E11,
      "availablePhysicalCapacity": 2.147483648E11,
      "type": "LocalStorage",
      "state": "Enabled",
      "status": "Connected",
      "createDate": "Nov 9, 2017 9:38:50 PM",
      "lastOpDate": "Nov 9, 2017 9:38:50 PM",
      "attachedClusterUuids": [
        "1332f8ffa99844c6ae7286ca15bb6846"
      ]
    }
  ],
  "dataVolumePrimaryStorages": {
    "c1e5bafa00ce49368600670b9d724e7b": [
      {
        "uuid": "f9e90cd9878a4184b3951196e054b978",
        "name": "example",
        "url": "/opt/zstack/nfsprimarystorage/prim-f9e90cd9878a4184b3951196e054b978",
        "description": "example",
        "totalCapacity": 3.221225472E11,
        "availableCapacity": 2.147483648E11,
        "totalPhysicalCapacity": 3.221225472E11,
        "availablePhysicalCapacity": 2.147483648E11,
        "type": "NFS",
        "state": "Enabled",
        "status": "Connected",
        "createDate": "Nov 9, 2017 9:38:50 PM",
        "lastOpDate": "Nov 9, 2017 9:38:50 PM",
        "attachedClusterUuids": [
          "b73387b8d0264553829b72b86e5c57f5"
        ]
      }
    ]
  }
}
名字 类型 描述 起始版本
dataVolumePrimaryStorages Map 数据云盘可选主存储,分别对应每一个数据云盘规格 2.1
success boolean 操作是否成功 2.1
rootVolumePrimaryStorages List 详情参考rootVolumePrimaryStorages 2.1
error ErrorCode 详情参考error 2.1
#rootVolumePrimaryStorages
名字 类型 描述 起始版本
uuid String 资源的UUID,唯一标示该资源 2.1
zoneUuid String 区域UUID 2.1
name String 资源名称 2.1
url String 2.1
description String 资源的详细描述 2.1
totalCapacity Long 2.1
availableCapacity Long 2.1
totalPhysicalCapacity Long 2.1
availablePhysicalCapacity Long 2.1
systemUsedCapacity Long 2.1
type String 2.1
state String 2.1
status String 2.1
mountPath String 2.1
createDate Timestamp 创建时间 2.1
lastOpDate Timestamp 最后一次修改时间 2.1
attachedClusterUuids List 2.1
#error
名字 类型 描述 起始版本
code String 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 2.1
description String 错误的概要描述 2.1
details String 错误的详细信息 2.1
elaboration String 保留字段,默认为null 2.1
opaque LinkedHashMap 保留字段,默认为null 2.1
cause ErrorCode 根错误,引发当前错误的源错误,若无原错误,该字段为null 2.1

SDK示例

Java SDK
GetCandidatePrimaryStoragesForCreatingVmAction action = new GetCandidatePrimaryStoragesForCreatingVmAction();
action.imageUuid = "5f977e1354aa300bb27e0584d52bb09a";
action.l3NetworkUuids = asList("0276c5ffc04731d6b671c972272bd10a");
action.dataDiskOfferingUuids = asList("0b2b7ff196113ed79dad6bf815a6033e","cfad76f5d345387d9215773fcd5389c5");
action.clusterUuid = "90fac86c000b335396f995bef052fb41";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetCandidatePrimaryStoragesForCreatingVmAction.Result res = action.call();
Python SDK
GetCandidatePrimaryStoragesForCreatingVmAction action = GetCandidatePrimaryStoragesForCreatingVmAction()
action.imageUuid = "5f977e1354aa300bb27e0584d52bb09a"
action.l3NetworkUuids = [0276c5ffc04731d6b671c972272bd10a]
action.dataDiskOfferingUuids = [0b2b7ff196113ed79dad6bf815a6033e, cfad76f5d345387d9215773fcd5389c5]
action.clusterUuid = "90fac86c000b335396f995bef052fb41"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetCandidatePrimaryStoragesForCreatingVmAction.Result res = action.call()