Querying the Status of an Asynchronous Job
Function
This is an extension API. It is used to query for the execution status of an asynchronous job, for example, querying for the execution status of an image exporting job.
Request
Request parameters
None
Example Request
Querying the status of an asynchronous job
GET /v1/ac234de25c6741d2b1273da49eea1b9e/jobs/ff8080814dbd65d7014dbe0d84db0013
Response
- Response parameters
Parameter
Type
Description
status
String
Specifies the job status. The value can be:
- SUCCESS: The job is successfully executed.
- FAIL: The job failed to be executed.
- RUNNING: The job is in progress.
- INIT: The job is being initialized.
job_id
String
Specifies the job ID.
job_type
String
Specifies the job type.
- imsCreateImageByInstance: Creating a system disk image from a cloud server
- imsImportImageJob: Creating a system disk image from an external image file
- imsImportOvaImageJob: Creating an image from an OVA image file
- imsVolumeCreateImageJob: Creating a data disk image from a cloud server
- imsImportDataImageJob: Creating a data disk image from an external image file
- imsCreateWholeImageByInstanceJob: Creating a full-ECS image from an ECS
- imsCreateWholeImageByBackupJob: Creating a full-ECS image from a CBR or CSBS backup
- imsNativeImportImageJob: Registering an image
- imsNativeExportImageJob: Exporting image
- imsAddImageMembersJob: Adding tenants that can use a shared image
- imsDelImageMembersJob: Deleting tenants that can use a shared image
- imsUpdateImageMembersJob: Updating status of tenants who will accept or reject shared images
- imsCopyImageInRegionJob: Replicating images within a region
- imsCopyImageCrossUserJob: Replicating images across regions
begin_time
String
Specifies the start time of the job. The value is in UTC format.
end_time
String
Specifies the end time of the job. The value is in UTC format.
error_code
String
Specifies the error code.
fail_reason
String
Specifies the failure cause.
entities
Object
Specifies the custom attributes of the job.
If the job status is normal, the image ID will be returned. If the status is abnormal, an error code and details will be returned.
For details, see Table 2.
Table 2 Data structure description of the entities field Parameter
Type
Description
image_id
String
Specifies the image ID.
current_task
String
Specifies the job name.
image_name
String
Specifies the image name.
process_percent
Double
Specifies the job progress.
results
Array of result objects
Specifies job execution results. For details, see Table 3.
sub_jobs_result
Array of objects
Specifies sub-job execution results. For details, see Table 4.
sub_jobs_list
Array of string
Specifies the sub-job IDs.
addition_error_code
string
Adds an error code.
addition_error_msg
string
Adds an error message.
error_code
string
Specifies an error code.
error
string
Specifies an error message.
alarm_code
string
Specifies an alarm code.
Table 3 Data structure description of the result field Parameter
Type
Description
image_id
String
Specifies the image ID.
project_id
String
Specifies the project ID.
status
String
Specifies the job status.
Table 4 Data structure description of the SubJobResult field Parameter
Type
Description
status
String
Specifies the sub-job status. The value can be:
- SUCCESS: The sub-job is successfully executed.
- FAIL: The sub-job failed to be executed.
- RUNNING: The sub-job is in progress.
- INIT: The sub-job is being initialized.
job_id
String
Specifies a sub-job ID.
job_type
String
Specifies the sub-job type.
begin_time
String
Specifies the start time of the sub-job. The value is in UTC format.
end_time
String
Specifies the end time of the sub-job. The value is in UTC format.
error_code
String
Specifies the error code.
fail_reason
String
Specifies the failure cause.
entities
Object
Specifies the custom attributes of the sub-job. For details, see Table 5.
- If a sub-job is properly executed, an image ID is returned.
- If an exception occurs on the sub-job, an error code and associated information are returned.
- Example response
STATUS CODE 200
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
{ "status": "SUCCESS", "entities": { "image_id": "e9e91bff-14b6-4a0b-8377-4ed0813e3360", "image_name": "asdfasdfasdfas", "process_percent": 0.20, "current_task": "CreateImageByInstanceTask", "results": [{ "image_id": "49e9447f-7dff-41e0-8036-f66fe5488c8b", "project_id": "089b2f9a3d80d3062f24c00ca4ed5cbd", "status": "success" } ] }, "job_id": "ff8080814dbd65d7014dbe0d84db0013", "job_type": "createImageByInstance", "begin_time": "04-Jun-2015 18:11:06:586", "end_time": "", "error_code": null, "fail_reason": null }
Returned Values
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot