sp_help_jobstep

返回有关 SQLServerAgent 服务用来执行自动活动的作业的步骤的信息。

语法

sp_help_jobstep [ @job_id = ] 'job_id' |
    [ @job_name = ] 'job_name
    [ , [ @step_id = ] step_id ]
    [ , [ @step_name = ] 'step_name' ]
    [ , [ @suffix = ] suffix ]

参数

[@job_id =] 'job_id'

是为其返回作业信息的作业标识号。job_id 的数据类型为 uniqueidentifier，默认值为 NULL。

[@job_name =] 'job_name'

是作业名称。job_name 的数据类型为 sysname，默认值为 NULL。

说明必须指定 job_id 或 job_name，但不能两个都指定。

[@step_id =] step_id

作业中步骤的标识号。如果没有包括这项参数，则包含作业中所有的步骤。step_id 的数据类型为 int，默认值为 NULL。

[@step_name =] 'step_name'

是作业中步骤的名称。step_name 的数据类型为 sysname，默认值为 NULL。

[@suffix =] suffix

是一个标志，表示是否将一个文本描述追加到输出的 flags 列。suffix 的数据类型为 bit，默认值为 0。如果 suffix 是 1，则追加描述。

返回代码值

0（成功）或 1（失败）

结果集

列名	数据类型	描述
step_id	Int	步骤的唯一标识符。
step_name	sysname	作业中步骤的名称。
subsystem	nvarchar(40)	子系统，在该子系统中执行步骤命令。
command	nvarchar(3200)	在步骤中执行的命令。
flags	Int	控制步骤行为的值的位掩码。
cmdexec_success_code	Int	对于CmdExec 步骤，这是成功命令的进程退出代码。
on_success_action	timyint	如果步骤成功，将要采取的操作： 1 = 退出正在报告成功的作业。 2 = 退出正在报告失败的作业。 3 = 转至下一步骤。 4 = 转至步骤。
on_success_step_id	Int	如果 on_success_action 为 4，即指明下一步执行步骤 4。
on_fail_action	Tinyint	如果步骤失败了，应怎么办。值和 on_success_action 的值一样。
on_fail_step_id	Int	如果 on_fail_action 为 4，即指明下一步执行步骤 4。
server	sysname	保留。
database_name	sysname	对于 Transact-SQL 步骤，这是将在其中执行命令的数据库。
database_user_name	sysname	对于 Transact-SQL 步骤，这是数据库用户上下文，命令在这个用户上下文中执行。
retry_attempts	Int	应该对命令进行重试的最大次数（如果命令没有成功）。
retry_interval	Int	重试尝试的间隔（以分钟为单位）。
os_run_priority	Int	保留。
output_file_name	nvarchar(200)	命令的输出结果将要写入其中的文件（只针对 Transact-SQL 及 CmdExec 步骤）。
last_run_outcome	Int	步骤上一次运行的结果： 0 = 失败 1 = 成功 2 = 重试 3 = 取消 5 = 未知
last_run_duration	Int	步骤上一次运行的持续时间（以秒为单位）。
last_run_retries	Int	步骤上一次运行时，命令进行重试的次数。
last_run_date	Int	步骤上一次开始执行的日期。
last_run_time	Int	步骤上一次开始执行的时间。

权限

执行权限默认授予 public 角色。任何可以执行该过程的用户都可以对下列内容进行创建、删除或更新操作：作业、作业步骤、作业分类、作业调度、作业服务器、任务或作业历史信息。

示例

A. 返回特定作业中所有步骤的信息

下面的示例返回名为 Backup Files 的作业的所有作业步骤。

USE msdb
EXEC sp_help_jobstep @job_name = 'Backup Files'

B. 返回特定作业步骤的信息

下面的示例返回有关名为 Backup Files 的作业的第一个作业步骤的信息。

USE msdb
EXEC sp_help_jobstep @job_name = 'Backup Files', @step_id = 1

请参见