obshell 任务命令组

本文档介绍 obshell 的任务命令组，任务命令组可用于管理 obshell 任务。您可通过在命令中配置 -h/--help 选项查看命令的帮助信息，如 obshell task show -h --seekdb，其中 --seekdb 表示查看适用于 seekdb 的帮助信息。

obshell task show

使用该命令可展示指定任务的信息。

obshell task show [-i] [-d] [--port] [--seekdb] [-6] [-v]

# example
obshell task show --seekdb --port 2886

选项说明见下表：

选项名	是否必选	数据类型	默认值	说明
-i/--id	否	string	无	指定需要查看的任务的 ID。不指定的时候会默认展示当前正在执行的任务，若当前没有任务则不展示任务信息。
-d/--show_detail	否	无	无	该选项无需传值，命令中配置即表示展示任务的详细信息。
--port	否	int	2886	指定 obshell 的端口号。若不想通过该选项指定端口，也可通过环境变量 OBSHELL_PORT_FOR_SEEKDB 指定 obshell 端口。
--seekdb	否	无	无	该选项无需传值，配置即表示命令应用于 seekdb。
-6/--use-ipv6	否	无	无	该选项无需传值，配置即表示使用 IPv6。
-v/--verbose	否	无	无	该选项无需传值，命令中配置即表示输出详细的执行过程信息。

obshell task cancel

使用该命令可取消未完成的任务。

obshell task cancel -i [--port] [--seekdb] [-6] [-y]

# example
obshell task cancel -i 11 --seekdb

选项说明见下表：

选项名	是否必选	数据类型	默认值	说明
-i/--id	是	string	无	指定需要取消的任务的 ID。
--port	否	int	2886	指定 obshell 的端口号。若不想通过该选项指定端口，也可通过环境变量 OBSHELL_PORT_FOR_SEEKDB 指定 obshell 端口。
--seekdb	否	无	无	该选项无需传值，配置即表示命令应用于 seekdb。
-6/--use-ipv6	否	无	无	该选项无需传值，配置即表示使用 IPv6。
-y/--yes	否	无	无	该选项无需传值，命令中配置即表示跳过二次确认。

obshell task rollback

使用该命令可回滚已失败的任务。

obshell task rollback -i [--port] [--seekdb] [-6] [-y]

# example
obshell task rollback -i 11 --seekdb

选项说明见下表：

选项名	是否必选	数据类型	默认值	说明
-i/--id	是	string	无	指定需要回滚的任务的 ID。
--port	否	int	2886	指定 obshell 的端口号。若不想通过该选项指定端口，也可通过环境变量 OBSHELL_PORT_FOR_SEEKDB 指定 obshell 端口。
--seekdb	否	无	无	该选项无需传值，配置即表示命令应用于 seekdb。
-6/--use-ipv6	否	无	无	该选项无需传值，配置即表示使用 IPv6。
-y/--yes	否	无	无	该选项无需传值，命令中配置即表示跳过二次确认。

obshell task retry

使用该命令可重试已失败的任务。

obshell task retry -i [--port] [--seekdb] [-6] [-y]

# example
obshell task retry -i 11 --seekdb

选项说明见下表：

选项名	是否必选	数据类型	默认值	说明
-i/--id	是	string	无	指定需要重试的任务的 ID。
--port	否	int	2886	指定 obshell 的端口号。若不想通过该选项指定端口，也可通过环境变量 OBSHELL_PORT_FOR_SEEKDB 指定 obshell 端口。
--seekdb	否	无	无	该选项无需传值，配置即表示命令应用于 seekdb。
-6/--use-ipv6	否	无	无	该选项无需传值，配置即表示使用 IPv6。
-y/--yes	否	无	无	该选项无需传值，命令中配置即表示跳过二次确认。

obshell task pass

使用该命令可跳过已失败的任务。

obshell task pass -i [--port] [--seekdb] [-6] [-y]

# example
obshell task pass -i 11 --seekdb

选项说明见下表：

选项名	是否必选	数据类型	默认值	说明
-i/--id	是	string	无	指定需要跳过的任务的 ID。
--port	否	int	2886	指定 obshell 的端口号。若不想通过该选项指定端口，也可通过环境变量 OBSHELL_PORT_FOR_SEEKDB 指定 obshell 端口。
--seekdb	否	无	无	该选项无需传值，配置即表示命令应用于 seekdb。
-6/--use-ipv6	否	无	无	该选项无需传值，配置即表示使用 IPv6。
-y/--yes	否	无	无	该选项无需传值，命令中配置即表示跳过二次确认。

obshell task watch

使用该命令可实时查看指定任务的执行进度。

obshell task watch -i [--port] [--seekdb] [-6]

# example
obshell task watch -i 11 --seekdb

选项说明见下表：

选项名	是否必选	数据类型	默认值	说明
-i/--id	是	int	无	用于指定待查看的运行中任务的 ID。
--port	否	int	2886	指定 obshell 的端口号。若不想通过该选项指定端口，也可通过环境变量 OBSHELL_PORT_FOR_SEEKDB 指定 obshell 端口。
--seekdb	否	无	无	该选项无需传值，配置即表示命令应用于 seekdb。
-6/--use-ipv6	否	无	无	该选项无需传值，配置即表示使用 IPv6。