job: object

Virtual Storage Platform One SDS Cloud for Microsoft Azure Data Migration

Version
1.18.x
Audience
anonymous
Part Number
MK-24VSP1SDS032-02

DESCRIPTION

Job information.

PROPERTIES

jobId: string (uuid)
Job ID.
self: string (link)
URL to access a target job record.
EXAMPLE
"/ConfigurationManager/simple/v1/objects/jobs/56c698c5-7263-4996-90f7-b0ddc840b410"
userId: string (5 to 255 chars) , must match /^[\-A-Za-z0-9!#\$%&'\.@\^_`\{\}~]{5,255}$/
The ID of the user who issued the API that triggers creation of the job.
status: string , x ∈ { "Initializing" , "Running" , "Completed" }
The progress of the job.
  • Initializing: Being initialized.

  • Running: Being executed.

  • Completed

state: string , x ∈ { "Queued" , "Started" , "StorageAccepted" , "Stopping" , "Succeeded" , "Failed" , "Stopped" , "Unknown" }
The job status.
  • Queued: The job is queued.

  • Started: The job is started.

  • StorageAccepted: The request is accepted by the storage cluster.

  • Stopping: The job is in the progress of being stopped.

  • Succeeded: The job succeeded.

  • Failed: The job could not be executed.

  • Stopped: The job is stopped.

  • Unknown: The job status is unknown.

createdTime: string (date-time)
The time when the job was created.
updatedTime: string (date-time)
The time when the job state was updated.
completedTime: string (date-time) nullable
The time when the job was completed. Returns null if the job is not completed.
request: request: object
affectedResources: string[] nullable
URLs used to access the target resource for the job.
Basically, if one API uses multiple resources, URLs of all target resources are returned. If a job is unsuccessful, only URLs of the resources of which jobs are confirmed to be completed are returned.
If resources are deleted successfully, the URLs of the deleted resources are returned. In this case, access the returned URLs. If 404 Not Found appears, the resource is deleted successfully.
As exceptions, for APIs listed below for which a large amount of resources might be returned, the following URL is returned in affectedResources.

API

Execution conditions

URL returned in affectedResources

POST /v1/objects/volume-server-connections

When only one volume is connected.

/ConfigurationManager/simple/v1/objects/volume-server-connections/<volumeId>,<serverId>

When multiple volumes are connected.

/ConfigurationManager/simple/v1/objects/volume-server-connections?serverId=<serverId>

POST /v1/objects/volume-server-connections/actions/release/invoke

When only one volume is disconnected.

/ConfigurationManager/simple/v1/objects/volume-server-connections/<volumeId>,<serverId>

When multiple volumes are disconnected.

/ConfigurationManager/simple/v1/objects/volume-server-connections?serverId=<serverId>

POST /v1/objects/servers/<id>/paths

When both hbaId and portId are specified, and the connection to the resource succeeded.

/ConfigurationManager/simple/v1/objects/servers/<id>/paths/<hbaId>,<portId>

When portId is omitted or both hbaId and portId are omitted, and connection to one or more resources succeeded.

/ConfigurationManager/simple/v1/objects/servers/<id>/paths

DELETE /v1/objects/servers/<id>/hbas/<hbaId>

When one or more connections between the target initiators and compute ports are released.

/ConfigurationManager/simple/v1/objects/servers/<id>/paths

When the initiator is deleted.

/ConfigurationManager/simple/v1/objects/servers/<id>/hbas/<hbaId>

DELETE /v1/objects/servers/<id>

When one or more target initiators and compute ports are released.

/ConfigurationManager/simple/v1/objects/servers/<id>/paths

When one or more initiators are deleted.

/ConfigurationManager/simple/v1/objects/servers/<id>/hbas

When one or more connections between the compute nodes and volumes are released.

/ConfigurationManager/simple/v1/objects/volume-server-connections/<volumeId>,<serverId>

When the compute node is deleted.

/ConfigurationManager/simple/v1/objects/servers/<id>

POST /v1/objects/encryption-keys

When one or more encryption keys are created.

/ConfigurationManager/simple/v1/objects/encryption-keys

ITEMS
string (link)
error: errorResponse: object nullable