Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13203076.0 KB
projects

Creates a new capacity commitment resource.

post/v1/{+parent}/capacityCommitments

Path parameters

parentstring required

Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US

Query parameters

capacityCommitmentIdstring

The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.

enforceSingleAdminProjectPerOrgboolean

If true, fail the request if another project in the organization has a capacity commitment.

Request body

edition'EDITION_UNSPECIFIED' | 'STANDARD' | 'ENTERPRISE' | 'ENTERPRISE_PLUS'

Optional. Edition of the capacity commitment.

isFlatRateboolean

Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.

multiRegionAuxiliaryboolean

Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

commitmentStartTimestring google-datetime

Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment.

slotCountstring int64

Optional. Number of slots in this commitment.

state'STATE_UNSPECIFIED' | 'PENDING' | 'ACTIVE' | 'FAILED'

Output only. State of the commitment.

plan'COMMITMENT_PLAN_UNSPECIFIED' | 'FLEX' | 'FLEX_FLAT_RATE' | 'TRIAL' | 'MONTHLY' | 'MONTHLY_FLAT_RATE' | 'ANNUAL' | 'ANNUAL_FLAT_RATE' | 'THREE_YEAR' | 'NONE'

Optional. Capacity commitment commitment plan.

namestring

Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 The commitment_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.

commitmentEndTimestring google-datetime

Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after renewal, commitment_end_time is the time the renewed commitment expires. So itwould be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,

renewalPlan'COMMITMENT_PLAN_UNSPECIFIED' | 'FLEX' | 'FLEX_FLAT_RATE' | 'TRIAL' | 'MONTHLY' | 'MONTHLY_FLAT_RATE' | 'ANNUAL' | 'ANNUAL_FLAT_RATE' | 'THREE_YEAR' | 'NONE'

Optional. The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.

Response

Successful response