sp_help_jobstep (Transact-sql)sp_help_jobstep (Transact-SQL)

適用対象: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse APPLIES TO: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

SQL ServerSQL Serverエージェントサービスが自動化された活動を実行するために使用するジョブのステップに関する情報を返します。Returns information for the steps in a job used by SQL ServerSQL Server Agent service to perform automated activities.

トピック リンク アイコン Transact-SQL 構文表記規則Topic link icon Transact-SQL Syntax Conventions

構文Syntax

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

引数Arguments

[ @job_id = ] 'job_id'ジョブ情報を返すジョブの識別番号を指定します。[ @job_id = ] 'job_id' The job identification number for which to return job information. job_iduniqueidentifier,、既定値は NULL です。job_id is uniqueidentifier, with a default of NULL.

[ @job_name = ] 'job_name'ジョブの名前。[ @job_name = ] 'job_name' The name of the job. job_namesysnameで、既定値は NULL です。job_name is sysname, with a default NULL.

注意

Job_idまたはjob_nameのいずれかを指定する必要がありますが、両方を指定することはできません。Either job_id or job_name must be specified, but both cannot be specified.

[ @step_id = ] step_idジョブのステップの識別番号を指定します。[ @step_id = ] step_id The identification number of the step in the job. 含まれていない場合は、ジョブのすべての手順が含まれます。If not included, all steps in the job are included. step_idint,、既定値は NULL です。step_id is int, with a default of NULL.

[ @step_name = ] 'step_name'ジョブのステップの名前。[ @step_name = ] 'step_name' The name of the step in the job. step_namesysname,、既定値は NULL です。step_name is sysname, with a default of NULL.

[ @suffix = ] suffix出力のflags列にテキストの説明を追加するかどうかを示すフラグです。[ @suffix = ] suffix A flag indicating whether a text description is appended to the flags column in the output. サフィックスビット,、既定値は0です。suffixis bit, with the default of 0. サフィックス1の場合は、説明が追加されます。If suffix is 1, a description is appended.

リターン コードの値Return Code Values

0 (成功) または1 (失敗)0 (success) or 1 (failure)

結果セットResult Sets

列名Column name データ型Data type [説明]Description
step_idstep_id intint ステップの一意識別子。Unique identifier for the step.
step_namestep_name sysnamesysname ジョブのステップの名前。Name of the step in the job.
サブsubsystem nvarchar (40)nvarchar(40) ステップ コマンドを実行するサブシステム。Subsystem in which to execute the step command.
メニューcommand nvarchar(max)nvarchar(max) コマンドを実行します。Command executed in the step.
示すflags intint ステップの動作を制御する値のビットマスク。A bitmask of values that control step behavior.
cmdexec_success_codecmdexec_success_code intint CmdExecステップの場合、これは成功したコマンドのプロセス終了コードです。For a CmdExec step, this is the process exit code of a successful command.
on_success_actionon_success_action tinyinttinyint ステップが成功した場合に実行するアクション:Action to take if the step succeeds:

1 = 成功を報告するジョブを終了します。1 = Quit the job reporting success.

2 = エラーを報告するジョブを終了します。2 = Quit the job reporting failure.

3 = 次の手順に進みます。3 = Go to the next step.

