sp_help_job (Transact-SQL)

語法

sp_help_job { [ @job_id = ] job_id
[ @job_name = ] 'job_name' } 
     [ , [ @job_aspect = ] 'job_aspect' ] 
     [ , [ @job_type = ] 'job_type' ] 
     [ , [ @owner_login_name = ] 'login_name' ] 
     [ , [ @subsystem = ] 'subsystem' ] 
     [ , [ @category_name = ] 'category' ] 
     [ , [ @enabled = ] enabled ] 
     [ , [ @execution_status = ] status ] 
     [ , [ @date_comparator = ] 'date_comparison' ] 
     [ , [ @date_created = ] date_created ] 
     [ , [ @date_last_modified = ] date_modified ] 
     [ , [ @description = ] 'description_pattern' ]

引數

• [@job_id =] job_id
  作業識別碼。job_id 是 uniqueidentifier，預設值是 NULL。

• [@job_name =] 'job_name'
  作業的名稱。job_name 是 sysname，預設值是 NULL。

  [!附註]

  您必須指定 job_id 或 job_name，但不能同時指定這兩者。

• [@job_aspect =] 'job_aspect'
  這是要顯示的作業屬性。job_aspect 是 varchar(9)，預設值是 NULL，它可以是下列值之一。

  值	描述
  ALL	作業各方面的資訊
  JOB	作業資訊
  SCHEDULES	排程資訊
  STEPS	作業步驟資訊
  TARGETS	目標資訊

• [@job_type =] 'job_type'
  這是要併入報表中的作業類型。job_type 是 varchar(12)，預設值是 NULL。job_type 可以是 LOCAL 或 MULTI-SERVER。

• [@owner_login_name =] 'login_name'
  作業擁有者的登入名稱。login_name 是 sysname，預設值是 NULL。

• [@subsystem =] 'subsystem'
  子系統的名稱。subsystem 是 nvarchar(40)，預設值是 NULL。

• [@category_name =] 'category'
  類別目錄的名稱。category 是 sysname，預設值是 NULL。

• [@enabled =] enabled
  這是一個數字，指出所顯示的資訊是關於已啟用或停用之作業。enabled 是 tinyint，預設值是 NULL。1 表示已啟用的作業，0 表示已停用的作業。

• [@execution_status =] status
  作業的執行狀態。status 是 int，預設值是 NULL，它可以是下列值之一。

  值	描述
  0	只傳回未閒置或暫停的作業。
  1	執行中。
  2	正在等候執行緒。
  3	在重試之間。
  4	閒置。
  5	已暫停。
  7	正在執行完成動作。

• [@date_comparator =] 'date_comparison'
  用來比較 date_created 和 date_modified 的比較運算子。date_comparison 是 char(1)，它可以是 =、< 或 >。

• [@date_created =] date_created
  作業的建立日期。date_created 是 datetime，預設值是 NULL。

• [@date_last_modified =] date_modified
  上次修改作業的日期。date_modified 是 datetime，預設值是 NULL。

• [@description = ] 'description_pattern'
  作業的描述。description_pattern 是 nvarchar(512)，預設值是 NULL。description_pattern 可以包括用於模式比對的 SQL Server 萬用字元。

傳回碼值

0 (成功) 或 1 (失敗)

結果集

如果未指定任何引數，sp_help_job 便會傳回這個結果集。

如果指定了 job_id 或 job_name，sp_help_job 會傳回作業步驟、作業排程以及作業目標伺服器的這些附加結果集。

這是作業步驟的結果集。

這是作業排程的結果集。

這是作業目標伺服器的結果集。

權限

依預設，只有系統管理員 (sysadmin) 固定伺服器角色的成員，才能夠執行這個預存程序。其他使用者必須被授與 msdb 資料庫的下列其中一個 SQL Server Agent 固定資料庫角色。

• SQLAgentUserRole

• SQLAgentReaderRole

• SQLAgentOperatorRole

如需有關這些角色權限的詳細資料，請參閱＜SQL Server Agent 固定資料庫角色＞。

SQLAgentUserRole 的成員只能檢視他們自己的作業。系統管理員 (sysadmin)、SQLAgentReaderRole 和 SQLAgentOperatorRole 的成員可以檢視所有本機作業和多伺服器作業。

範例

A. 列出所有作業的資訊

USE msdb ;
GO

EXEC dbo.sp_help_job ;
GO

B. 列出符合特定準則之作業的資訊

USE msdb ;
GO

EXEC dbo.sp_help_job 
   @job_type = N'MULTI-SERVER',
   @owner_login_name = N'françoisa',
   @enabled = 1,
   @execution_status = 1 ;
GO

C. 列出作業各方面的資訊

USE msdb ;
GO

EXEC dbo.sp_help_job
    @job_name = N'NightlyBackups',
    @job_aspect = N'ALL' ;
GO

請參閱

參考