REST Resource: projects.locations.deliveryPipelines.releases.rollouts.jobRuns

资源：JobRun

Cloud Deploy API 中的 JobRun 资源。

JobRun 包含单个 Rollout 作业评估的信息。

JSON 表示法 
{
  "name": string,
  "uid": string,
  "phaseId": string,
  "jobId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "state": enum (State),
  "etag": string,

  // Union field job_run can be only one of the following:
  "deployJobRun": {
    object (DeployJobRun)
  },
  "verifyJobRun": {
    object (VerifyJobRun)
  },
  "predeployJobRun": {
    object (PredeployJobRun)
  },
  "postdeployJobRun": {
    object (PostdeployJobRun)
  },
  "createChildRolloutJobRun": {
    object (CreateChildRolloutJobRun)
  },
  "advanceChildRolloutJobRun": {
    object (AdvanceChildRolloutJobRun)
  }
  // End of list of possible types for union field job_run.
}
字段
name

string

可选。JobRun 的名称。格式为 projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}。
uid

string

仅限输出。JobRun 的唯一标识符。
phaseId

string

仅限输出。此 JobRun 所属的 Rollout 阶段的 ID。
jobId

string

仅限输出。此 JobRun 对应的 Rollout 作业的 ID。
createTime

string (Timestamp format)

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

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

string (Timestamp format)

仅限输出。JobRun 的开始时间。

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

string (Timestamp format)

仅限输出。JobRun的结束时间。

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

enum (State)

仅限输出。JobRun 的当前状态。
etag

string

仅限输出。此校验和由服务器根据其他字段的值计算，并且可能会在更新和删除请求时发送，以确保客户端在继续操作之前拥有最新的值。
联合字段 job_run。JobRun 类型以及该类型的相关信息。job_run 只能是下列其中一项：
deployJobRun

object (DeployJobRun)

仅限输出。特定于部署 JobRun 的信息。
verifyJobRun

object (VerifyJobRun)

仅限输出。特定于验证 JobRun 的信息。
predeployJobRun

object (PredeployJobRun)

仅限输出。部署前 JobRun 的专属信息。
postdeployJobRun

object (PostdeployJobRun)

仅限输出。特定于部署后 JobRun 的信息。
createChildRolloutJobRun

object (CreateChildRolloutJobRun)

仅限输出。特定于 createChildRollout JobRun 的信息。
advanceChildRolloutJobRun

object (AdvanceChildRolloutJobRun)

仅限输出。特定于 progressChildRollout JobRun 的信息

状态

JobRun 的有效状态。

枚举
STATE_UNSPECIFIED JobRun 处于未指定状态。
IN_PROGRESS JobRun正在进行中。
SUCCEEDED JobRun已成功。
FAILED JobRun失败。
TERMINATING JobRun即将终止。
TERMINATED JobRun已终止。

DeployJobRun

DeployJobRun 包含特定于部署 JobRun 的信息。

JSON 表示法 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string,
  "metadata": {
    object (DeployJobRunMetadata)
  },
  "artifact": {
    object (DeployArtifact)
  }
}
字段
build

string

仅限输出。用于部署的 Cloud Build Build 对象的资源名称。格式为 projects/{project}/locations/{location}/builds/{build}。
failureCause

enum (FailureCause)

仅限输出。部署失败的原因。部署正在进行或成功时，始终未指定该值。
failureMessage

string

仅限输出。有关部署失败的其他信息（如果有）。
metadata

object (DeployJobRunMetadata)

仅限输出。包含部署作业运行相关信息的元数据。
artifact

object (DeployArtifact)

仅限输出。运行部署作业的工件（如果有）。

FailureCause

已知的部署失败情况。

枚举
FAILURE_CAUSE_UNSPECIFIED 未指定失败原因。
CLOUD_BUILD_UNAVAILABLE Cloud Build 不可用，可能是因为它未启用，或者 Cloud Deploy 的权限不足。请参阅所需权限。
EXECUTION_FAILED 部署操作未成功完成；请检查 Cloud Build 日志。
DEADLINE_EXCEEDED 部署作业的运行未在分配的时间内完成。
MISSING_RESOURCES_FOR_CANARY 运行时环境中缺少 Canary 部署所需的资源。如需了解详情，请查看 Cloud Build 日志。
CLOUD_BUILD_REQUEST_FAILED Cloud Build 未能满足 Cloud Deploy 的请求。如需了解更多详情，请参阅 failedMessage。
DEPLOY_FEATURE_NOT_SUPPORTED 部署操作配置的功能不受支持。

DeployJobRunMetadata

DeployJobRunMetadata 向用户显示与 DeployJobRun 关联的信息。

