usageapi.oracle.com/v1beta1¶
APIVersion: usageapi.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 usageapi.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| CustomTable | Namespaced | Sample | - |
| Query | Namespaced | Sample | - |
| Schedule | Namespaced | Sample | - |
| UsageCarbonEmissionsQuery | Namespaced | Sample | - |
CustomTable¶
CustomTable is the Schema for the customtables API.
Plural:customtablesScope:NamespacedAPIVersion:usageapi.oracle.com/v1beta1Sample: Sample (config/samples/usageapi_v1beta1_customtable.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
CustomTableSpec defines the desired state of CustomTable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The compartment OCID. | string |
Yes | - | - |
savedCustomTable |
CustomTableSavedCustomTable defines nested fields for CustomTable.SavedCustomTable. | object |
Yes | - | - |
savedReportId |
The associated saved report OCID. | string |
Yes | - | - |
Spec.savedCustomTable¶
CustomTableSavedCustomTable defines nested fields for CustomTable.SavedCustomTable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
columnGroupBy |
The column groupBy key list. For example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"] |
list[string] |
No | - | - |
compartmentDepth |
The compartment depth level. | number |
No | - | - |
displayName |
The name of the custom table. | string |
Yes | - | - |
groupByTag |
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported. For example: [{"namespace":"oracle", "key":"createdBy"] |
list[object] |
No | - | - |
rowGroupBy |
The row groupBy key list. For example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"] |
list[string] |
No | - | - |
version |
The version of the custom table. | number |
No | - | - |
Spec.savedCustomTable.groupByTag[]¶
CustomTableSavedCustomTableGroupByTag defines nested fields for CustomTable.SavedCustomTable.GroupByTag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status¶
CustomTableStatus defines the observed state of CustomTable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The custom table compartment OCID. | string |
No | - | - |
id |
The custom table OCID. | string |
No | - | - |
savedCustomTable |
CustomTableSavedCustomTable defines nested fields for CustomTable.SavedCustomTable. | object |
No | - | - |
savedReportId |
The custom table associated saved report OCID. | string |
No | - | - |
status |
- | object |
Yes | - | - |
Status.savedCustomTable¶
CustomTableSavedCustomTable defines nested fields for CustomTable.SavedCustomTable.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
columnGroupBy |
The column groupBy key list. For example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"] |
list[string] |
No | - | - |
compartmentDepth |
The compartment depth level. | number |
No | - | - |
displayName |
The name of the custom table. | string |
Yes | - | - |
groupByTag |
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported. For example: [{"namespace":"oracle", "key":"createdBy"] |
list[object] |
No | - | - |
rowGroupBy |
The row groupBy key list. For example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"] |
list[string] |
No | - | - |
version |
The version of the custom table. | number |
No | - | - |
Status.savedCustomTable.groupByTag[]¶
CustomTableSavedCustomTableGroupByTag defines nested fields for CustomTable.SavedCustomTable.GroupByTag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Query¶
Query is the Schema for the queries API.
Plural:queriesScope:NamespacedAPIVersion:usageapi.oracle.com/v1beta1Sample: Sample (config/samples/usageapi_v1beta1_query.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
QuerySpec defines the desired state of Query.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The compartment OCID. | string |
Yes | - | - |
queryDefinition |
QueryDefinition defines nested fields for Query.QueryDefinition. | object |
Yes | - | - |
Spec.queryDefinition¶
QueryDefinition defines nested fields for Query.QueryDefinition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
costAnalysisUI |
QueryDefinitionCostAnalysisUI defines nested fields for Query.QueryDefinition.CostAnalysisUI. | object |
Yes | - | - |
displayName |
The query display name. Avoid entering confidential information. | string |
Yes | - | - |
reportQuery |
QueryDefinitionReportQuery defines nested fields for Query.QueryDefinition.ReportQuery. | object |
Yes | - | - |
version |
The saved query version. | number |
Yes | - | - |
Spec.queryDefinition.costAnalysisUI¶
QueryDefinitionCostAnalysisUI defines nested fields for Query.QueryDefinition.CostAnalysisUI.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
graph |
The graph type. | string |
No | - | - |
isCumulativeGraph |
A cumulative graph. | boolean |
No | - | - |
Spec.queryDefinition.reportQuery¶
QueryDefinitionReportQuery defines nested fields for Query.QueryDefinition.ReportQuery.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentDepth |
The compartment depth level. | number |
No | - | - |
dateRangeName |
The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded. | string |
No | - | - |
filter |
QueryDefinitionReportQueryFilter defines nested fields for Query.QueryDefinition.ReportQuery.Filter. | object |
No | - | - |
forecast |
QueryDefinitionReportQueryForecast defines nested fields for Query.QueryDefinition.ReportQuery.Forecast. | object |
No | - | - |
granularity |
The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported. | string |
Yes | - | - |
groupBy |
Specifies what to aggregate the result by. For example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"] |
list[string] |
No | - | - |
groupByTag |
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [{"namespace":"oracle", "key":"createdBy"] |
list[object] |
No | - | - |
isAggregateByTime |
Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. | boolean |
No | - | - |
queryType |
The query usage type. COST by default if it is missing. * Usage: Query the usage data. * Cost: Query the cost/billing data. * Credit: Query the credit adjustments data. * ExpiredCredit: Query the expired credits data. * AllCredit: Query the credit adjustments and expired credit. | string |
No | - | - |
tenantId |
Tenant ID. | string |
Yes | - | - |
timeUsageEnded |
The usage end time. | string |
No | - | - |
timeUsageStarted |
The usage start time. | string |
No | - | - |
Spec.queryDefinition.reportQuery.filter¶
QueryDefinitionReportQueryFilter defines nested fields for Query.QueryDefinition.ReportQuery.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensions |
The dimensions to filter on. | list[object] |
No | - | - |
operator |
The filter operator. Example: 'AND', 'OR', 'NOT'. | string |
No | - | - |
tags |
The tags to filter on. | list[object] |
No | - | - |
Spec.queryDefinition.reportQuery.filter.dimensions[]¶
QueryDefinitionReportQueryFilterDimension defines nested fields for Query.QueryDefinition.ReportQuery.Filter.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The dimension key. | string |
Yes | - | - |
value |
The dimension value. | string |
Yes | - | - |
Spec.queryDefinition.reportQuery.filter.tags[]¶
QueryDefinitionReportQueryFilterTag defines nested fields for Query.QueryDefinition.ReportQuery.Filter.Tag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Spec.queryDefinition.reportQuery.forecast¶
QueryDefinitionReportQueryForecast defines nested fields for Query.QueryDefinition.ReportQuery.Forecast.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
forecastType |
BASIC uses the exponential smoothing (ETS) model to project future usage or costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made. | string |
No | - | - |
timeForecastEnded |
The forecast end time. | string |
Yes | - | - |
timeForecastStarted |
The forecast start time. Defaults to UTC-1 if not specified. | string |
No | - | - |
Spec.queryDefinition.reportQuery.groupByTag[]¶
QueryDefinitionReportQueryGroupByTag defines nested fields for Query.QueryDefinition.ReportQuery.GroupByTag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status¶
QueryStatus defines the observed state of Query.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The compartment OCID. | string |
No | - | - |
id |
The query OCID. | string |
No | - | - |
queryDefinition |
QueryDefinition defines nested fields for Query.QueryDefinition. | object |
No | - | - |
status |
- | object |
Yes | - | - |
Status.queryDefinition¶
QueryDefinition defines nested fields for Query.QueryDefinition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
costAnalysisUI |
QueryDefinitionCostAnalysisUI defines nested fields for Query.QueryDefinition.CostAnalysisUI. | object |
Yes | - | - |
displayName |
The query display name. Avoid entering confidential information. | string |
Yes | - | - |
reportQuery |
QueryDefinitionReportQuery defines nested fields for Query.QueryDefinition.ReportQuery. | object |
Yes | - | - |
version |
The saved query version. | number |
Yes | - | - |
Status.queryDefinition.costAnalysisUI¶
QueryDefinitionCostAnalysisUI defines nested fields for Query.QueryDefinition.CostAnalysisUI.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
graph |
The graph type. | string |
No | - | - |
isCumulativeGraph |
A cumulative graph. | boolean |
No | - | - |
Status.queryDefinition.reportQuery¶
QueryDefinitionReportQuery defines nested fields for Query.QueryDefinition.ReportQuery.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentDepth |
The compartment depth level. | number |
No | - | - |
dateRangeName |
The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded. | string |
No | - | - |
filter |
QueryDefinitionReportQueryFilter defines nested fields for Query.QueryDefinition.ReportQuery.Filter. | object |
No | - | - |
forecast |
QueryDefinitionReportQueryForecast defines nested fields for Query.QueryDefinition.ReportQuery.Forecast. | object |
No | - | - |
granularity |
The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported. | string |
Yes | - | - |
groupBy |
Specifies what to aggregate the result by. For example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"] |
list[string] |
No | - | - |
groupByTag |
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [{"namespace":"oracle", "key":"createdBy"] |
list[object] |
No | - | - |
isAggregateByTime |
Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. | boolean |
No | - | - |
queryType |
The query usage type. COST by default if it is missing. * Usage: Query the usage data. * Cost: Query the cost/billing data. * Credit: Query the credit adjustments data. * ExpiredCredit: Query the expired credits data. * AllCredit: Query the credit adjustments and expired credit. | string |
No | - | - |
tenantId |
Tenant ID. | string |
Yes | - | - |
timeUsageEnded |
The usage end time. | string |
No | - | - |
timeUsageStarted |
The usage start time. | string |
No | - | - |
Status.queryDefinition.reportQuery.filter¶
QueryDefinitionReportQueryFilter defines nested fields for Query.QueryDefinition.ReportQuery.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensions |
The dimensions to filter on. | list[object] |
No | - | - |
operator |
The filter operator. Example: 'AND', 'OR', 'NOT'. | string |
No | - | - |
tags |
The tags to filter on. | list[object] |
No | - | - |
Status.queryDefinition.reportQuery.filter.dimensions[]¶
QueryDefinitionReportQueryFilterDimension defines nested fields for Query.QueryDefinition.ReportQuery.Filter.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The dimension key. | string |
Yes | - | - |
value |
The dimension value. | string |
Yes | - | - |
Status.queryDefinition.reportQuery.filter.tags[]¶
QueryDefinitionReportQueryFilterTag defines nested fields for Query.QueryDefinition.ReportQuery.Filter.Tag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status.queryDefinition.reportQuery.forecast¶
QueryDefinitionReportQueryForecast defines nested fields for Query.QueryDefinition.ReportQuery.Forecast.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
forecastType |
BASIC uses the exponential smoothing (ETS) model to project future usage or costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made. | string |
No | - | - |
timeForecastEnded |
The forecast end time. | string |
Yes | - | - |
timeForecastStarted |
The forecast start time. Defaults to UTC-1 if not specified. | string |
No | - | - |
Status.queryDefinition.reportQuery.groupByTag[]¶
QueryDefinitionReportQueryGroupByTag defines nested fields for Query.QueryDefinition.ReportQuery.GroupByTag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Schedule¶
Schedule is the Schema for the schedules API.
Plural:schedulesScope:NamespacedAPIVersion:usageapi.oracle.com/v1beta1Sample: Sample (config/samples/usageapi_v1beta1_schedule.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ScheduleSpec defines the desired state of Schedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The customer tenancy. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
The description of the schedule. | string |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
name |
The unique name of the user-created schedule. | string |
Yes | - | - |
outputFileFormat |
Specifies the supported output file format. | string |
No | - | - |
queryProperties |
ScheduleQueryProperties defines nested fields for Schedule.QueryProperties. | object |
No | - | - |
resultLocation |
ScheduleResultLocation defines nested fields for Schedule.ResultLocation. | object |
Yes | - | - |
savedReportId |
The saved report ID which can also be used to generate a query. | string |
No | - | - |
scheduleRecurrences |
Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10 (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY. | string |
Yes | - | - |
timeScheduled |
The date and time of the first time job execution. | string |
Yes | - | - |
Spec.queryProperties¶
ScheduleQueryProperties defines nested fields for Schedule.QueryProperties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentDepth |
The depth level of the compartment. | number |
No | - | - |
dateRange |
ScheduleQueryPropertiesDateRange defines nested fields for Schedule.QueryProperties.DateRange. | object |
Yes | - | - |
filter |
ScheduleQueryPropertiesFilter defines nested fields for Schedule.QueryProperties.Filter. | object |
No | - | - |
granularity |
The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY | string |
Yes | - | - |
groupBy |
Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ] | list[string] |
No | - | - |
groupByTag |
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [ { "namespace": "oracle", "key": "createdBy" ] | list[object] |
No | - | - |
isAggregateByTime |
Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. | boolean |
No | - | - |
queryType |
The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Allowed values are: USAGE COST USAGE_AND_COST | string |
No | - | - |
Spec.queryProperties.dateRange¶
ScheduleQueryPropertiesDateRange defines nested fields for Schedule.QueryProperties.DateRange.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dateRangeType |
- | string |
No | - | - |
dynamicDateRangeType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
timeUsageEnded |
The usage end time. | string |
No | - | - |
timeUsageStarted |
The usage start time. | string |
No | - | - |
Spec.queryProperties.filter¶
ScheduleQueryPropertiesFilter defines nested fields for Schedule.QueryProperties.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensions |
The dimensions to filter on. | list[object] |
No | - | - |
operator |
The filter operator. Example: 'AND', 'OR', 'NOT'. | string |
No | - | - |
tags |
The tags to filter on. | list[object] |
No | - | - |
Spec.queryProperties.filter.dimensions[]¶
ScheduleQueryPropertiesFilterDimension defines nested fields for Schedule.QueryProperties.Filter.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The dimension key. | string |
Yes | - | - |
value |
The dimension value. | string |
Yes | - | - |
Spec.queryProperties.filter.tags[]¶
ScheduleQueryPropertiesFilterTag defines nested fields for Schedule.QueryProperties.Filter.Tag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Spec.queryProperties.groupByTag[]¶
ScheduleQueryPropertiesGroupByTag defines nested fields for Schedule.QueryProperties.GroupByTag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Spec.resultLocation¶
ScheduleResultLocation defines nested fields for Schedule.ResultLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
The bucket name where usage or cost CSVs will be uploaded. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
locationType |
- | string |
No | - | - |
namespace |
The namespace needed to determine the object storage bucket. | string |
No | - | - |
region |
The destination Object Store Region specified by the customer. | string |
No | - | - |
Status¶
ScheduleStatus defines the observed state of Schedule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The customer tenancy. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
The description of the schedule. | string |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
id |
The OCID representing a unique shedule. | string |
No | - | - |
lifecycleState |
The schedule lifecycle state. | string |
No | - | - |
name |
The unique name of the schedule created by the user. | string |
No | - | - |
outputFileFormat |
Specifies the supported output file format. | string |
No | - | - |
queryProperties |
ScheduleQueryProperties defines nested fields for Schedule.QueryProperties. | object |
No | - | - |
resultLocation |
ScheduleResultLocation defines nested fields for Schedule.ResultLocation. | object |
No | - | - |
savedReportId |
The saved report ID which can also be used to generate a query. | string |
No | - | - |
scheduleRecurrences |
Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10 (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time the schedule was created. | string |
No | - | - |
timeNextRun |
The date and time of the next job execution. | string |
No | - | - |
timeScheduled |
The date and time of the first time job execution. | string |
No | - | - |
Status.queryProperties¶
ScheduleQueryProperties defines nested fields for Schedule.QueryProperties.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentDepth |
The depth level of the compartment. | number |
No | - | - |
dateRange |
ScheduleQueryPropertiesDateRange defines nested fields for Schedule.QueryProperties.DateRange. | object |
Yes | - | - |
filter |
ScheduleQueryPropertiesFilter defines nested fields for Schedule.QueryProperties.Filter. | object |
No | - | - |
granularity |
The usage granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. Allowed values are: DAILY MONTHLY | string |
Yes | - | - |
groupBy |
Aggregate the result by. For example: [ "tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName" ] | list[string] |
No | - | - |
groupByTag |
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [ { "namespace": "oracle", "key": "createdBy" ] | list[object] |
No | - | - |
isAggregateByTime |
Specifies whether aggregated by time. If isAggregateByTime is true, all usage or cost over the query time period will be added up. | boolean |
No | - | - |
queryType |
The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Allowed values are: USAGE COST USAGE_AND_COST | string |
No | - | - |
Status.queryProperties.dateRange¶
ScheduleQueryPropertiesDateRange defines nested fields for Schedule.QueryProperties.DateRange.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dateRangeType |
- | string |
No | - | - |
dynamicDateRangeType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
timeUsageEnded |
The usage end time. | string |
No | - | - |
timeUsageStarted |
The usage start time. | string |
No | - | - |
Status.queryProperties.filter¶
ScheduleQueryPropertiesFilter defines nested fields for Schedule.QueryProperties.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensions |
The dimensions to filter on. | list[object] |
No | - | - |
operator |
The filter operator. Example: 'AND', 'OR', 'NOT'. | string |
No | - | - |
tags |
The tags to filter on. | list[object] |
No | - | - |
Status.queryProperties.filter.dimensions[]¶
ScheduleQueryPropertiesFilterDimension defines nested fields for Schedule.QueryProperties.Filter.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The dimension key. | string |
Yes | - | - |
value |
The dimension value. | string |
Yes | - | - |
Status.queryProperties.filter.tags[]¶
ScheduleQueryPropertiesFilterTag defines nested fields for Schedule.QueryProperties.Filter.Tag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status.queryProperties.groupByTag[]¶
ScheduleQueryPropertiesGroupByTag defines nested fields for Schedule.QueryProperties.GroupByTag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status.resultLocation¶
ScheduleResultLocation defines nested fields for Schedule.ResultLocation.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketName |
The bucket name where usage or cost CSVs will be uploaded. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
locationType |
- | string |
No | - | - |
namespace |
The namespace needed to determine the object storage bucket. | string |
No | - | - |
region |
The destination Object Store Region specified by the customer. | string |
No | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
UsageCarbonEmissionsQuery¶
UsageCarbonEmissionsQuery is the Schema for the usagecarbonemissionsqueries API.
Plural:usagecarbonemissionsqueriesScope:NamespacedAPIVersion:usageapi.oracle.com/v1beta1Sample: Sample (config/samples/usageapi_v1beta1_usagecarbonemissionsquery.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
UsageCarbonEmissionsQuerySpec defines the desired state of UsageCarbonEmissionsQuery.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The compartment OCID. | string |
Yes | - | - |
queryDefinition |
UsageCarbonEmissionsQueryQueryDefinition defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition. | object |
Yes | - | - |
Spec.queryDefinition¶
Back to UsageCarbonEmissionsQuery spec
UsageCarbonEmissionsQueryQueryDefinition defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
costAnalysisUI |
UsageCarbonEmissionsQueryQueryDefinitionCostAnalysisUI defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.CostAnalysisUI. | object |
Yes | - | - |
displayName |
The query display name. Avoid entering confidential information. | string |
Yes | - | - |
reportQuery |
UsageCarbonEmissionsQueryQueryDefinitionReportQuery defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery. | object |
Yes | - | - |
version |
The saved query version. | integer |
Yes | - | - |
Spec.queryDefinition.costAnalysisUI¶
Back to UsageCarbonEmissionsQuery spec
UsageCarbonEmissionsQueryQueryDefinitionCostAnalysisUI defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.CostAnalysisUI.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
graph |
The graph type. | string |
No | - | - |
isCumulativeGraph |
A cumulative graph. | boolean |
No | - | - |
Spec.queryDefinition.reportQuery¶
Back to UsageCarbonEmissionsQuery spec
UsageCarbonEmissionsQueryQueryDefinitionReportQuery defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentDepth |
The compartment depth level. | integer |
No | - | - |
dateRangeName |
The user interface date range, for example, LAST_THREE_MONTHS. Overrides the timeUsageStarted and timeUsageEnded properties. | string |
No | - | - |
emissionCalculationMethod |
Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED | string |
No | - | - |
emissionType |
Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED. | string |
No | - | - |
filter |
UsageCarbonEmissionsQueryQueryDefinitionReportQueryFilter defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.Filter. | object |
No | - | - |
granularity |
The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. | string |
No | - | - |
groupBy |
Specifies what to aggregate the result by. For example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"] |
list[string] |
No | - | - |
groupByTag |
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [{"namespace":"oracle", "key":"createdBy"] |
list[object] |
No | - | - |
isAggregateByTime |
Specifies whether aggregated by time. If isAggregateByTime is true, all usage or costs over the query time period are summed. | boolean |
No | - | - |
tenantId |
Tenant ID. | string |
Yes | - | - |
timeUsageEnded |
The usage end time. | string |
No | - | - |
timeUsageStarted |
The usage start time. | string |
No | - | - |
Spec.queryDefinition.reportQuery.filter¶
Back to UsageCarbonEmissionsQuery spec
UsageCarbonEmissionsQueryQueryDefinitionReportQueryFilter defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensions |
The dimensions to filter on. | list[object] |
No | - | - |
operator |
The filter operator. Example: 'AND', 'OR', 'NOT'. | string |
No | - | - |
tags |
The tags to filter on. | list[object] |
No | - | - |
Spec.queryDefinition.reportQuery.filter.dimensions[]¶
Back to UsageCarbonEmissionsQuery spec
UsageCarbonEmissionsQueryQueryDefinitionReportQueryFilterDimension defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.Filter.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The dimension key. | string |
Yes | - | - |
value |
The dimension value. | string |
Yes | - | - |
Spec.queryDefinition.reportQuery.filter.tags[]¶
Back to UsageCarbonEmissionsQuery spec
UsageCarbonEmissionsQueryQueryDefinitionReportQueryFilterTag defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.Filter.Tag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Spec.queryDefinition.reportQuery.groupByTag[]¶
Back to UsageCarbonEmissionsQuery spec
UsageCarbonEmissionsQueryQueryDefinitionReportQueryGroupByTag defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.GroupByTag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status¶
UsageCarbonEmissionsQueryStatus defines the observed state of UsageCarbonEmissionsQuery.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The compartment OCID. | string |
No | - | - |
id |
The query OCID. | string |
No | - | - |
queryDefinition |
UsageCarbonEmissionsQueryQueryDefinition defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition. | object |
No | - | - |
status |
- | object |
Yes | - | - |
Status.queryDefinition¶
Back to UsageCarbonEmissionsQuery status
UsageCarbonEmissionsQueryQueryDefinition defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
costAnalysisUI |
UsageCarbonEmissionsQueryQueryDefinitionCostAnalysisUI defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.CostAnalysisUI. | object |
Yes | - | - |
displayName |
The query display name. Avoid entering confidential information. | string |
Yes | - | - |
reportQuery |
UsageCarbonEmissionsQueryQueryDefinitionReportQuery defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery. | object |
Yes | - | - |
version |
The saved query version. | integer |
Yes | - | - |
Status.queryDefinition.costAnalysisUI¶
Back to UsageCarbonEmissionsQuery status
UsageCarbonEmissionsQueryQueryDefinitionCostAnalysisUI defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.CostAnalysisUI.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
graph |
The graph type. | string |
No | - | - |
isCumulativeGraph |
A cumulative graph. | boolean |
No | - | - |
Status.queryDefinition.reportQuery¶
Back to UsageCarbonEmissionsQuery status
UsageCarbonEmissionsQueryQueryDefinitionReportQuery defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentDepth |
The compartment depth level. | integer |
No | - | - |
dateRangeName |
The user interface date range, for example, LAST_THREE_MONTHS. Overrides the timeUsageStarted and timeUsageEnded properties. | string |
No | - | - |
emissionCalculationMethod |
Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED | string |
No | - | - |
emissionType |
Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED. | string |
No | - | - |
filter |
UsageCarbonEmissionsQueryQueryDefinitionReportQueryFilter defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.Filter. | object |
No | - | - |
granularity |
The carbon emission granularity. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. | string |
No | - | - |
groupBy |
Specifies what to aggregate the result by. For example: ["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"] |
list[string] |
No | - | - |
groupByTag |
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: [{"namespace":"oracle", "key":"createdBy"] |
list[object] |
No | - | - |
isAggregateByTime |
Specifies whether aggregated by time. If isAggregateByTime is true, all usage or costs over the query time period are summed. | boolean |
No | - | - |
tenantId |
Tenant ID. | string |
Yes | - | - |
timeUsageEnded |
The usage end time. | string |
No | - | - |
timeUsageStarted |
The usage start time. | string |
No | - | - |
Status.queryDefinition.reportQuery.filter¶
Back to UsageCarbonEmissionsQuery status
UsageCarbonEmissionsQueryQueryDefinitionReportQueryFilter defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
dimensions |
The dimensions to filter on. | list[object] |
No | - | - |
operator |
The filter operator. Example: 'AND', 'OR', 'NOT'. | string |
No | - | - |
tags |
The tags to filter on. | list[object] |
No | - | - |
Status.queryDefinition.reportQuery.filter.dimensions[]¶
Back to UsageCarbonEmissionsQuery status
UsageCarbonEmissionsQueryQueryDefinitionReportQueryFilterDimension defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.Filter.Dimension.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The dimension key. | string |
Yes | - | - |
value |
The dimension value. | string |
Yes | - | - |
Status.queryDefinition.reportQuery.filter.tags[]¶
Back to UsageCarbonEmissionsQuery status
UsageCarbonEmissionsQueryQueryDefinitionReportQueryFilterTag defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.Filter.Tag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status.queryDefinition.reportQuery.groupByTag[]¶
Back to UsageCarbonEmissionsQuery status
UsageCarbonEmissionsQueryQueryDefinitionReportQueryGroupByTag defines nested fields for UsageCarbonEmissionsQuery.QueryDefinition.ReportQuery.GroupByTag.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
key |
The tag key. | string |
No | - | - |
namespace |
The tag namespace. | string |
No | - | - |
value |
The tag value. | string |
No | - | - |
Status.status¶
Back to UsageCarbonEmissionsQuery 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 UsageCarbonEmissionsQuery 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 UsageCarbonEmissionsQuery 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 UsageCarbonEmissionsQuery status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |