GetUploadSoftwarePackageJobDetails

GET/zstack/v1/software-package/upload-jobs/details/{softwarePackageId}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/software-package/upload-jobs/details/ff04e1736ec6391f9a1f023b524d0a00

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
softwarePackageIdStringurlThe software package ID (default is hash value). 4.10.20
systemTags (Optional)ListqueryThe system tags. 4.10.20
userTags (Optional)ListqueryThe user tags. 4.10.20

API Response

Sample Response

{
  "existingJobDetails": [
    {
      "longJobUuid": "ff05232082b53f4f8e657884f462f600",
      "longJobState": "Running",
      "softwarePackageUuid": "ff04e1736ec6391f9a1f023b524d0a00",
      "softwarePackageUploadUrl": "http://127.0.0.1:8001/host/file/upload",
      "offset": 452984832
    }
  ]
}
NameTypeDescriptionStarting Version
successbooleanThe operation success. True if success, false otherwise.4.10.20
existingJobDetailsListSee existingJobDetails.4.10.20
errorErrorCodeSee error.4.10.20

existingJobDetails

NameTypeDescriptionStarting Version
longJobUuidStringThe task UUID.4.10.20
longJobStateStringThe task status.4.10.20
softwarePackageUuidStringThe software package UUID.4.10.20
softwarePackageUploadUrlStringThe software package upload URL.4.10.20
offsetlongThe upload offset.4.10.20

error

NameTypeDescriptionStarting Version
codeStringThe error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.0.6
descriptionStringThe brief description of the error.0.6
detailsStringThe details about the error.0.6
elaborationStringReserved field. Default value: null.0.6
opaqueLinkedHashMapReserved field. Default value: null.0.6
causeErrorCodeThe root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.0.6

SDK Sample

Java SDK

GetUploadSoftwarePackageJobDetailsAction action = new GetUploadSoftwarePackageJobDetailsAction();
action.softwarePackageId = "ff04e1736ec6391f9a1f023b524d0a00";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetUploadSoftwarePackageJobDetailsAction.Result res = action.call();

Python SDK

action = GetUploadSoftwarePackageJobDetailsAction()
action.softwarePackageId = "ff04e1736ec6391f9a1f023b524d0a00"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()