JSON 表示法 
{
  "cloudRun": {
    object (CloudRunMetadata)
  },
  "customTarget": {
    object (CustomTargetDeployMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
字段
cloudRun

object (CloudRunMetadata)

仅限输出。与 DeployJobRun 关联的 Cloud Run 服务的名称。
customTarget

object (CustomTargetDeployMetadata)

仅限输出。与 DeployJobRun 关联的自定义目标元数据。
custom

object (CustomMetadata)

仅限输出。由用户定义的部署操作提供的自定义元数据。

CustomTargetDeployMetadata

CustomTargetDeployMetadata 包含来自 Custom Target 部署操作的信息。

JSON 表示法 
{
  "skipMessage": string
}
字段
skipMessage

string

仅限输出。跳过自定义部署操作结果中提供的消息。

DeployArtifact

部署操作生成的工件。

JSON 表示法 
{
  "artifactUri": string,
  "manifestPaths": [
    string
  ]
}
字段
artifactUri

string

仅限输出。包含制品的目录的 URI。所有路径均相对于此位置。
manifestPaths[]

string

仅限输出。部署操作期间应用的清单的文件路径（相对于 URI）。

VerifyJobRun

VerifyJobRun 包含特定于验证 JobRun 的信息。

JSON 表示法 
{
  "build": string,
  "artifactUri": string,
  "eventLogPath": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
字段
build

string

仅限输出。用于验证的 Cloud Build Build 对象的资源名称。格式为 projects/{project}/locations/{location}/builds/{build}。
artifactUri

string

仅限输出。包含验证制品的目录的 URI。此文件包含 Skaffold 事件日志。
eventLogPath

string

仅限输出。Skaffold 事件日志的文件路径（相对于工件 URI）。
failureCause

enum (FailureCause)

仅限输出。验证失败的原因。如果正在进行验证或验证成功，将始终未指定此字段。
failureMessage

string

仅限输出。有关验证失败的其他信息（如果有）。

FailureCause

已知验证失败。

枚举
FAILURE_CAUSE_UNSPECIFIED 未指定失败原因。
CLOUD_BUILD_UNAVAILABLE Cloud Build 不可用，可能是因为它未启用，或者 Cloud Deploy 的权限不足。查看所需权限。
EXECUTION_FAILED 验证操作未成功完成；请检查 Cloud Build 日志。
DEADLINE_EXCEEDED 验证作业的运行未在分配的时间内完成。
VERIFICATION_CONFIG_NOT_FOUND 未找到 Skaffold 验证配置。
CLOUD_BUILD_REQUEST_FAILED Cloud Build 未能满足 Cloud Deploy 的请求。如需了解更多详情，请参阅 failedMessage。

PredeployJobRun

PredeployJobRun 包含特定于部署前 JobRun 的信息。

JSON 表示法 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
字段
build

string

仅限输出。Cloud Build Build 对象的资源名称，用于执行与部署前作业关联的自定义操作。格式为 projects/{project}/locations/{location}/builds/{build}。
failureCause

enum (FailureCause)

仅限输出。预部署失败的原因。在预部署过程中或预部署成功时，将始终未指定该值。
failureMessage

string

仅限输出。有关部署前失败的更多信息（如果有）。

FailureCause

众所周知的部署前失败情况。

枚举
FAILURE_CAUSE_UNSPECIFIED 未指定失败原因。
CLOUD_BUILD_UNAVAILABLE Cloud Build 不可用，可能是因为它未启用，或者 Cloud Deploy 的权限不足。查看所需权限。
EXECUTION_FAILED 部署前操作未成功完成；请检查 Cloud Build 日志。
DEADLINE_EXCEEDED 部署前作业的运行未在分配的时间内完成。
CLOUD_BUILD_REQUEST_FAILED Cloud Build 未能满足 Cloud Deploy 的请求。如需了解更多详情，请参阅 failedMessage。

PostdeployJobRun

PostdeployJobRun 包含特定于部署后 JobRun 的信息。

JSON 表示法 
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
字段
build

string

仅限输出。Cloud Build Build 对象的资源名称，用于执行与部署后作业关联的自定义操作。格式为 projects/{project}/locations/{location}/builds/{build}。
failureCause

enum (FailureCause)

仅限输出。部署后失败的原因。如果部署正在进行中或部署成功，将始终未指定此值。
failureMessage

string

仅限输出。有关部署后失败的其他信息（如果有）。

FailureCause

众所周知的部署后失败。

枚举
FAILURE_CAUSE_UNSPECIFIED 未指定失败原因。
CLOUD_BUILD_UNAVAILABLE Cloud Build 不可用，可能是因为它未启用，或者 Cloud Deploy 的权限不足。查看所需权限。
EXECUTION_FAILED 部署后操作未成功完成；请检查 Cloud Build 日志。
DEADLINE_EXCEEDED 部署后作业的运行未在分配的时间内完成。
CLOUD_BUILD_REQUEST_FAILED Cloud Build 未能满足 Cloud Deploy 的请求。如需了解更多详情，请参阅 failedMessage。

CreateChildRolloutJobRun

CreateChildRolloutJobRun 包含特定于 createChildRollout JobRun 的信息。

JSON 表示法 
{
  "rollout": string,
  "rolloutPhaseId": string
}
字段
rollout

string

仅限输出。ChildRollout 的名称。格式为 projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}。
rolloutPhaseId

string

仅限输出。此 JobRun 启动的 childRollout Phase 的 ID。

AdvanceChildRolloutJobRun

AdvanceChildRolloutJobRun 包含特定于 progressChildRollout JobRun 的信息。

JSON 表示法 
{
  "rollout": string,
  "rolloutPhaseId": string
}
字段
rollout

string

仅限输出。ChildRollout 的名称。格式为 projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}。
rolloutPhaseId

string

仅限输出。ChildRollout 的阶段的 ID。

方法

get

 获取单个 JobRun 的详细信息。

list

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

terminate

 终止给定项目和位置中的作业运行。