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

请注意,某些时区包含夏令时规定。夏令时规则由所选 tz 确定。对于 UTC,请使用字符串“utc”。如果未指定时区,则默认采用 UTC(也称为 GMT)。

createTime

string (Timestamp format)

仅限输出。创建时间表的日期和时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 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 规范化(即转换为 UTC 零时区格式并在末尾附加 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

列出给定项目和位置中的时间表。