Usage API: Schedule¶
Manage OCI Usage API resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | usageapi |
| Resource | Schedule |
| API Version | usageapi.oracle.com/v1beta1 |
| Package | Usage API |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-usageapi-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/usageapi_v1beta1_schedule.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
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 |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
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 |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/usageapi_v1beta1_schedule.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
#
# Replace the OCI identifiers and Object Storage values below before running e2e.
# Update spec.description, spec.outputFileFormat, spec.resultLocation, or tags to
# exercise supported in-place updates on an existing Schedule.
# Changing spec.name, spec.compartmentId, spec.scheduleRecurrences, spec.timeScheduled,
# spec.savedReportId, or spec.queryProperties requires recreation and is rejected on
# an already bound Schedule.
#
apiVersion: usageapi.oracle.com/v1beta1
kind: Schedule
metadata:
name: schedule-sample
spec:
name: schedule-sample
compartmentId: ocid1.compartment.oc1..exampleuniqueID
resultLocation:
locationType: OBJECT_STORAGE
region: us-ashburn-1
namespace: example-namespace
bucketName: usage-reports
scheduleRecurrences: "FREQ=DAILY;INTERVAL=1"
timeScheduled: "2026-01-15T15:00:00Z"
description: "Daily usage export"
outputFileFormat: CSV
savedReportId: ocid1.savedreport.oc1..exampleuniqueID
freeformTags:
workload: finops