4 = ステップに進みます。4 = Go to step.
on_success_step_idon_success_step_id intint On_success_actionが4の場合は、次に実行する手順を示します。If on_success_action is 4, this indicates the next step to execute.
on_fail_actionon_fail_action tinyinttinyint ステップが失敗した場合の対処方法。What to do if the step fails. 値はon_success_actionと同じです。Values are same as on_success_action.
on_fail_step_idon_fail_step_id intint On_fail_actionが4の場合は、次に実行する手順を示します。If on_fail_action is 4, this indicates the next step to execute.
serverserver sysnamesysname 予約済み。Reserved.
database_namedatabase_name sysnamesysname
Transact-SQLTransact-SQL ステップの場合は、コマンドを実行するデータベース。For a Transact-SQLTransact-SQL step, this is the database in which the command executes.
database_user_namedatabase_user_name sysnamesysname
Transact-SQLTransact-SQL ステップの場合は、コマンドを実行するデータベース ユーザー コンテキスト。For a Transact-SQLTransact-SQL step, this is the database user context in which the command executes.
retry_attemptsretry_attempts intint 正常に実行できない場合にコマンドを再試行する最大回数。Maximum number of times the command should be retried (if it is unsuccessful).
retry_intervalretry_interval intint 再試行の間隔 (分)。Interval (in minutes) for any retry attempts.
os_run_priorityos_run_priority intint 予約済み。Reserved.
output_file_nameoutput_file_name nvarchar(200)nvarchar(200) コマンドの出力の書き込み先のファイル (Transact-SQLTransact-SQLCmdExec、およびPowerShellの手順のみ)。File to which command output should be written (Transact-SQLTransact-SQL, CmdExec, and PowerShell steps only).
last_run_outcomelast_run_outcome intint 最後に実行したときのステップの結果。Outcome of the step the last time it ran:

0 = 失敗0 = Failed

1 = 成功1 = Succeeded

2 = 再試行2 = Retry

3 = キャンセル3 = Canceled

5 = 不明5 = Unknown
last_run_durationlast_run_duration intint 最後に実行されたときのステップの期間 (hhmmss)。Duration (hhmmss) of the step the last time it ran.
last_run_retrieslast_run_retries intint 最後にステップを実行したときにコマンドが再試行された回数。Number of times the command was retried the last time the step ran.
last_run_datelast_run_date intint ステップの実行を最後に開始した日付。Date the step last started execution.
last_run_timelast_run_time intint ステップの実行を最後に開始した時刻。Time the step last started execution.
proxy_idproxy_id intint ジョブステップのプロキシ。Proxy for the job step.

解説Remarks

sp_help_jobstepmsdbデータベースにあります。sp_help_jobstep is in the msdb database.

アクセス許可Permissions

既定では、 sysadmin固定サーバーロールのメンバーは、このストアドプロシージャを実行できます。By default, members of the sysadmin fixed server role can execute this stored procedure. 他のユーザーには、 SQL ServerSQL Server msdb データベースの次のいずれかの エージェント固定データベース ロールが許可されている必要があります。Other users must be granted one of the following SQL ServerSQL Server Agent fixed database roles in the msdb database:

  • SQLAgentUserRoleSQLAgentUserRole

  • SQLAgentReaderRoleSQLAgentReaderRole

  • SQLAgentOperatorRoleSQLAgentOperatorRole

これらのロールの権限の詳細については、「 SQL Server エージェントの固定データベース ロール」を参照してください。For details about the permissions of these roles, see SQL Server Agent Fixed Database Roles.

SQLAgentUserRoleのメンバーは、自分が所有しているジョブのジョブステップのみを表示できます。Members of SQLAgentUserRole can only view job steps for jobs that they own.

Examples

A.A. 特定のジョブのすべてのステップに関する情報を返すReturn information for all steps in a specific job

次の例では、Weekly Sales Data Backup という名前のジョブに関する、すべてのジョブ ステップを返します。The following example returns all the job steps for the job named Weekly Sales Data Backup.

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

B.B. 特定のジョブステップに関する情報を返すReturn information about a specific job step

次の例では、という名前Weekly Sales Data Backupのジョブの最初のジョブステップに関する情報を返します。The following example returns information about the first job step for the job named Weekly Sales Data Backup.

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

参照See Also

sp_add_jobstep (Transact-sql) sp_add_jobstep (Transact-SQL)
sp_delete_jobstep (Transact-sql) sp_delete_jobstep (Transact-SQL)
sp_help_job (Transact-sql) sp_help_job (Transact-SQL)
sp_update_jobstep (Transact-sql) sp_update_jobstep (Transact-SQL)
システムストアドプロシージャ (Transact-sql)System Stored Procedures (Transact-SQL)