sp_help_jobstep (Transact-SQL)

Gäller för:SQL Server

Returnerar information för stegen i ett jobb som används av SQL Server Agent-tjänsten för att utföra automatiserade aktiviteter.

Transact-SQL syntaxkonventioner

Syntax

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

Arguments

[ @job_id = ] 'job_id'

Jobbets identifikationsnummer för att returnera jobbinformation. @job_id är unik identifierare, med standardvärdet .NULL

Antingen @job_id eller @job_name måste specificeras, men båda kan inte specificeras.

[ @job_name = ] N'job_name'

Namnet på tjänsten. @job_name är sysname, med standardvärdet .NULL

Antingen @job_id eller @job_name måste specificeras, men båda kan inte specificeras.

[ @step_id = ] step_id

Identifieringsnumret för steget i jobbet. Om det inte inkluderas ingår alla steg i jobbet. @step_id är int, med standardvärdet .NULL

[ @step_name = ] N'step_name'

Namnet på steget i jobbet. @step_name är sysname, med standardvärdet .NULL

[ @suffix = ] suffix

En flagga som anger om en textbeskrivning läggs till i flaggkolumnen i utdatan. @suffix är bit, med standardvärdet .0 Om @suffix är 1, läggs en beskrivning till.

Returnera kodvärden

0 (lyckades) eller 1 (fel).

Resultatuppsättning

Kolumnnamn Datatyp Description
step_id int Unik identifierare för steget.
step_name sysname Namnet på steget i jobbet.
subsystem nvarchar(40) Delsystem där stegkommandot ska utföras.
command nvarchar(max) Kommandot utförs i steget.
flags int En bitmask av värden som styr stegbeteende.
cmdexec_success_code int För ett CmdExec-steg är detta värde utgångskoden för processen för ett lyckat kommando.
on_success_action tinyint Åtgärder som kan vidtas om steget lyckas:

1 = Sluta jobbet och rapportera framgång.
2 = Sluta jobbet rapportera misslyckande.
3 = Gå till nästa steg.
4 = Gå till steget.
on_success_step_id int Om on_success_action är 4 indikerar detta värde nästa steg som ska utföras.
on_fail_action tinyint Vad man ska göra om steget misslyckas. Värdena är desamma som on_success_action.
on_fail_step_id int Om on_fail_action är , 4indikerar detta värde nästa steg som ska utföras.
server sysname Reserverat.
database_name sysname För ett Transact-SQL steg är detta värde databasen där kommandot exekveras.
database_user_name sysname För ett Transact-SQL steg är detta värde databasanvändarens kontext där kommandot exekveras.
retry_attempts int Maximalt antal gånger bör kommandot försökas om (om det misslyckas).
retry_interval int Intervall (i minuter) för eventuella försök att försöka igen.
os_run_priority int Reserverat.
output_file_name nvarchar(200) Filen till vilken kommandoutdata ska skrivas (endast Transact-SQL, CmdExec och PowerShell-stegen ).
last_run_outcome int Resultatet av steget förra gången det kördes:

0 = Misslyckades
1 = Lyckades
2 = Omprövning
3 = Inställd
5 = Okänt
last_run_duration int Varaktigheten (hhmmss) av steget senast det kördes.
last_run_retries int Antal gånger kommandot försöktes om sista gången steget kördes.
last_run_date int Datum för det sista steget som påbörjades utförande.
last_run_time int Tiden för att sista steget påbörjades utförande.
proxy_id int Proxy för jobbsteget.

Anmärkningar

sp_help_jobstep finns i databasen msdb .

Permissions

Du kan ge EXECUTE behörigheter för denna procedur, men dessa behörigheter kan åsidosättas vid en SQL Server-uppgradering.

Andra användare måste tilldelas en av följande SQL Server Agent-fasta databasroller i databasen msdb :

  • SQLAgentUserRole
  • SQLAgentReaderRole
  • SQLAgentOperatorRole

För detaljer om behörigheterna för dessa roller, se SQL Server Agent Fixed Database Roles.

Medlemmar i SQLAgentUserRole kan endast se jobbsteg för jobb som de äger.

Examples

A. Returinformation för alla steg i ett specifikt jobb

Följande exempel returnerar alla jobbsteg för jobbet som heter Weekly Sales Data Backup.

USE msdb;
GO

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

B. Returneringsinformation om ett specifikt arbetssteg

Följande exempel ger information om det första jobbsteget för jobbet som heter Weekly Sales Data Backup.

USE msdb;
GO

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