REST Resource: projects.locations.deliveryPipelines.automationRuns

资源：AutomationRun

Cloud Deploy API 中的 AutomationRun 资源。

AutomationRun 表示自动规则的执行实例。

JSON 表示法 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "serviceAccount": string,
  "automationSnapshot": {
    object (Automation)
  },
  "targetId": string,
  "state": enum (State),
  "stateDescription": string,
  "expireTime": string,
  "ruleId": string,
  "automationId": string,
  "waitUntilTime": string,

  // Union field operation can be only one of the following:
  "promoteReleaseOperation": {
    object (PromoteReleaseOperation)
  },
  "advanceRolloutOperation": {
    object (AdvanceRolloutOperation)
  },
  "repairRolloutOperation": {
    object (RepairRolloutOperation)
  }
  // End of list of possible types for union field operation.
}
字段
name

string

仅限输出。AutomationRun 的名称。格式为 projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/automationRuns/{automationRun}。
createTime

string (Timestamp format)

仅限输出。AutomationRun 的创建时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

仅限输出。automatedRun 的更新时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
etag

string

仅限输出。AutomationRun 资源的弱 etag。此校验和由服务器根据其他字段的值计算，并且可能会在更新和删除请求时发送，以确保客户端在继续操作之前拥有最新的值。
serviceAccount

string

仅限输出。对 Cloud Deploy 资源执行操作的用户管理的 IAM 服务帐号的电子邮件地址。
automationSnapshot

object (Automation)

仅限输出。在 AutomationRun 创建时截取的 Automation 快照。
targetId

string

仅限输出。目标的 ID，表示启动 AutomationRun 的升级阶段。此字段的值是目标名称的最后一部分。
state

enum (State)

仅限输出。AutomationRun的当前状态。
stateDescription

string

仅限输出。说明 AutomationRun 的当前状态。仅在需要说明时显示。
expireTime

string (Timestamp format)

仅限输出。AutomationRun的到期时间。AutomationRun会在创建之日起 14 天后过期。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
ruleId

string

仅限输出。启动了操作的自动化规则的 ID。
automationId

string

仅限输出。启动操作的自动化操作 ID。
waitUntilTime

string (Timestamp format)

仅限输出。AutomationRun 最早会尝试恢复。等待时间由 wait 在自动规则中配置。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
联合字段 operation。AutomationRun 将执行的操作。operation 只能是下列其中一项：
promoteReleaseOperation

object (PromoteReleaseOperation)

仅限输出。将版本提升到指定的“目标”。
advanceRolloutOperation

object (AdvanceRolloutOperation)

仅限输出。将发布推进到下一阶段。
repairRolloutOperation

object (RepairRolloutOperation)

仅限输出。修复失败的“发布”。

状态

AutomationRun 的有效状态。

枚举
STATE_UNSPECIFIED AutomationRun 处于未指定状态。
SUCCEEDED AutomationRun已成功。
CANCELLED AutomationRun已取消。
FAILED AutomationRun失败。
IN_PROGRESS AutomationRun正在进行中。
PENDING AutomationRun正在等待处理。
ABORTED AutomationRun 已取消。

PromoteReleaseOperation

包含自动版本发布操作的信息。

JSON 表示法 
{
  "targetId": string,
  "wait": string,
  "rollout": string,
  "phase": string
}
字段
targetId

string

仅限输出。目标的 ID，表示版本将提升到的提升阶段。此字段的值是目标名称的最后一部分。
wait

string (Duration format)

仅限输出。操作会暂停的时长。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
rollout

string

仅限输出。启动 AutomationRun 的发布的名称。
phase

string

仅限输出。此操作创建的发布的开始阶段。

AdvanceRolloutOperation

包含自动推进发布操作的信息。

JSON 表示法 
{
  "sourcePhase": string,
  "wait": string,
  "rollout": string,
  "destinationPhase": string
}
字段
sourcePhase

string

仅限输出。启动操作的部署阶段。
wait

string (Duration format)

仅限输出。操作会暂停的时长。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
rollout

string

仅限输出。启动 AutomationRun 的发布的名称。
destinationPhase

string

