job list#
Description#
ジョブ一覧を出力します。
Examples#
基本的な使い方#
--job_type
にジョブの種類を指定してください。--job_type
に指定できる値は Command line options を参照してください。
以下のコマンドは、プロジェクトprj1の「アノテーションzipの更新」のジョブ一覧を出力します。
$ annofabcli job list --project_id prj1 --job_type gen-annotation
出力結果#
CSV出力#
$ annofabcli job list --project_id prj1 --job_type gen-annotation --format csv --output out.csv
JSON出力#
$ annofabcli job list --organization org1 --format pretty_json --output out.json
[
{
"project_id": "prj1",
"job_type": "gen-annotation",
"job_id": "12345678-abcd-1234-abcd-1234abcd5678",
"job_status": "succeeded",
"job_execution": null,
"job_detail": null,
"created_datetime": "2020-12-23T03:02:56.478+09:00",
"updated_datetime": "2020-12-23T03:02:56.478+09:00"
},
...
]
Usage Details#
ジョブ一覧を出力します。
usage: annofabcli job list [-h] [--yes] [--endpoint_url ENDPOINT_URL]
[--annofab_user_id ANNOFAB_USER_ID]
[--annofab_password ANNOFAB_PASSWORD]
[--logdir LOGDIR] [--disable_log] [--debug] -p
PROJECT_ID --job_type
{copy-project,gen-inputs,gen-tasks,gen-annotation,gen-tasks-list,gen-inputs-list,delete-project,invoke-hook,move-project}
[-f {csv,json,pretty_json}] [-o OUTPUT]
[--csv_format CSV_FORMAT] [-q QUERY]
Named Arguments#
- -p, --project_id
対象のプロジェクトのproject_idを指定します。
- --job_type
Possible choices: copy-project, gen-inputs, gen-tasks, gen-annotation, gen-tasks-list, gen-inputs-list, delete-project, invoke-hook, move-project
ジョブタイプを指定します。
- -f, --format
Possible choices: csv, json, pretty_json
出力フォーマットを指定します。
Default: "csv"
- -o, --output
出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。
- --csv_format
CSVのフォーマットをJSON形式で指定します。
--format
がcsv
でないときは、このオプションは無視されます。file://
を先頭に付けると、JSON形式のファイルを指定できます。 指定した値はpandas.DataFrame.to_csv
の引数として渡されます。- -q, --query
JMESPath形式で指定します。出力結果の抽出や、出力内容の変更に利用できます。
global optional arguments#
- --yes
処理中に現れる問い合わせに対して、常に
yes
と回答します。- --endpoint_url
Annofab WebAPIのエンドポイントを指定します。
Default: "https://annofab.com"
- --annofab_user_id
Annofabにログインする際のユーザーID
- --annofab_password
Annofabにログインする際のパスワード
- --logdir
ログファイルを保存するディレクトリを指定します。
Default: .log
- --disable_log
ログを無効にします。
- --debug
HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。