Updated on 2023-11-21 GMT+08:00

Querying DLI Queues

Run ma-cli dli-job get-queue to query DLI queues.

ma-cli dli-job get-queue -h
Usage: ma-cli dli-job get-queue [OPTIONS]

  Get DLI queues info.

  Example:

  # Get DLI queue details by queue name
  ma-cli dli-job get-queue --queue-name $queue_name}

Options:
  -pn, --page-num INTEGER RANGE   Specify which page to query.  [x>=1]
  -ps, --page-size INTEGER RANGE  The maximum number of results for this query.  [x>=1]
  -n, --queue-name TEXT           Get DLI queue details by queue name.
  -t, --queue-type [sql|general|all]
                                  DLI queue type (default "all").
  -tags, --tags TEXT              Get DLI queues by tags.
  -C, --config-file PATH          Configure file path for authorization.
  -D, --debug                     Debug Mode. Shows full stack trace when error occurs.
  -P, --profile TEXT              CLI connection profile to use. The default profile is "DEFAULT".
  -H, -h, --help                  Show this message and exit.
Table 1 Parameters

Parameter

Type

Mandatory

Description

-n / --queue-name

String

No

Name of a DLI queue to be queried

-t / --queue-type

String

No

Type of DLI queues to be queried. The value can be sql, general, or all. The default value is all.

-tags / --tags

String

No

Tags of DLI queues to be queried

-pn / --page-num

Integer

No

DLI queue page index. The default value is page 1.

-ps / --page-size

Integer

No

Number of DLI queues displayed on each page. The default value is 20.

Example

Run the following command to query information about the dli_ma_notebook queue:

ma-cli dli-job get-queue --queue-name dli_ma_notebook