sp_help_jobstep (Transact-SQL)

返回有关 SQL Server 代理服务在执行自动活动时使用的作业中的步骤信息。

语法

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	tinyint	如果步骤成功，则采取下列某个后续操作： 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。
服务器	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	步骤上一次开始执行的时间。
proxy_id	int	作业步骤的代理。

备注

sp_help_jobstep 位于 msdb 数据库中。

权限

默认情况下，只有 sysadmin 固定服务器角色的成员才可以执行此存储过程。其他用户必须被授予 msdb 数据库中下列 SQL Server 代理固定数据库角色的权限之一：

• SQLAgentUserRole
• SQLAgentReaderRole
• SQLAgentOperatorRole

有关这些角色的权限的详细信息，请参阅 SQL Server 代理固定数据库角色。

SQLAgentUserRole 的成员只可以查看其所拥有作业的步骤。

示例

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

以下示例返回名为 Weekly Sales Data Backup 的作业的所有作业步骤。

USE msdb ;
GO

EXEC dbo.sp_help_jobstep
    @job_name = N'Weekly Sales Data Backup' ;
GO

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

以下示例返回名为 Weekly Sales Data Backup 的作业的第一个作业步骤的信息。

USE msdb ;
GO

EXEC dbo.sp_help_jobstep
    @job_name = N'Weekly Sales Data Backup',
    @step_id = 1 ;
GO

请参阅

参考

sp_add_jobstep (Transact-SQL)
sp_delete_jobstep (Transact-SQL)
sp_help_job (Transact-SQL)
sp_update_jobstep (Transact-SQL)
系统存储过程 (Transact-SQL)

帮助和信息

获取 SQL Server 2005 帮助