cancel

Description

Cancels a work request.

Usage

oci os work-request cancel [OPTIONS]

Required Parameters

--work-request-id [text]

The ID of the asynchronous request.

Optional Parameters

--force

Perform deletion without prompting for confirmation.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export work_request_id=<substitute-value-of-work_request_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os/work-request/cancel.html#cmdoption-work-request-id

    oci os work-request cancel --work-request-id $work_request_id

Other Examples

Description

Cancels the specified work request.

Command

 oci os work-request cancel --work-request-id 57f8e435-2569-4a4f-a670-e4b1c44814f0

Output

{
 "output": "Are you sure you want to delete this resource? [y/N]:"
}

Description

Cancels the specified work request without showing prompt for confirmation.

Command

 oci os work-request cancel --work-request-id 48042b6e-1e85-400b-921a-2f22b0018c83 --force

Output

{
 "output": null
}