Skip to main content
API Explorer|API Explorer
System Global Type/Long Job Operations
PUTLong Job OperationsSince 3.9.0SynchronousAuth Required

UpdateLongJob

UpdateLongJob

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    The resource UUID.

Body Fields

  • updatelongjobObjectRequired

    updatelongjob request body object.

    • nameString

      Optional. The resource name.

    • descriptionString

      Optional. The detailed description of the resource.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryLongJobInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • apiIdStringRequired

      The API ID used to associate with the task progress.

    • jobNameStringRequired

      The job name.

    • jobDataStringRequired

      The job data.

    • jobResultStringRequired

      The job result.

    • targetResourceUuidStringRequired

      The UUID of the target resource.

    • managementNodeUuidStringRequired

      The UUID of the management node.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • stateLongJobStateRequired

      See state.

      • WaitingLongJobStateRequired

        等待。

      • SuspendedLongJobStateRequired

        No description provided.

      • RunningLongJobStateRequired

        运行中。

      • SucceededLongJobStateRequired

        No description provided.

      • CancelingLongJobStateRequired

        No description provided.

      • CanceledLongJobStateRequired

        No description provided.

      • FailedLongJobStateRequired

        失败。

Endpoint

PUT/zstack/v1/longjobs/{uuid}/actions

/zstack/v1/longjobs/{uuid}/actions

Operation ID

UpdateLongJob

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/longjobs/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updatelongjob":{"name":"<name>","description":"<description>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "464cdf695427358696dae171544b67ef", "name": "new-name", "description": "new-description" } }

Change History

This API has no change history records yet.

View all change history