获取用于创建虚拟机的候选镜像

GET/zstack/v1/images/primaryStorage/{primaryStorageUuid}/candidate-image

Request

cURL

curl --request GET \
  --url '/v1/images/primaryStorage/{primaryStorageUuid}/candidate-image'

{
  "status": "ok",
  "method": "GET",
  "path": "/v1/images/primaryStorage/{primaryStorageUuid}/candidate-image"
}

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/images/primaryStorage/f9a502b0665b33faa19c15ebf389408f/candidate-image

参数列表

名字	类型	位置	描述	起始版本
primaryStorageUuid	String	url	数据存储UUID	4.1.1
systemTags (可选)	List	query	系统标签	4.1.1
userTags (可选)	List	query	用户标签	4.1.1

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

GetCandidateImagesForCreatingVmAction action = new GetCandidateImagesForCreatingVmAction();
action.primaryStorageUuid = "f9a502b0665b33faa19c15ebf389408f";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetCandidateImagesForCreatingVmAction.Result res = action.call();

Python SDK

GetCandidateImagesForCreatingVmAction action = GetCandidateImagesForCreatingVmAction()
action.primaryStorageUuid = "f9a502b0665b33faa19c15ebf389408f"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetCandidateImagesForCreatingVmAction.Result res = action.call()