REST 资源:projects.locations.capacityCommitments

资源:CapacityCommitment

容量承诺是为 BigQuery 作业购买计算容量的一种方法(以槽的形式),并且具有一定的承诺使用期。默认情况下,年度承诺会续订。承诺在承诺结束时间过后可以移除。如需移除年度承诺,需要先将承诺方案更改为月度承诺或灵活承诺。

容量承诺资源作为管理项目的子资源存在。

JSON 表示法

{
  "name": string,
  "slotCount": string,
  "plan": enum (CommitmentPlan),
  "state": enum (State),
  "commitmentEndTime": string,
  "failureStatus": {
    object (Status)
  },
  "renewalPlan": enum (CommitmentPlan)
}
字段
name

string

仅供输出。容量承诺的资源名称,例如:projects/myproject/locations/US/capacityCommitments/123

slotCount

string (int64 format)

此承诺中的槽数。

plan

enum (CommitmentPlan)

容量承诺的承诺方案。

state

enum (State)

仅供输出。承诺的状态。

commitmentEndTime

string (Timestamp format)

仅供输出。当前承诺期的结束时间。它仅适用于 ACTIVE 状态的容量承诺。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒。示例:"2014-10-02T15:01:23.045123456Z"

failureStatus

object (Status)

仅供输出。对于 FAILED 状态的承诺方案,请提供失败的原因。

renewalPlan

enum (CommitmentPlan)

此容量承诺在 commitmentEndTime 过后转换为的方案。更改方案后,系统会根据承诺方案延长承诺期。仅适用于 ANNUAL 承诺。

CommitmentPlan

承诺方案定义当前承诺期。容量承诺在其承诺期内无法删除。

枚举
COMMITMENT_PLAN_UNSPECIFIED 方案值无效。使用此值的请求将被拒绝,错误代码为 google.rpc.Code.INVALID_ARGUMENT
FLEX 灵活类型的承诺的承诺期为变为 ACTIVE 状态后的 1 分钟。之后,这些承诺将不再处于承诺期,可以随时移除。
TRIAL 试用承诺的承诺期为变为 ACTIVE 状态后的 182 天。之后,系统会根据 renewalPlan 将其转换为新承诺。试用承诺的默认 renewalPlan 为“灵活”,因此可在承诺期结束后立即删除。
MONTHLY 月度承诺的承诺期为变为 ACTIVE 状态后的 30 天。之后,这些承诺将不再处于承诺期,可以随时移除。
ANNUAL 年度承诺的承诺期为变为 ACTIVE 状态后的 365 天。之后,系统会根据 renewalPlan 将其转换为新承诺。

State

容量承诺可以立即变为 ACTIVE 状态,也可以从 PENDING 状态转换为 ACTIVE 或 FAILED 状态。

枚举
STATE_UNSPECIFIED 状态值无效。
PENDING 容量承诺正在等待预配。待处理的容量承诺不会添加到父级 slotCapacity。
ACTIVE 槽预配完成后,容量承诺即生效。系统会将 slotCount 添加到父级 slotCapacity。
FAILED 后端未能激活容量承诺。

方法

create

创建新的容量承诺资源。

delete

删除容量承诺。

get

返回有关容量承诺的信息。

list

列出管理项目的所有容量承诺。

merge

将同一计划的容量承诺合并为一个。

patch

更新现有容量承诺。

split

将容量承诺拆分为方案和 commitment_end_time 都相同的两个承诺。