job run logs

Retrieve the job run logs for a specific project or space. You must set either project_id or space_id.

Syntax

cpd-cli job run logs \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--jmes-query=<jmespath-query>] \
--job-id=<job-id> \
[--limit=<resource-limit>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-profile-name> \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
--run-id=<job-run-id> \
[--space-id=<space-identifier>] \
[--verbose]

Arguments

The job run logs command has no arguments.

Options

Table 1: Command options
Option Description
--context Specify the configuration context
 name.
Status
Optional.
Syntax
--context=<catalog-project-or-space-id>
Default value
Not applicable.
Valid values
A valid configuration context name.
--cpd-config The Cloud Pak for Data
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.
--cpd-scope The Cloud Pak for Data space, project, or catalog scope. For example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135.
Status
Optional.
Syntax
--cpd-scope=<cpd-scope>
Default value
No default.
Valid values
A valid Cloud Pak for Data space, project, or catalog scope.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--jmes-query Provide a JMESPath query to customize the output.
Status
Optional.
Syntax
--jmes-query=<jmespath-query>
Default value
No default.
Valid values
A valid JMESPath query.
--job-id Specify the job ID. Each job has a unique ID. Alternatively, the serving_name value can be used.
Status
Required.
Syntax
--job-id=<job-id>
Default value
No default.
Valid values
A valid job ID.
--limit Specify the total number of resources.
Status
Optional.
Syntax
--limit=<resource-limit>
Default value
100
Valid values
An integer value in the range 0 - 200.
--output Specify an output format.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
Valid formats include JSON, YAML, or text (the default format).
--output-file Specify a file path where all output is redirected.
Status
Optional.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--profile The name of the profile that you created to store information about an instance of Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--project-id Specify a Cloud Pak for Data project instance.
Status
Required.
Syntax
--project-id=<cpd-project-id>
Default value
No default.
Valid values
A valid project identifier.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values are not surrounded by quotation marks in
 JSON output mode.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--run-id Specify a job run ID. The job run ID can be used to search the parent job of a job run.
Status
Required.
Syntax
--run-id=<job-run-id>
Default value
No default.
Valid values
A valid job run ID.
--space-id Specify a space identifier.
Status
Required.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can add the listed environment variables to the installation variables script. For more information, see Setting up installation environment variables.
Specify the environment variables in a script file.
Replace the following properties with your data.
JOB_ID = <The unique job identifier>
RUN_ID = <The job run identifier>
SPACE_ID = <The deployment space identifier>
View the batch deployment log.
cpd-cli job run logs \
--job-id=${JOB_ID} \
--run-id=${RUN_ID} \
--space-id=${SPACE_ID}
Example results.

{
  "deployment": {
    "id": "865c5d4b-3439-438a-a2a0-48305237f46d"
  },
  "hardware_spec": {
    "id": "f3ebac7d-0a75-410c-8b48-a931428cc4c5"
  },
  "platform_job": {
    "job_id": "2bb4ef91-cd73-4748-a10a-6316b2a71550",
    "run_id": "b558937d-66f1-4d7d-8182-aa1c3ce49cf9"
  },
  "scoring": {
    "input_data_references": [
      {
        "connection": {},
        "location": {
          "href": "/v2/assets/093424a6-c966-447e-8552-7f2d991f9a76?space_id=f67d7982-7dd0-4ed3-9161-503145f4e0ae"
        },
        "type": "data_asset"
      }
    ],
    "output_data_reference": {
      "connection": {},
      "location": {
        "href": "/v2/assets/ba81206c-6f95-4200-b31d-727ba94b85fb?space_id=f67d7982-7dd0-4ed3-9161-503145f4e0ae"
      },
      "type": "data_asset"
    },
    "status": {
      "completed_at": "2021-05-21T15:04:16.176386Z",
      "message": {
        "level": "warning",
        "text": "The directory pointed by the environment variable BATCH_OUTPUT_DIR is empty, skipping content upload to data asset"
      },
      "running_at": "2021-05-21T15:03:56.490537Z",
      "state": "completed"
    }
  }
}