获取上传镜像任务详情

PUT/zstack/v1/images/upload-job/details/{imageId}

Request

cURL

curl --request PUT \
  --url '/v1/images/upload-job/details/{imageId}' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/images/upload-job/details/{imageId}"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "setImageBootMode": {
    "bootMode": "Legacy"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/images/upload-job/details/d41d8cd98f00b204e9800998ecf8427e?

参数列表

名字	类型	位置	描述	起始版本
imageId	String	url	上传镜像的唯一标识，由用户自定义，推荐使用 md5	4.1.0
systemTags (可选)	List	body	系统标签	4.1.0
userTags (可选)	List	body	用户标签	4.1.0

API返回

返回示例

{
  "existingJobDetails": [
    {
      "longJobUuid": "0792dd52aeb9329cb1e677fae6465f23",
      "longJobState": "Suspended",
      "imageUuid": "ccf943310d86335bb3d2511ca8e14137",
      "imageUploadUrl": "http://127.0.0.1:8001/imagestore/upload",
      "offset": 452984832.0
    }
  ]
}

名字	类型	描述	起始版本
success	boolean		4.1.0
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.1.0
existingJobDetails		详情参考existingJobDetails	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

existingJobDetails

名字	类型	描述	起始版本
longJobUuid	String	长任务UUID	4.1.0
longJobState	String	长任务状态	4.1.0
imageUuid	String	镜像UUID	4.1.0
imageUploadUrl	String	镜像上传URL	4.1.0
offset	long	上传偏移量，单位为 Byte	4.1.0

SDK示例

Java SDK

GetUploadImageJobDetailsAction action = new GetUploadImageJobDetailsAction();
action.imageId = "d41d8cd98f00b204e9800998ecf8427e";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetUploadImageJobDetailsAction.Result res = action.call();

Python SDK

GetUploadImageJobDetailsAction action = GetUploadImageJobDetailsAction()
action.imageId = "d41d8cd98f00b204e9800998ecf8427e"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetUploadImageJobDetailsAction.Result res = action.call()