REST Resource: projects.locations.schedules

資源:時間表

時間表的定義。

JSON 表示法
{
  "name": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "cronSchedule": string,
  "timeZone": string,
  "createTime": string,
  "updateTime": string,
  "executionTemplate": {
    object (ExecutionTemplate)
  },
  "recentExecutions": [
    {
      object (Execution)
    }
  ]
}
欄位
name

string

僅供輸出。這項排程的名稱。格式:projects/{projectId}/locations/{location}/schedules/{scheduleId}

displayName

string

僅供輸出。顯示名稱用於使用者介面。名稱只能包含英數字元、連字號 - 和底線 _

description

string

這個環境的簡短說明。

state

enum (State)

cronSchedule

string

工作執行的時間表 (Cron-tab 格式)。格式:分鐘、小時、月份中的日期、月份、星期幾,例如 0 0 * * WED = 每週三。更多範例:https://crontab.guru/examples.html

timeZone

string

cronSchedule 的時區。這個欄位的值必須是 tz 資料庫中的時區名稱。TZ 資料庫:https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

請注意,部分時區包含日光節約時間的規定。日光節約時間規則取決於所選時區。如要使用世界標準時間,請使用字串「utc」。如未指定時區,系統會預設使用世界標準時間 (亦稱為格林威治標準時間)。

createTime

string (Timestamp format)

僅供輸出。建立時間表的日期和時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

僅供輸出。上次更新時間表的日期。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

executionTemplate

object (ExecutionTemplate)

與這項排程對應的筆記本執行範本。

recentExecutions[]

object (Execution)

僅供輸出。這個排程觸發的最新執行作業名稱,以及對應的狀態。

狀態

工作狀態。

列舉
STATE_UNSPECIFIED 未指定狀態。
ENABLED 作業正常執行中。
PAUSED 使用者已暫停工作。系統不會執行。使用者可以透過 Cloud Scheduler 刻意暫停作業。
DISABLED 系統因發生錯誤而停用這項工作。使用者無法直接停用工作。
UPDATE_FAILED CloudScheduler.UpdateJob 作業失敗後的工作狀態。如要從這個狀態復原工作,請重試 CloudScheduler.UpdateJob,直到收到成功的回應為止。
INITIALIZING 正在建立時間表資源。
DELETING 正在刪除時間表資源。

方法

create

在指定專案和位置建立新的排程筆記本。

delete

刪除時間表和所有基礎工作

get

取得排程詳細資料

list

列出指定專案和位置中的排程。