apiplatform.oracle.com/v1beta1¶
APIVersion: apiplatform.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 apiplatform.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| ApiPlatformInstance | Namespaced | Sample | - |
ApiPlatformInstance¶
Manage OCI API Platform instances.
Plural:apiplatforminstancesScope:NamespacedAPIVersion:apiplatform.oracle.com/v1beta1Sample: Sample (config/samples/apiplatform_v1beta1_apiplatforminstance.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ApiPlatformInstanceSpec defines the desired state of ApiPlatformInstance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the instance in. | 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 |
User-provided changeable and non-unique description of the instance | 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 | - | - |
name |
A regionally unique, non-changeable instance name provided by the user during creation | string |
Yes | - | - |
Status¶
ApiPlatformInstanceStatus defines the observed state of ApiPlatformInstance.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment | 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 |
User-provided changeable and non-unique description of the instance | 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 (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance | string |
No | - | - |
idcsApp |
ApiPlatformInstanceIdcsApp defines nested fields for ApiPlatformInstance.IdcsApp. | object |
No | - | - |
lifecycleDetails |
A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state | string |
No | - | - |
lifecycleState |
The current state of the instance | string |
No | - | - |
name |
A regionally unique, non-changeable instance name provided by the user during instance creation | 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 date and time the instance was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339) Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time the instance was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339) Example: 2016-08-25T21:10:29.600Z |
string |
No | - | - |
uris |
ApiPlatformInstanceUris defines nested fields for ApiPlatformInstance.Uris. | object |
No | - | - |
Status.idcsApp¶
Back to ApiPlatformInstance status
ApiPlatformInstanceIdcsApp defines nested fields for ApiPlatformInstance.IdcsApp.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
url |
IDCS URL of the app | string |
No | - | - |
Status.status¶
Back to ApiPlatformInstance 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 ApiPlatformInstance 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 ApiPlatformInstance 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 ApiPlatformInstance status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Status.uris¶
Back to ApiPlatformInstance status
ApiPlatformInstanceUris defines nested fields for ApiPlatformInstance.Uris.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
developersPortalUri |
Developer's Portal URI of the instance (/developers) | string |
No | - | - |
managementPortalUri |
Management Portal URI of the instance (/apiplatform) | string |
No | - | - |