openapi: 3.2.0 info: description: 'Use the Compute Cloud@Customer API to manage Compute Cloud@Customer infrastructures and upgrade schedules. For more information see [Compute Cloud@Customer documentation](/iaas/compute-cloud-at-customer/home.htm). ' title: Compute Cloud@Customer Compute Cloud At Customer API version: '20221208' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/468775184ca4fe31235420733267b83b5fc48f58050a9529483039f6b2d4630c.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Compute Cloud@Customer API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/468775184ca4fe31235420733267b83b5fc48f58050a9529483039f6b2d4630c.yaml what: the harvested document for Compute Cloud@Customer API servers: - url: http://127.0.0.1/20221208 - url: https://127.0.0.1/20221208 tags: - name: computeCloudAtCustomer paths: /cccInfrastructures: get: description: 'Returns a list of Compute Cloud@Customer infrastructures. ' operationId: ListCccInfrastructures parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/CccInfrastructureLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/CccInfrastructureIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of Compute Cloud@Customer infrastructure summary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CccInfrastructureCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all Compute Cloud@Customer infrastructures in a compartment tags: - computeCloudAtCustomer x-example: 'Example: List all Compute Cloud@Customer infrastructures in a compartment that have the REQUEST lifecycle state. Host: ccc.us-phoenix-1.oci.oraclecloud.com GET /20221208/cccInfrastructures?compartmentId=<compartment_OCID>&lifeycleState=REQUEST <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CccInfrastructureCollection' post: description: 'Creates a Compute Cloud@Customer infrastructure. Once created, Oracle Services must connect the rack in the data center to this Oracle Cloud Infrastructure resource. ' operationId: CreateCccInfrastructure parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Created the Compute Cloud@Customer infrastructure resource. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CccInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a Compute Cloud@Customer infrastructure. tags: - computeCloudAtCustomer x-example: "Example: Create a Compute Cloud@Customer infrastructure with an upgrade schedule. \nYou must create the upgrade schedule first.\nHost: ccc.us-phoenix-1.oci.oraclecloud.com\nPOST /20221208/cccInfrastructures\n{\n \"displayName\": \"example_cccInfrastructure\",\n \"compartmentId\": <compartment_OCID>,\n \"subnetId\": <subnet_OCID>,\n \"description\": \"Datacenter 231\",\n \"cccUpgradeScheduleId\": \"ocid1.cccupgradeschedule.oc1..<unique_ID>\"\n}\n<authorization and other headers>\n" x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CccInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCccInfrastructureDetails' description: Details for the new CccInfrastructure. required: true /cccInfrastructures/{cccInfrastructureId}: delete: description: 'Deletes a Compute Cloud@Customer infrastructure resource specified by the resource [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: DeleteCccInfrastructure parameters: - $ref: '#/components/parameters/CccInfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Deleted the Compute Cloud@Customer infrastructure resource. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a Compute Cloud@Customer infrastructure. tags: - computeCloudAtCustomer x-example: 'Example: Delete the specified Compute Cloud@Customer infrastructure. Host: ccc.us-phoenix-1.oci.oraclecloud.com DELETE /20221208/cccInfrastructures/ocid1.cccinfrastructure.oc1..<unique_ID> <authorization and other headers> ' x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/CccInfrastructure' get: description: 'Gets a Compute Cloud@Customer infrastructure using the infrastructure [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetCccInfrastructure parameters: - $ref: '#/components/parameters/CccInfrastructureIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Compute Cloud@Customer infrastructure details. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CccInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a Compute Cloud@Customer infrastructure. tags: - computeCloudAtCustomer x-example: 'Example: Retrieve the details of a specific Compute Cloud@Customer infrastructure. Host: ccc.us-phoenix-1.oci.oraclecloud.com GET /20221208/cccInfrastructures/ocid1.cccinfrastructure.oc1..<unique_ID> <authorization and other headers> ' x-obmcs-client-retries-enabled: true put: description: Updates Compute Cloud@Customer infrastructure resource. operationId: UpdateCccInfrastructure parameters: - $ref: '#/components/parameters/CccInfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Accepted the changes for the Compute Cloud@Customer infrastructure. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CccInfrastructure' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates Compute Cloud@Customer infrastructure resource. tags: - computeCloudAtCustomer x-example: "Example: Update the specified Compute Cloud@Customer infrastructure with a different description (display name).\nHost: ccc.us-phoenix-1.oci.oraclecloud.com\nPUT /20221208/cccInfrastructures/ocid1.cccinfrastructure.oc1..<unique_ID>\n{\n \"displayName\": \"example_cccInfrastructure_updated\",\n \"subnetId\": <subnet_OCID>\n}\n<authorization and other headers>\n" x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/CccInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCccInfrastructureDetails' description: The information to be updated. required: true /cccInfrastructures/{cccInfrastructureId}/actions/changeCompartment: post: description: 'Moves a Compute Cloud@Customer infrastructure resource from one compartment to another. ' operationId: ChangeCccInfrastructureCompartment parameters: - $ref: '#/components/parameters/CccInfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Compartment changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a Compute Cloud@Customer infrastructure resource. tags: - computeCloudAtCustomer x-example: "Example: Move the specified Compute Cloud@Customer infrastructure to a different compartment.\nHost: ccc.us-phoenix-1.oci.oraclecloud.com\nPOST /20221208/cccInfrastructures/ocid1.cccinfrastructure.oc1..<unique_ID>/actions/changeCompartment\n{\n \"compartmentId\": <new_compartment_OCID>\n}\n<authorization and other headers>\n" x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CccInfrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCccInfrastructureCompartmentDetails' description: 'Details about the compartment change operation including the destination compartment specified by the resource [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' required: true /cccUpgradeSchedules: get: description: 'Returns a list of Compute Cloud@Customer upgrade schedules. ' operationId: ListCccUpgradeSchedules parameters: - $ref: '#/components/parameters/CccUpgradeScheduleIdQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/CccUpgradeScheduleLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of CccUpgradeSchedule objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CccUpgradeScheduleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of Compute Cloud@Customer upgrade schedules. tags: - computeCloudAtCustomer x-example: 'Example: List all Compute Cloud@Customer upgrade schedules in the specified compartment. Host: ccc.us-phoenix-1.oci.oraclecloud.com GET /20221208/cccUpgradeSchedules?compartmentId=<compartment_OCID> <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CccUpgradeScheduleCollection' post: description: 'Creates a new Compute Cloud@Customer upgrade schedule. ' operationId: CreateCccUpgradeSchedule parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Created the schedule. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CccUpgradeSchedule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new Compute Cloud@Customer upgrade schedule. tags: - computeCloudAtCustomer x-example: "Example: Create a Compute Cloud@Customer upgrade schedule with two upgrade windows (events). One upgrade \nwindow will open on the first day of every month, and the other upgrade window will open on the \nfifteenth day of every month. The event duration for both upgrade windows is set at two days and six hours, \nwhich is also the shortest permissible event duration.\nHost: ccc.us-phoenix-1.oci.oraclecloud.com\nPOST /20221208/cccUpgradeSchedules\n{\n \"compartmentId\": <compartment_OCID>,\n \"displayName\": \"example_cccUpgradeSchedule\",\n \"events\": [\n {\n \"description\": \"Month-start upgrade window\",\n \"timeStart\": \"2024-01-25T22:00:00Z\",,\n \"scheduleEventDuration\": \"P2DT6H\",\n \"scheduleEventRecurrences\": \"FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=1\"\n },\n {\n \"description\": \"Mid-month upgrade window\",\n \"timeStart\": \"2024-01-25T22:00:00Z\",,\n \"scheduleEventDuration\": \"P2DT6H\",\n \"scheduleEventRecurrences\": \"FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=15\"\n }\n ],\n}\n<authorization and other headers>\n" x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CccUpgradeSchedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCccUpgradeScheduleDetails' description: Details for the new CCC Upgrade Schedule. required: true /cccUpgradeSchedules/{cccUpgradeScheduleId}: delete: description: 'Deletes a Compute Cloud@Customer upgrade schedule by the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: DeleteCccUpgradeSchedule parameters: - $ref: '#/components/parameters/CccUpgradeScheduleIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Deleted the schedule. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a Compute Cloud@Customer upgrade schedule. tags: - computeCloudAtCustomer x-example: 'Example: Delete the specified Compute Cloud@Customer upgrade schedule. Host: ccc.us-phoenix-1.oci.oraclecloud.com DELETE /20221208/cccUpgradeSchedules/ocid1.cccupgradeschedule.oc1..<unique_ID> <authorization and other headers> ' x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/CccUpgradeSchedule' get: description: 'Gets a Compute Cloud@Customer upgrade schedule by the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetCccUpgradeSchedule parameters: - $ref: '#/components/parameters/CccUpgradeScheduleIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieved the Compute Cloud@Customer upgrade schedule. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CccUpgradeSchedule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a Compute Cloud@Customer upgrade schedule. tags: - computeCloudAtCustomer x-example: 'Example: Retrieve the specified Compute Cloud@Customer upgrade schedule. Host: ccc.us-phoenix-1.oci.oraclecloud.com GET /20221208/cccUpgradeSchedules/ocid1.cccupgradeschedule.oc1..<unique_ID> <authorization and other headers> ' x-obmcs-client-retries-enabled: true put: description: Updates the Compute Cloud@Customer upgrade schedule. operationId: UpdateCccUpgradeSchedule parameters: - $ref: '#/components/parameters/CccUpgradeScheduleIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updated the schedule. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CccUpgradeSchedule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the Compute Cloud@Customer upgrade schedule. tags: - computeCloudAtCustomer x-example: "Example: Update a Compute Cloud@Customer upgrade schedule to have one upgrade window (event) on the \nlast Friday of each month. Any existing upgrade windows (events) in the specified upgrade schedule \nwill be overwritten by the new definition.\nHost: ccc.us-phoenix-1.oci.oraclecloud.com\nPUT /20221208/cccUpgradeSchedules/ocid1.cccupgradeschedule.oc1..<unique_ID>\n{\n \"compartmentId\": <compartment_OCID>,\n \"displayName\": \"example_cccUpgradeSchedule_V2\",\n \"events\": [\n {\n \"description\": \"Month-end upgrade window\",\n \"timeStart\": \"2024-01-25T22:00:00Z\",,\n \"scheduleEventDuration\": \"P2DT6H\",\n \"scheduleEventRecurrences\": \"FREQ=MONTHLY;INTERVAL=1;BYDAY=-1FR\"\n }\n ],\n<authorization and other headers>\n" x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/CccUpgradeSchedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCccUpgradeScheduleDetails' description: The information to be updated in the Compute Cloud@Customer upgrade schedule. required: true /cccUpgradeSchedules/{cccUpgradeScheduleId}/actions/changeCompartment: post: description: 'Moves a Compute Cloud@Customer upgrade schedule from one compartment to another using the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: ChangeCccUpgradeScheduleCompartment parameters: - $ref: '#/components/parameters/CccUpgradeScheduleIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Changed the compartment and updated the schedule. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a Compute Cloud@Customer upgrade schedule. tags: - computeCloudAtCustomer x-example: "Example: Change the specified Compute Cloud@Customer upgrade schedule to a different compartment.\nHost: ccc.us-phoenix-1.oci.oraclecloud.com\nPUT /20221208/cccUpgradeSchedules/ocid1.cccupgradeschedule.oc1..<unique_ID>/actions/changeCompartment\n{\n \"compartmentId\": <new_compartment_OCID>\n}\n<authorization and other headers>\n" x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CccUpgradeSchedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCccUpgradeScheduleCompartmentDetails' description: 'Details about the compartment change operation including the destination compartment specified by the resource [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' required: true components: parameters: PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated AccessLevelQueryParam: description: 'Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. ' in: query name: accessLevel schema: type: string enum: - RESTRICTED - ACCESSIBLE default: RESTRICTED DisplayNameContainsQueryParam: description: 'A filter to return only resources whose display name contains the substring. ' in: query name: displayNameContains required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 CompartmentIdQueryParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. ' in: query name: compartmentId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string CccInfrastructureIdPathParam: description: "An [OCID](/iaas/Content/General/Concepts/identifiers.htm) for a \nCompute Cloud@Customer Infrastructure.\n" in: path name: cccInfrastructureId required: true schema: type: string maxLength: 255 minLength: 1 CccInfrastructureIdQueryParam: description: "An [OCID](/iaas/Content/General/Concepts/identifiers.htm) for a \nCompute Cloud@Customer Infrastructure.\n" in: query name: cccInfrastructureId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 CccInfrastructureLifecycleStateQueryParam: description: A filter used to return only resources that match the given lifecycleState. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/CccInfrastructure/lifecycleState' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC CccUpgradeScheduleIdPathParam: description: 'Compute Cloud@Customer upgrade schedule [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' in: path name: cccUpgradeScheduleId required: true schema: type: string maxLength: 255 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 CccUpgradeScheduleLifecycleStateQueryParam: description: 'A filter to return resources only when their lifecycleState matches the given lifecycleState. ' in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/CccUpgradeSchedule/lifecycleState' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: 'The client request [OCID](/iaas/Content/General/Concepts/identifiers.htm) for tracing. ' in: header name: opc-request-id schema: type: string minLength: 1 CompartmentIdInSubtreeQueryParam: description: 'Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and sub-compartments in the tenancy are returned. Depends on the ''accessLevel'' setting. ' in: query name: compartmentIdInSubtree x-default-description: 'Lists all the resources in the compartment subtree if this value is set to true. ' schema: type: boolean default: false CccUpgradeScheduleIdQueryParam: description: 'Compute Cloud@Customer upgrade schedule [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: cccUpgradeScheduleId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 schemas: CccInfrastructureCollection: description: 'Results of a Compute Cloud@Customer infrastructure search. ' properties: items: description: List of Compute Cloud@Customer infrastructures. items: $ref: '#/components/schemas/CccInfrastructureSummary' maxItems: 64 type: array required: - items type: object CccInfrastructureSummary: description: Summary information about a Compute Cloud@Customer infrastructure. properties: compartmentId: description: 'The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) associated with the infrastructure. ' maxLength: 255 minLength: 1 type: string connectionState: description: 'The current connection state of the infrastructure. ' example: READY type: string x-obmcs-enumref: '#/definitions/CccInfrastructure/connectionState' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'The name that will be used to display the Compute Cloud@Customer infrastructure in the Oracle Cloud Infrastructure console. Does not have to be unique and can be changed. Avoid entering confidential information. ' example: Blue Semiconductor Compute Cloud@Customer infrastructure maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: 'The Compute Cloud@Customer infrastructure [OCID](/iaas/Content/General/Concepts/identifiers.htm). This cannot be changed once created. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Compute Cloud@Customer infrastructure. type: string x-obmcs-enumref: '#/definitions/CccInfrastructure/lifecycleState' shortName: description: 'The Compute Cloud@Customer infrastructure short name. This is generated at the time the resource is created and cannot be changed. The short name can be used when communicating with Oracle Service and may be used during the configuration of the data center network. ' maxLength: 32 minLength: 1 type: string subnetId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) for the network subnet that is used to communicate with Compute Cloud@Customer infrastructure. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: "Compute Cloud@Customer infrastructure creation date and time. An RFC3339 formatted \ndatetime string.\n" format: date-time type: string required: - id - displayName - compartmentId - subnetId - lifecycleState - timeCreated type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message UpdateCccInfrastructureDetails: description: Updates Compute Cloud@Customer infrastructure configuration details. properties: cccUpgradeScheduleId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of a Compute Cloud@Customer upgrade schedule. An empty string results in the removal of an existing schedule from the Compute Cloud@Customer infrastructure resource. ' maxLength: 255 minLength: 0 type: string connectionDetails: description: 'A message describing the current connection state in more detail. ' example: Disconnected due to failed healthcheck. maxLength: 255 minLength: 1 type: string connectionState: description: 'An updated connection state of the Compute Cloud@Customer infrastructure. ' example: READY type: string x-obmcs-enumref: '#/definitions/CccInfrastructure/connectionState' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A mutable client-meaningful text description of the Compute Cloud@Customer infrastructure. Avoid entering confidential information. ' example: Blue Semiconductor Datacenter 231. maxLength: 400 minLength: 1 type: string displayName: description: 'The name that will be used to display the Compute Cloud@Customer infrastructure in the Oracle Cloud Infrastructure console. Does not have to be unique and can be changed. Avoid entering confidential information. ' example: Blue Semiconductor Compute Cloud@Customer infrastructure maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object subnetId: description: "[OCID](/iaas/Content/General/Concepts/identifiers.htm) for the network subnet that is \nused to communicate with Compute Cloud@Customer infrastructure.\n" maxLength: 255 minLength: 1 type: string type: object CccInfrastructureManagementNode: description: 'Information about an individual management node in a Compute Cloud@Customer infrastructure. ' properties: hostname: description: Hostname for interface to the management node. maxLength: 255 minLength: 1 type: string ip: description: Address of the management node. maxLength: 24 minLength: 7 type: string type: object UpdateCccUpgradeScheduleDetails: description: 'Updates the schedule details, all schedule information must be entered, similar to an initial schedule create. Include all events in the update. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'An optional description of the Compute Cloud@Customer upgrade schedule. Avoid entering confidential information. ' example: Compute Cloud@Customer Upgrade Schedule for Datacenter 231. maxLength: 400 minLength: 1 type: string displayName: description: 'Compute Cloud@Customer upgrade schedule display name. Avoid entering confidential information. ' example: Compute Cloud@Customer Upgrade Schedule maxLength: 255 minLength: 1 type: string events: description: 'List of preferred times for a Compute Cloud@Customer infrastructure to be upgraded. ' items: $ref: '#/components/schemas/UpdateCccScheduleEvent' maxItems: 24 type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object CreateCccInfrastructureDetails: description: The configuration details for creating Compute Cloud@Customer infrastructure. properties: cccUpgradeScheduleId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of a Compute Cloud@Customer upgrade schedule. If no schedule is associated with the infrastructure, the infrastructure can be upgraded at any time. ' maxLength: 255 minLength: 1 type: string compartmentId: description: 'The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) associated with the infrastructure. ' maxLength: 255 minLength: 1 type: string connectionDetails: description: 'A message describing the current connection state in more detail. ' example: Disconnected due to failed healthcheck. maxLength: 255 minLength: 1 type: string connectionState: description: 'The current connection state of the Compute Cloud@Customer infrastructure. This value will default to REJECT if the value is not provided. The only valid value at creation time is REJECT. ' example: READY type: string x-obmcs-enumref: '#/definitions/CccInfrastructure/connectionState' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A mutable client-meaningful text description of the Compute Cloud@Customer infrastructure. Avoid entering confidential information. ' example: Blue Semiconductor Datacenter 231. maxLength: 400 minLength: 1 type: string displayName: description: 'The name that will be used to display the Compute Cloud@Customer infrastructure in the Oracle Cloud Infrastructure console. Does not have to be unique and can be changed. Avoid entering confidential information. ' example: Blue Semiconductor Compute Cloud@Customer infrastructure maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object subnetId: description: Identifier for network subnet that will be used to communicate with Compute Cloud@Customer infrastructure. maxLength: 255 minLength: 1 type: string required: - displayName - compartmentId - subnetId type: object CccScheduleEvent: description: 'A period where upgrades may be applied to Compute Cloud@Customer infrastructures associated with the schedule. All upgrade windows may not be used. ' properties: description: description: A description of the Compute Cloud@Customer upgrade schedule time block. example: Weekly full day upgrade block. maxLength: 400 minLength: 1 type: string name: description: Generated name associated with the event. example: dfdaf441-e58f-46cd-b6e5-cfe1ab0f6631 maxLength: 255 minLength: 1 type: string scheduleEventDuration: description: 'The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations. ' example: P1DT6H format: x-obmcs-duration type: string scheduleEventRecurrences: description: 'Frequency of recurrence of schedule block. When this field is not included, the event is assumed to be a one time occurrence. The frequency field is strictly parsed and must conform to RFC-5545 formatting for recurrences. ' example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1 format: x-obmcs-recurring-time type: string timeStart: description: 'The date and time when the Compute Cloud@Customer upgrade schedule event starts, inclusive. An RFC3339 formatted UTC datetime string. For an event with recurrences, this is the date that a recurrence can start being applied. ' example: 1998-01-18 07:30:00+00:00 format: date-time type: string required: - name - description - timeStart - scheduleEventDuration type: object ChangeCccInfrastructureCompartmentDetails: description: Information required for the compartment change operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CccUpgradeInformation: description: 'Upgrade information that relates to a Compute Cloud@Customer infrastructure. This information cannot be updated. ' properties: currentVersion: description: 'The current version of software installed on the Compute Cloud@Customer infrastructure. ' example: 3.0.200.post8.gb4d3cdb maxLength: 255 minLength: 1 type: string isActive: default: false description: 'Indication that the Compute Cloud@Customer infrastructure is in the process of an upgrade or an upgrade activity (such as preloading upgrade images). ' type: boolean scheduledUpgradeDuration: description: 'Expected duration of Compute Cloud@Customer infrastructure scheduled upgrade. The actual upgrade time might be longer or shorter than this duration depending on rack activity, this is only an estimate. ' example: P1DT6H format: x-obmcs-duration type: string timeOfScheduledUpgrade: description: 'Compute Cloud@Customer infrastructure next upgrade time. The rack might have performance impacts during this time. ' format: date-time type: string ChangeCccUpgradeScheduleCompartmentDetails: description: Change the compartment of a Compute Cloud@Customer upgrade schedule. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateCccUpgradeScheduleDetails: description: 'Defines a schedule for times when automated Compute Cloud@Customer upgrades are preferred. A created upgrade schedule must supply events with a minimum frequency and duration or the schedule will be rejected. Upgrades may impact performance of Compute Cloud@Customer infrastructures when they are being applied. ' properties: compartmentId: description: 'Compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Compute Cloud@Customer Upgrade Schedule. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'An optional description of the Compute Cloud@Customer upgrade schedule. Avoid entering confidential information. ' example: Compute Cloud@Customer Upgrade Schedule for Datacenter 231. maxLength: 400 minLength: 1 type: string displayName: description: 'Compute Cloud@Customer upgrade schedule display name. Avoid entering confidential information. ' example: Compute Cloud@Customer Upgrade Schedule maxLength: 255 minLength: 1 type: string events: description: 'List of preferred times for Compute Cloud@Customer infrastructure to be upgraded. ' items: $ref: '#/components/schemas/CreateCccScheduleEvent' maxItems: 24 minItems: 0 type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - displayName - compartmentId - events type: object CccInfrastructureRoutingStaticDetails: description: Static routing information for a rack. properties: uplinkHsrpGroup: default: 151 description: 'The uplink Hot Standby Router Protocol (HSRP) group value for the switch in the Compute Cloud@Customer infrastructure. ' maximum: 255 minimum: 0 type: integer uplinkVlan: default: 3911 description: 'The virtual local area network (VLAN) identifier used to connect to the uplink (only access mode is supported). ' example: 3911 maximum: 4094 minimum: 1 type: integer CccUpgradeSchedule: description: Defines a schedule for preferred upgrade times. properties: compartmentId: description: 'Compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Compute Cloud@Customer upgrade schedule. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'An optional description of the Compute Cloud@Customer upgrade schedule. Avoid entering confidential information. ' example: Compute Cloud@Customer Upgrade Schedule for Datacenter 231. maxLength: 400 minLength: 1 type: string displayName: description: 'Compute Cloud@Customer upgrade schedule display name. Avoid entering confidential information. ' example: Compute Cloud@Customer Upgrade Schedule maxLength: 255 minLength: 1 type: string events: description: 'List of preferred times for Compute Cloud@Customer infrastructures associated with this schedule to be upgraded. ' items: $ref: '#/components/schemas/CccScheduleEvent' maxItems: 24 type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: 'Upgrade schedule [OCID](/iaas/Content/General/Concepts/identifiers.htm). This cannot be changed once created. ' maxLength: 255 minLength: 1 type: string infrastructureIds: description: 'List of Compute Cloud@Customer infrastructure [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) that are using this upgrade schedule. ' items: maxLength: 255 minLength: 1 type: string maxItems: 255 type: array lifecycleDetails: description: 'A message describing the current state in more detail. For example, the message can be used to provide actionable information for a resource in a Failed state. ' example: Schedule does not allow sufficient time for upgrade. maxLength: 255 minLength: 1 type: string lifecycleState: description: Lifecycle state of the resource. enum: - ACTIVE - NEEDS_ATTENTION - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time the upgrade schedule was created, using an RFC3339 formatted datetime string. ' format: date-time type: string timeUpdated: description: 'The time the upgrade schedule was updated, using an RFC3339 formatted datetime string. ' format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated type: object UpdateCccScheduleEvent: description: 'A period where upgrades may be applied to Compute Cloud@Customer infrastructures associated with the schedule. All upgrade windows may not be used. ' properties: description: description: A description of the Compute Cloud@Customer upgrade schedule time block. example: Weekly full day upgrade block. maxLength: 400 minLength: 1 type: string scheduleEventDuration: description: 'The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations. ' example: P1DT6H format: x-obmcs-duration type: string scheduleEventRecurrences: description: 'Frequency of recurrence of schedule block. When this field is not included, the event is assumed to be a one time occurrence. The frequency field is strictly parsed and must conform to RFC-5545 formatting for recurrences. ' example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1 format: x-obmcs-recurring-time type: string timeStart: description: 'The date and time when the Compute Cloud@Customer upgrade schedule event starts, inclusive. An RFC3339 formatted UTC datetime string. For an event with recurrences, this is the date that a recurrence can start being applied. ' example: 1998-01-18 07:30:00+00:00 format: date-time type: string required: - description - timeStart - scheduleEventDuration type: object CccUpgradeScheduleSummary: description: 'Basic information about a Compute Cloud@Customer schedule. This summary only includes high level resource information, not the schedule events. ' properties: compartmentId: description: 'Compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Compute Cloud@Customer Upgrade Schedule. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'Compute Cloud@Customer upgrade schedule display name. Avoid entering any confidential information. ' example: Routine Compute Cloud@Customer upgrade schedule. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: 'The upgrade schedule [OCID](/iaas/Content/General/Concepts/identifiers.htm). This cannot be changed once created. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of the Compute Cloud@Customer upgrade schedule. ' type: string x-obmcs-enumref: '#/definitions/CccUpgradeSchedule/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the upgrade schedule was created. An RFC3339 formatted datetime string format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated type: object CccInfrastructureRoutingDynamicDetails: description: 'Dynamic routing information for the Compute Cloud@Customer infrastructure. ' properties: bgpTopology: default: TRIANGLE description: 'The topology in use for the Border Gateway Protocol (BGP) configuration. ' enum: - TRIANGLE - SQUARE - MESH example: TRIANGLE type: string oracleAsn: default: 136025 description: 'The Oracle Autonomous System Number (ASN) to control routing and exchange information within the dynamic routing configuration. ' minimum: 1 type: integer peerInformation: description: The list of peer devices in the dynamic routing configuration. items: $ref: '#/components/schemas/PeerInformation' maxItems: 3 minItems: 3 type: array CccInfrastructure: description: 'The Oracle Cloud Infrastructure resource representing the connection to the hardware and software located in a customer''s data center running the Compute Cloud@Customer IaaS services. ' properties: cccUpgradeScheduleId: description: 'Schedule used for upgrades. If no schedule is associated with the infrastructure, the infrastructure can be updated at any time. ' maxLength: 255 minLength: 0 type: string compartmentId: description: The infrastructure compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string connectionDetails: description: 'A message describing the current connection state in more detail. ' example: Disconnected due to failed healthcheck. maxLength: 255 minLength: 1 type: string connectionState: description: 'The current connection state of the infrastructure. A user can only update it from REQUEST to READY or from any state back to REJECT. The system automatically handles the REJECT to REQUEST, READY to CONNECTED, or CONNECTED to DISCONNECTED transitions. ' enum: - REJECT - REQUEST - READY - CONNECTED - DISCONNECTED example: REJECT type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A mutable client-meaningful text description of the Compute Cloud@Customer infrastructure. Avoid entering confidential information. ' example: Blue Semiconductor Datacenter 231. maxLength: 400 minLength: 1 type: string displayName: description: 'The name that will be used to display the Compute Cloud@Customer infrastructure in the Oracle Cloud Infrastructure console. Does not have to be unique and can be changed. Avoid entering confidential information. ' example: Blue Semiconductor Compute Cloud@Customer infrastructure maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: 'The Compute Cloud@Customer infrastructure [OCID](/iaas/Content/General/Concepts/identifiers.htm). This cannot be changed once created. ' maxLength: 255 minLength: 1 type: string infrastructureInventory: $ref: '#/components/schemas/CccInfrastructureInventory' infrastructureNetworkConfiguration: $ref: '#/components/schemas/CccInfrastructureNetworkConfiguration' lifecycleDetails: description: 'A message describing the current lifecycle state in more detail. For example, this can be used to provide actionable information for a resource that is in a Failed state. ' example: Resource failed to create due to invalid configuration. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Compute Cloud@Customer infrastructure. enum: - ACTIVE - NEEDS_ATTENTION - DELETED - FAILED example: ACTIVE type: string provisioningFingerprint: description: 'Fingerprint of a Compute Cloud@Customer infrastructure in a data center generated during the initial connection to this resource. The fingerprint should be verified by the administrator when changing the connectionState from REQUEST to READY. ' example: 97:3c:ae:76:73:f3:ef:a7:18:02:6a:c6:57:43:82:f6 maxLength: 255 minLength: 1 type: string provisioningPin: description: 'Code that is required for service personnel to connect a Compute Cloud@Customer infrastructure in a data center to this resource. This code will only be available when the connectionState is REJECT (usually at create time of the Compute Cloud@Customer infrastructure). ' maxLength: 10 minLength: 6 type: string shortName: description: 'The Compute Cloud@Customer infrastructure short name. This cannot be changed once created. The short name is used to refer to the infrastructure in several contexts and is unique. ' maxLength: 32 minLength: 1 type: string subnetId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) for the network subnet that is used to communicate with Compute Cloud@Customer infrastructure. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'Compute Cloud@Customer infrastructure creation date and time, using an RFC3339 formatted datetime string. ' format: date-time type: string timeUpdated: description: 'Compute Cloud@Customer infrastructure updated date and time, using an RFC3339 formatted datetime string. ' format: date-time type: string upgradeInformation: $ref: '#/components/schemas/CccUpgradeInformation' required: - id - displayName - compartmentId - subnetId - lifecycleState - timeCreated type: object PeerInformation: description: 'Routing information for peer nodes using the Border Gateway Protocol (BGP). ' properties: asn: description: The Autonomous System Number (ASN) of the peer network. minimum: 1 type: integer ip: description: 'Neighbor Border Gateway Protocal (BGP) IP address. The IP address usually refers to the customer data center router. ' maxLength: 24 minLength: 7 type: string type: object CreateCccScheduleEvent: description: 'A period where upgrades may be applied to Compute Cloud@Customer infrastructures associated with the schedule. All upgrade windows may not be used. ' properties: description: description: A description of the Compute Cloud@Customer upgrade schedule time block. example: Weekly full day upgrade block. maxLength: 400 minLength: 1 type: string scheduleEventDuration: description: 'The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations. ' example: P1DT6H format: x-obmcs-duration type: string scheduleEventRecurrences: description: 'Frequency of recurrence of schedule block. When this field is not included, the event is assumed to be a one time occurrence. The frequency field is strictly parsed and must conform to RFC-5545 formatting for recurrences. ' example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1 format: x-obmcs-recurring-time type: string timeStart: description: 'The date and time when the Compute Cloud@Customer upgrade schedule event starts, inclusive. An RFC3339 formatted UTC datetime string. For an event with recurrences, this is the date that a recurrence can start being applied. ' example: 1998-01-18 07:30:00+00:00 format: date-time type: string required: - description - timeStart - scheduleEventDuration type: object CccInfrastructureInventory: description: 'Inventory for a Compute Cloud@Customer infrastructure. This information cannot be updated and is from the infrastructure. The information will only be available after the connectionState is transitioned to CONNECTED. ' properties: capacityStorageTrayCount: description: The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for capacity storage. maximum: 255 minimum: 0 type: integer computeNodeCount: description: 'The number of compute nodes that are available and usable on the Compute Cloud@Customer infrastructure rack. There is no distinction of compute node type in this information. ' maximum: 255 minimum: 0 type: integer managementNodeCount: description: 'The number of management nodes that are available and in active use on the Compute Cloud@Customer infrastructure rack. ' maximum: 9 minimum: 0 type: integer performanceStorageTrayCount: description: The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for performance storage. maximum: 255 minimum: 0 type: integer serialNumber: description: 'The serial number of the Compute Cloud@Customer infrastructure rack. ' maxLength: 255 minLength: 1 type: string CccUpgradeScheduleCollection: description: 'Results of a Compute Cloud@Customer upgrade schedule search. Contains the summary items and other information, such as metadata. ' properties: items: description: List of Compute Cloud@Customer upgrade schedules. items: $ref: '#/components/schemas/CccUpgradeScheduleSummary' maxItems: 64 minItems: 0 type: array required: - items type: object CccInfrastructureNetworkConfiguration: description: "Configuration information for the Compute Cloud@Customer infrastructure. This \nnetwork configuration information cannot be updated and is retrieved from the data center.\nThe information will only be available\nafter the connectionState is transitioned to CONNECTED.\n" properties: dnsIps: description: 'The domain name system (DNS) addresses that the Compute Cloud@Customer infrastructure uses for the data center network. ' items: type: string maxItems: 3 minItems: 1 type: array infrastructureRoutingDynamic: $ref: '#/components/schemas/CccInfrastructureRoutingDynamicDetails' infrastructureRoutingStatic: $ref: '#/components/schemas/CccInfrastructureRoutingStaticDetails' managementNodes: description: 'Information about the management nodes that are provisioned in the Compute Cloud@Customer infrastructure. ' items: $ref: '#/components/schemas/CccInfrastructureManagementNode' maxItems: 3 minItems: 1 type: array mgmtVipHostname: description: 'The hostname corresponding to the virtual IP (VIP) address of the management nodes. ' example: management.ccc.example.com maxLength: 255 minLength: 1 type: string mgmtVipIp: description: The IP address used as the virtual IP (VIP) address of the management nodes. maxLength: 24 minLength: 7 type: string spineIps: description: Addresses of the network spine switches. items: maxLength: 24 minLength: 7 type: string maxItems: 2 minItems: 2 type: array spineVip: description: "The spine switch public virtual IP (VIP). Traffic routed to the\nCompute Cloud@Customer infrastructure and \nand virtual cloud networks (VCNs) should have this address as next hop.\n" maxLength: 24 minLength: 7 type: string uplinkDomain: description: "Domain name to be used as the base domain for the internal network and by \npublic facing services.\n" maximum: 190 minimum: 1 type: string uplinkGatewayIp: description: 'Uplink gateway in the datacenter network that the Compute Cloud@Customer connects to. ' maxLength: 24 minLength: 7 type: string uplinkNetmask: description: 'Netmask of the subnet that the Compute Cloud@Customer infrastructure is connected to. ' maxLength: 24 minLength: 7 type: string uplinkPortCount: default: 4 description: 'Number of uplink ports per spine switch. Connectivity is identical on both spine switches. For example, if input is two 100 gigabyte ports; then port-1 and port-2 on both spines will be configured. ' enum: - 1 - 2 - 4 - 8 - 16 example: 4 type: integer uplinkPortForwardErrorCorrection: default: AUTO description: 'The port forward error correction (FEC) setting for the uplink port on the Compute Cloud@Customer infrastructure. ' enum: - AUTO - false - FIRE_CODE_FEC - REED_SOLOMON_CONSORTIUM_16 - REED_SOLOMON_FEC - REED_SOLOMON_IEEE type: string uplinkPortSpeedInGbps: default: 100 description: 'Uplink port speed defined in gigabytes per second. All uplink ports must have identical speed. ' example: 100 type: integer uplinkVlanMtu: default: 9216 description: 'The virtual local area network (VLAN) maximum transmission unit (MTU) size for the uplink ports. ' example: 9216 minimum: 1 type: integer responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-prev-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the previous batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.ccatc