Skip to content

capacitymanagement.oracle.com/v1beta1

Back to API Reference

APIVersion: capacitymanagement.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes capacitymanagement.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
OccCapacityRequest Namespaced Sample -

OccCapacityRequest

Manage OCI Capacity Management capacity requests.

  • Plural: occcapacityrequests
  • Scope: Namespaced
  • APIVersion: capacitymanagement.oracle.com/v1beta1
  • Sample: Sample (config/samples/capacitymanagement_v1beta1_occcapacityrequest.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

OccCapacityRequestSpec defines the desired state of OccCapacityRequest.

Field Description Type Required Default Enum
availabilityDomain The availability domain (AD) in which the new resource is to be placed. If this is specified then the capacity will be validated and fulfilled within the scope of this AD. Note that this field is NOT required for Capacity request Transfer requests. string No - -
compartmentId Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed. string Yes - -
dateExpectedCapacityHandover The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Meaningful text about the capacity request. string No - -
details A list of different resources requested by the user. list[object] Yes - -
displayName An user-friendly name for the capacity request. Does not have to be unique, and it's changeable. Avoid entering confidential information. string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State. string No - -
namespace The name of the OCI service in consideration. For example, Compute, Exadata, and so on. string Yes - -
occAvailabilityCatalogId The OCID of the availability catalog against which capacity request is made. string No - -
region The name of the region for which the capacity request is made. string Yes - -
requestState The subset of request states available for creating the capacity request. string No - -
requestType Type of Capacity Request(New or Transfer) string No - -

Spec.details[]

Back to OccCapacityRequest spec

OccCapacityRequestDetail defines nested fields for OccCapacityRequest.Detail.

Field Description Type Required Default Enum
actualHandoverQuantity The actual handed over quantity of resources at the time of request resolution. integer (int64) No - -
associatedOccHandoverResourceBlockList A list containing details about occHandoverResourceBlocks which were handed over for the corresponding resource name. list[object] No - -
availabilityDomain The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests. string No - -
dateActualHandover The date on which the actual handover quantity of resources is delivered. string No - -
dateExpectedHandover The date on which the latest increment to supplied quantity of resources was delivered. string No - -
demandQuantity The number of compute server's with name required by the user. integer (int64) Yes - -
expectedHandoverQuantity The incremental quantity of resources supplied as the provisioning is underway. integer (int64) No - -
resourceName The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name. string Yes - -
resourceType The type of the resource against which the user wants to place a capacity request. string Yes - -
sourceWorkloadType The WorkloadType from where capacity request are to be transferred. string No - -
workloadType The type of the workload (Generic/ROW). string Yes - -

Spec.details[].associatedOccHandoverResourceBlockList[]

Back to OccCapacityRequest spec

OccCapacityRequestDetailAssociatedOccHandoverResourceBlockList defines nested fields for OccCapacityRequest.Detail.AssociatedOccHandoverResourceBlockList.

Field Description Type Required Default Enum
handoverQuantity The total quantity of the resource that was made available to the customer as part of this resource block integer (int64) No - -
occHandoverResourceBlockId The OCID of the handed over resource block. string No - -

Status

OccCapacityRequestStatus defines the observed state of OccCapacityRequest.

Field Description Type Required Default Enum
availabilityDomain The availability domain (AD) for which the capacity request was made. string No - -
compartmentId The OCID of the tenancy from which the request was made. string No - -
dateExpectedCapacityHandover The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Meaningful text about the capacity request. string No - -
details A list of resources requested as part of this request list[object] No - -
displayName The display name of the capacity request. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id The OCID of the capacity request. string No - -
lifecycleDetails A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State. string No - -
lifecycleState The current lifecycle state of the resource. string No - -
namespace The name of the OCI service in consideration. For example, Compute, Exadata, and so on. string No - -
occAvailabilityCatalogId The OCID of the availability catalog against which the capacity request was placed. string No - -
occCustomerGroupId The OCID of the customer group to which this customer belongs to. string No - -
region The name of the region for which the capacity request was made. string No - -
requestState The different states the capacity request goes through. string No - -
requestType Type of Capacity Request(New or Transfer) string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time when the capacity request was created. string No - -
timeUpdated The time when the capacity request was updated. string No - -

Status.details[]

Back to OccCapacityRequest status

OccCapacityRequestDetail defines nested fields for OccCapacityRequest.Detail.

Field Description Type Required Default Enum
actualHandoverQuantity The actual handed over quantity of resources at the time of request resolution. integer (int64) No - -
associatedOccHandoverResourceBlockList A list containing details about occHandoverResourceBlocks which were handed over for the corresponding resource name. list[object] No - -
availabilityDomain The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests. string No - -
dateActualHandover The date on which the actual handover quantity of resources is delivered. string No - -
dateExpectedHandover The date on which the latest increment to supplied quantity of resources was delivered. string No - -
demandQuantity The number of compute server's with name required by the user. integer (int64) Yes - -
expectedHandoverQuantity The incremental quantity of resources supplied as the provisioning is underway. integer (int64) No - -
resourceName The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name. string Yes - -
resourceType The type of the resource against which the user wants to place a capacity request. string Yes - -
sourceWorkloadType The WorkloadType from where capacity request are to be transferred. string No - -
workloadType The type of the workload (Generic/ROW). string Yes - -

Status.details[].associatedOccHandoverResourceBlockList[]

Back to OccCapacityRequest status

OccCapacityRequestDetailAssociatedOccHandoverResourceBlockList defines nested fields for OccCapacityRequest.Detail.AssociatedOccHandoverResourceBlockList.

Field Description Type Required Default Enum
handoverQuantity The total quantity of the resource that was made available to the customer as part of this resource block integer (int64) No - -
occHandoverResourceBlockId The OCID of the handed over resource block. string No - -

Status.status

Back to OccCapacityRequest status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to OccCapacityRequest status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to OccCapacityRequest status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to OccCapacityRequest status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -