通过

sp_help_jobstep (Transact-SQL)

  • 项目

适用范围：SQL Server

返回SQL Server 代理服务用于执行自动化活动的作业中的步骤的信息。

Transact-SQL 语法约定

语法

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

参数

[ @job_id = ] 'job_id'

要为其返回作业信息的作业标识号。 @job_id是 uniqueidentifier，默认值为 NULL.

必须指定@job_id或@job_name，但不能指定这两者。

[ @job_name = ] N'job_name'

作业的名称。 @job_name为 sysname，默认值为 NULL.

必须指定@job_id或@job_name，但不能指定这两者。

[ @step_id = ] step_id

作业中步骤的标识号。 如果尚未包括，则包括作业中的所有步骤。 @step_id为 int，默认值为 NULL.

[ @step_name = ] N'step_name'

作业中步骤的名称。 @step_name为 sysname，默认值为 NULL.

[ @suffix = ] 后缀

一个标志，指示是否将文本说明追加到 输出中的标志 列。 @suffix为位，默认值为 0. 如果为 @后缀1，则会追加说明。

返回代码值

0（成功）或 1（失败）。

结果集

列名称 数据类型 描述
step_id int 步骤的唯一标识符。
step_name sysname 作业中步骤的名称。
subsystem nvarchar(40) 执行步骤命令的子系统。
command nvarchar(max) 在步骤中执行的命令。
flags int 控制步骤行为的值的位掩码。
cmdexec_success_code int 对于 CmdExec 步骤，此值是成功命令的进程退出代码。
on_success_action tinyint 如果步骤成功，则采取下列某个后续操作：

1 = 退出作业报告成功。
2 = 退出作业报告失败。
3 = 转到下一步。
4 = 转到步骤。
on_success_step_id int 如果 on_success_action 为 4，则此值指示要执行的下一步。
on_fail_action tinyint 如果步骤失败了，应采取什么后续操作。 值与 on_success_action.
on_fail_step_id int 4如果是on_fail_action，则此值指示要执行的下一步。
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 和 PowerShell 步骤）。
last_run_outcome int 步骤上一次运行的结果：

0 = 失败
1 = Succeeded
2 = 重试
3 = 已取消
5 = 未知
last_run_duration int 上次运行步骤的持续时间（hhmmss）。
last_run_retries int 步骤上一次运行时，重试命令的次数。
last_run_date int 步骤上一次开始执行的日期。
last_run_time int 步骤上一次开始执行的时间。
proxy_id int 作业步骤的代理。

注解

sp_help_jobstep 位于 msdb 数据库中。

权限

可以授予 EXECUTE 此过程的权限，但在 SQL Server 升级期间可能会重写这些权限。

其他用户必须被授予数据库中以下SQL Server 代理固定数据库角色msdb之一：

  • 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

相关内容