list

Description

Lists the batch tasks by batch job OCID. You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTask to get the full details on a specific context List is incomplete until jobs lifecycle is in_progress

Usage

oci batch batch-task list [OPTIONS]

Required Parameters

--batch-job-id [text]

The OCID of the batch job.

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

--group-task-name [text]

Hierarchical name of the group task. A filter to return only tasks contained within the selected group task. Omit to return top-level tasks only. Can be combined with task name query parameter, in which case task name becomes a hierarchical name relative to the selected group task, e.g. ?groupTaskName=A.B&taskName=C.D is equal to ?taskName=A.B.C.D. Mutually exclusive with the task id query parameter: you can’t pass both.

--hierarchy-view [text]

Defines the hierarchical scope of the tasks to be returned. When set to SHALLOW, which is default, only tasks contained directly (non-recursively) within current hierarchy entry are returned. When set to DEEP, tasks contained within current hierarchy entry and all its descendants recursively are returned. The default hierarchy entry is root, i.e. batch job itself. To use a different hierarchy entry, provide the group task name as a query parameter. The specified group task becomes the entry point instead of the batch job.

Accepted values are:

DEEP, SHALLOW
--lifecycle-state [text]

A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

Accepted values are:

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
--limit [integer]

For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

--name [text]

The hierarchical name of the batch task. Mutually exclusive with the task id query parameter: you can’t pass both.

--page [text]

For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

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

The field to sort by. You can provide only one sort order. Default order for name is ascending.

Accepted values are:

name
--sort-order [text]

The sort order to use, either ascending (ASC) or descending (DESC).

Accepted values are:

ASC, DESC
--task-id [text]

The UUID of the batch task. Mutually exclusive with the task name and group task name query parameters: you can’t pass both.

--type [text]

Filter tasks by type. Valid values are: COMPUTE, GROUP.

Accepted values are:

COMPUTE, GROUP

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci batch batch-context create --generate-param-json-input fleets > fleets.json
    oci batch batch-context create --generate-param-json-input network > network.json

    oci batch batch-job create --generate-param-json-input tasks > tasks.json

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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/batch/batch-context/create.html#cmdoption-compartment-id

    batch_context_id=$(oci batch batch-context create --compartment-id $compartment_id --fleets file://fleets.json --network file://network.json --query data.id --raw-output)

    batch_job_pool_id=$(oci batch batch-job-pool create --batch-context-id $batch_context_id --compartment-id $compartment_id --query data.id --raw-output)

    batch_job_id=$(oci batch batch-job create --batch-job-pool-id $batch_job_pool_id --compartment-id $compartment_id --tasks file://tasks.json --query data.id --raw-output)

    oci batch batch-task list --batch-job-id $batch_job_id