仅限输出。发布将推进到的阶段。

RepairRolloutOperation

包含自动 repair rollout 操作的信息。

JSON 表示法 
{
  "rollout": string,
  "currentRepairModeIndex": string,
  "repairPhases": [
    {
      object (RepairPhase)
    }
  ],
  "phaseId": string,
  "jobId": string
}
字段
rollout

string

仅限输出。启动 AutomationRun 的发布的名称。
currentRepairModeIndex

string (int64 format)

仅限输出。修复序列中当前修复操作的索引。
repairPhases[]

object (RepairPhase)

仅限输出。维修尝试记录。每个修复阶段都可能有多次重试尝试或单次回滚尝试。
phaseId

string

仅限输出。包含要修复的作业的阶段的阶段 ID。
jobId

string

仅限输出。要修复的作业的作业 ID。

RepairPhase

reCAPTCHA 会跟踪为 Automation 资源中指定的每个 RepairMode 所做的修复尝试。

JSON 表示法 
{

  // Union field repair_phase can be only one of the following:
  "retry": {
    object (RetryPhase)
  },
  "rollback": {
    object (RollbackAttempt)
  }
  // End of list of possible types for union field repair_phase.
}
字段

联合字段 repair_phase。

repair_phase 只能是下列其中一项：
retry

object (RetryPhase)

仅限输出。重试修复模式的重试尝试记录。
rollback

object (RollbackAttempt)

仅限输出。针对回滚修复模式的回滚尝试。

RetryPhase

RetryPhase 包含重试尝试以及用于启动新尝试的元数据。

JSON 表示法 
{
  "totalAttempts": string,
  "backoffMode": enum (BackoffMode),
  "phaseId": string,
  "jobId": string,
  "attempts": [
    {
      object (RetryAttempt)
    }
  ]
}
字段
totalAttempts

string (int64 format)

仅限输出。已尝试的次数。
backoffMode

enum (BackoffMode)

仅限输出。计算重试尝试等待时间的模式。
phaseId
(deprecated)

string

仅限输出。包含要重试的作业的阶段的阶段 ID。
jobId
(deprecated)

string

仅限输出。要重试的作业的作业 ID。
attempts[]

object (RetryAttempt)

仅限输出。重试操作的详细信息。

RetryAttempt

重试尝试表示重试失败的 Cloud Deploy 作业的操作。

JSON 表示法 
{
  "attempt": string,
  "wait": string,
  "state": enum (RepairState),
  "stateDesc": string
}
字段
attempt

string (int64 format)

仅限输出。此次重试尝试的索引。
wait

string (Duration format)

仅限输出。操作会暂停的时长。

该时长以秒为单位，最多包含九个小数位，以“s”结尾。示例："3.5s"。
state

enum (RepairState)

仅限输出。此重试操作的有效状态。
stateDesc

string

仅限输出。重试状态的说明。

RepairState

维修尝试的有效状态。

枚举
REPAIR_STATE_UNSPECIFIED repair 处于未指定状态。
REPAIR_STATE_SUCCEEDED repair操作已成功执行。
REPAIR_STATE_CANCELLED repair操作已取消。
REPAIR_STATE_FAILED repair操作失败。
REPAIR_STATE_IN_PROGRESS repair操作正在进行中。
REPAIR_STATE_PENDING repair操作待执行。
REPAIR_STATE_SKIPPED 已跳过repair操作。
REPAIR_STATE_ABORTED repair操作已中止。

RollbackAttempt

RollbackAttempt 表示回滚 Cloud Deploy“目标”的操作。

JSON 表示法 
{
  "destinationPhase": string,
  "rolloutId": string,
  "state": enum (RepairState),
  "stateDesc": string
}
字段
destinationPhase

string

仅限输出。发布将回滚到的阶段。
rolloutId

string

仅限输出。要创建的回滚 Rollout 的 ID。
state

enum (RepairState)

仅限输出。此回滚操作的有效状态。
stateDesc

string

仅限输出。回滚状态的说明。

方法

cancel

 取消 AutomationRun。

get

 获取单个 AutomationRun 的详细信息。

list

 列出给定项目和位置中的 AutomationRun。