NAME

logging_work-request_list -

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

DESCRIPTION

Lists the work requests in a compartment.

USAGE

oci logging work-request list [OPTIONS]

REQUIRED PARAMETERS

--compartment-id, -c [text]

Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal.

OPTIONAL PARAMETERS

--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--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

--id [text]

<b>Filter</b> results by OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm>. Must be an OCID of the correct type for the resource type.

--limit [integer]

The maximum number of items to return in a paginated “List” call.

--page [text]

For list pagination. The value of the opc-next-page or opc-previous-page response header from the previous “List” call. For important details about how pagination works, see List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order.

Accepted values are:

operationType, status, timeAccepted

--sort-order [text]

The sort order to use, whether ‘asc’ or ‘desc’.

Accepted values are:

ASC, DESC

--status [text]

Filter results by work request status.

Accepted values are:

ACCEPTED, CANCELED, CANCELLING, FAILED, IN_PROGRESS, SUCCEEDED

GLOBAL PARAMETERS

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

EXAMPLES

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 <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/logging/work-request/list.html#cmdoption-compartment-id
    oci logging work-request list --compartment-id $compartment_id

AUTHOR

Oracle

COPYRIGHT

2016, 2022, Oracle