CronJob

CronJob 代表單一 cron 任務的組態。

apiVersion: batch/v1

import "k8s.io/api/batch/v1"

CronJob

CronJob 代表單一 cron 任務的組態。

CronJobSpec

CronJobSpec 描述任務執行看起來會如何以及何時實際執行。

  • jobTemplate (JobTemplateSpec), 必填

    指定執行 CronJob 時將建立的任務。

    JobTemplateSpec 描述從範本建立任務時應具有的資料

  • schedule (字串), 必填

    Cron 格式的排程，請參閱 https://en.wikipedia.org/wiki/Cron。

  • timeZone (字串)

    給定排程的時區名稱，請參閱 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones。 若未指定，則預設為 kube-controller-manager 程序的時區。 有效時區名稱的集合和時區偏移量由 API 伺服器在 CronJob 驗證期間以及控制器管理員在執行期間從系統範圍的時區資料庫載入。 如果找不到系統範圍的時區資料庫，則改為使用資料庫的捆綁版本。 如果時區名稱在 CronJob 的生命週期內或由於主機組態變更而變為無效，則控制器將停止建立新的任務，並建立一個原因為 UnknownTimeZone 的系統事件。 更多資訊可在 https://kubernetes.dev.org.tw/docs/concepts/workloads/controllers/cron-jobs/#time-zones 中找到

  • concurrencyPolicy (字串)

    指定如何處理任務的並行執行。 有效值為

    • "Allow" (預設值)：允許 CronJob 並行執行； - "Forbid"：禁止並行執行，如果先前的執行尚未完成，則跳過下一次執行； - "Replace"：取消目前正在執行的任務，並以新的任務取代

  • startingDeadlineSeconds (int64)

    如果任務因任何原因錯過排定的時間，則啟動任務的可選期限（以秒為單位）。 錯過的任務執行將計為失敗。

  • suspend (布林值)

    此旗標告知控制器暫停後續執行，它不適用於已開始的執行。 預設值為 false。

  • successfulJobsHistoryLimit (int32)

    要保留的成功完成任務的數量。 值必須是非負整數。 預設值為 3。

  • failedJobsHistoryLimit (int32)

    要保留的失敗完成任務的數量。 值必須是非負整數。 預設值為 1。

CronJobStatus

CronJobStatus 代表 cron 任務的目前狀態。

  • active ([]ObjectReference)

    Atomic: 將在合併期間被取代

    目前正在執行的任務的指標清單。

  • lastScheduleTime (Time)

    上次成功排程任務的時間資訊。

    Time 是 time.Time 的包裝函式，支援正確地封送處理到 YAML 和 JSON。 為 time 套件提供的許多 factory 方法提供包裝函式。

  • lastSuccessfulTime (Time)

    上次任務成功完成的時間資訊。

    Time 是 time.Time 的包裝函式，支援正確地封送處理到 YAML 和 JSON。 為 time 套件提供的許多 factory 方法提供包裝函式。

CronJobList

CronJobList 是 cron 任務的集合。

操作

get 讀取指定的 CronJob

HTTP 請求

GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}

參數

  • name (在路徑中): 字串, 必填

    CronJob 的名稱

  • namespace (在路徑中): 字串, 必填

    命名空間

  • pretty (在查詢中): 字串

    pretty

回應

200 (CronJob): OK

401: 未經授權

get 讀取指定 CronJob 的狀態

HTTP 請求

GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status

參數

  • name (在路徑中): 字串, 必填

    CronJob 的名稱

  • namespace (在路徑中): 字串, 必填

    命名空間

  • pretty (在查詢中): 字串

    pretty

回應

200 (CronJob): OK

401: 未經授權

list 列出或監看 CronJob 類型的物件

HTTP 請求

GET /apis/batch/v1/namespaces/{namespace}/cronjobs

參數

回應

200 (CronJobList): OK

401: 未經授權

list 列出或監看 CronJob 類型的物件

HTTP 請求

GET /apis/batch/v1/cronjobs

參數

回應

200 (CronJobList): OK

401: 未經授權

create 建立 CronJob

HTTP 請求

POST /apis/batch/v1/namespaces/{namespace}/cronjobs

參數

回應

200 (CronJob): OK

201 (CronJob): 已建立

202 (CronJob)：已接受

401: 未經授權

update 取代指定的 CronJob

HTTP 請求

PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}

參數

  • name (在路徑中): 字串, 必填

    CronJob 的名稱

  • namespace (在路徑中): 字串, 必填

    命名空間

  • body: CronJob, 必填

  • dryRun (在查詢中): 字串

    dryRun

  • fieldManager (在查詢中): 字串

    fieldManager

  • fieldValidation (在查詢中): 字串

    fieldValidation

  • pretty (在查詢中): 字串

    pretty

回應

200 (CronJob): OK

201 (CronJob): 已建立

401: 未經授權

update 取代指定 CronJob 的狀態

HTTP 請求

PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status

參數

  • name (在路徑中): 字串, 必填

    CronJob 的名稱

  • namespace (在路徑中): 字串, 必填

    命名空間

  • body: CronJob, 必填

  • dryRun (在查詢中): 字串

    dryRun

  • fieldManager (在查詢中): 字串

    fieldManager

  • fieldValidation (在查詢中): 字串

    fieldValidation

  • pretty (在查詢中): 字串

    pretty

回應

200 (CronJob): OK

201 (CronJob): 已建立

401: 未經授權

patch 部分更新指定的 CronJob

HTTP 請求

PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}

參數

回應

200 (CronJob): OK

201 (CronJob): 已建立

401: 未經授權

patch 部分更新指定 CronJob 的狀態

HTTP 請求

PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status

參數

回應

200 (CronJob): OK

201 (CronJob): 已建立

401: 未經授權

delete 刪除 CronJob

HTTP 請求

DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}

參數

回應

200 (Status)：OK

202 (Status)：已接受

401: 未經授權

deletecollection 刪除 CronJob 集合

HTTP 請求

DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs

參數

回應

200 (Status)：OK

401: 未經授權

此頁面為自動產生。

如果您計劃回報此頁面的問題，請在您的問題描述中提及此頁面為自動產生。此修復可能需要在 Kubernetes 專案的其他地方進行。

上次修改時間為 2024 年 8 月 28 日下午 6:01 PST：更新 v1.31 (8ba98c79c1) 的自動產生 API 參考文件