openapi: 3.2.0 info: description: 'Use the Cloud Advisor API to find potential inefficiencies in your tenancy and address them. Cloud Advisor can help you save money, improve performance, strengthen system resilience, and improve security. For more information, see [Cloud Advisor](/Content/CloudAdvisor/Concepts/cloudadvisoroverview.htm). ' title: Cloud Advisor Optimizer API version: '20200606' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/321b6e72c522371194cdfccd7f4baba8c0059033e00f99013ea466ec44921ca3.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Cloud Advisor 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/321b6e72c522371194cdfccd7f4baba8c0059033e00f99013ea466ec44921ca3.yaml what: the harvested document for Cloud Advisor API servers: - url: http://127.0.0.1/20200606 - url: https://127.0.0.1/20200606 tags: - name: optimizer paths: /actions/filterResourceActions: post: description: 'Queries the Cloud Advisor resource actions that are supported. ' operationId: FilterResourceActions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The resource actions were retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/ResourceActionCollection' 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: Include a list of resource actions. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ResourceActionSummary' requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryDetails' description: The request parameters that describe the query criteria. required: true /categories: get: description: 'Lists the supported Cloud Advisor categories. ' operationId: ListCategories parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The list is being retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/CategoryCollection' 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: Include a list of optimizer categories that are currently supported. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CategorySummary' /categories/{categoryId}: get: description: 'Gets the category that corresponds to the specified OCID. ' operationId: GetCategory parameters: - $ref: '#/components/parameters/CategoryIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The category was retrieved. 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/Category' 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: Get the category for the OCID specified. tags: - optimizer x-obmcs-client-retries-enabled: true /enrollmentStatus: get: description: 'Lists the Cloud Advisor enrollment statuses. ' operationId: ListEnrollmentStatuses parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/OptimizerEnrollmentStatusQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The enrollment status list was retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/EnrollmentStatusCollection' 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: Lists the Cloud Advisor enrollment statuses. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/EnrollmentStatusSummary' /enrollmentStatus/{enrollmentStatusId}: get: description: 'Gets the Cloud Advisor enrollment status. ' operationId: GetEnrollmentStatus parameters: - $ref: '#/components/parameters/EnrollmentStatusIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The enrollment status was retrieved. 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/EnrollmentStatus' 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 the optimizer enrollment status. tags: - optimizer x-obmcs-client-retries-enabled: true put: description: 'Updates the enrollment status of the tenancy. ' operationId: UpdateEnrollmentStatus parameters: - $ref: '#/components/parameters/EnrollmentStatusIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcIfMatchHeaderParam' responses: 200: description: The enrollment status was updated. 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/EnrollmentStatus' 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: Update the enrollment status of the tenancy. tags: - optimizer x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEnrollmentStatusDetails' description: The request object for updating the enrollment status. required: true /histories: get: description: "Lists changes to the recommendations based on user activity. \nFor example, lists when recommendations have been implemented, dismissed, postponed, or reactivated.\n" operationId: ListHistories parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/RecommendationNameQueryParam' - $ref: '#/components/parameters/OptionalRecommendationIdQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/StatusQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The history was retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/HistoryCollection' 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: Included a list of recommendation history changes. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/HistorySummary' /profileLevels: get: description: 'Lists the existing profile levels. ' operationId: ListProfileLevels parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/RecommendationNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The list is being retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/ProfileLevelCollection' 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: Lists the existing profile levels. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ProfileLevelSummary' /profiles: get: description: 'Lists the existing profiles. ' operationId: ListProfiles parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The list is being retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/ProfileCollection' 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: Lists the existing profiles. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ProfileSummary' post: description: 'Creates a new profile. ' operationId: CreateProfile parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeader' responses: 200: description: The profile is being created. 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/Profile' 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 profile. tags: - optimizer x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProfileDetails' description: Details for creating the profile. required: true /profiles/{profileId}: delete: description: 'Deletes the specified profile. Uses the profile''s OCID to determine which profile to delete. ' operationId: DeleteProfile parameters: - $ref: '#/components/parameters/ProfileIdPathParam' - $ref: '#/components/parameters/OpcIfMatchHeaderParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 204: description: The profile is being deleted. 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 the specified profile. Uses the profile's OCID to determine which profile to delete. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Profile' get: description: 'Gets the specified profile''s information. Uses the profile''s OCID to determine which profile to retrieve. ' operationId: GetProfile parameters: - $ref: '#/components/parameters/ProfileIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The profile was retrieved. 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/Profile' 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 the specified profile's information. Uses the profile's OCID to determine which profile to retrieve. tags: - optimizer x-obmcs-client-retries-enabled: true put: description: 'Updates the specified profile. Uses the profile''s OCID to determine which profile to update. ' operationId: UpdateProfile parameters: - $ref: '#/components/parameters/ProfileIdPathParam' - $ref: '#/components/parameters/OpcIfMatchHeaderParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The profile was updated. 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/Profile' 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: Updates the specified profile. Uses the profile's OCID to determine which profile to update. tags: - optimizer x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProfileDetails' description: The profile information to use for the update. required: true /recommendationStrategies: get: description: 'Lists the existing strategies. ' operationId: ListRecommendationStrategies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/RecommendationNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The list is being retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/RecommendationStrategyCollection' 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: Lists the existing strategies. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/RecommendationStrategySummary' /recommendations: get: description: 'Lists the Cloud Advisor recommendations that are currently supported. ' operationId: ListRecommendations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/CategoryIdQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/StatusQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The list is being retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/RecommendationCollection' 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: Include a list of optimizer recommendations. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/RecommendationSummary' /recommendations/{recommendationId}: get: description: 'Gets the recommendation for the specified OCID. ' operationId: GetRecommendation parameters: - $ref: '#/components/parameters/RecommendationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The recommendation was retrieved. 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/Recommendation' 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: Get the recommendation for the OCID specified. tags: - optimizer x-obmcs-client-retries-enabled: true put: description: "Updates the recommendation that corresponds to the specified OCID.\nUse this operation to implement the following actions:\n\n * Postpone recommendation\n * Dismiss recommendation\n * Reactivate recommendation\n" operationId: UpdateRecommendation parameters: - $ref: '#/components/parameters/RecommendationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcIfMatchHeaderParam' responses: 200: description: The recommendation was updated. 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/Recommendation' 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: Updates the recommendation with the given OCID. tags: - optimizer requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRecommendationDetails' description: The request object for updating the recommendation details. required: true /recommendations/{recommendationId}/actions/bulkApplyRecommendations: post: description: 'Applies the specified recommendations to the resources. ' operationId: BulkApplyRecommendations parameters: - $ref: '#/components/parameters/RecommendationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeader' responses: 202: description: The request was accepted for processing. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 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: Applies the specified recommendations to the resources. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Recommendation' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkApplyRecommendationsDetails' description: Details about bulk recommendation actions. required: true /resourceActions: get: description: 'Lists the Cloud Advisor resource actions that are supported. ' operationId: ListResourceActions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/FilterByNameQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/StatusQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The resource actions were retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/ResourceActionCollection' 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: Include a list of resource actions. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/ResourceActionSummary' /resourceActions/actions/getQueryableFields: get: description: 'Lists the fields that are indexed for querying and their associated value types. ' operationId: ListResourceActionQueryableFields parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The list is being retrieved. 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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/QueryableFieldCollection' 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: List of all the fields and their value type that are indexed for querying resource actions. tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/QueryableFieldSummary' /resourceActions/{resourceActionId}: get: description: 'Gets the resource action that corresponds to the specified OCID. ' operationId: GetResourceAction parameters: - $ref: '#/components/parameters/ResourceActionIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The resource action was retrieved. 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/ResourceAction' 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: Get the resource action for the OCID specified. tags: - optimizer x-obmcs-client-retries-enabled: true put: description: "Updates the resource action that corresponds to the specified OCID. \nUse this operation to implement the following actions:\n\n * Postpone resource action\n * Ignore resource action\n * Reactivate resource action\n" operationId: UpdateResourceAction parameters: - $ref: '#/components/parameters/ResourceActionIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcIfMatchHeaderParam' responses: 200: description: The resource action was updated. 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/ResourceAction' 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: Updates the resource action with the given OCID. tags: - optimizer x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateResourceActionDetails' description: The resource action information to be updated. required: true /workRequests: get: description: 'Lists the work requests in the tenancy. The tenancy is the root compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The list is being retrieved. 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-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/WorkRequestCollection' 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: List Work Requests tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Gets the status of the work request associated with the specified ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The work request status was retrieved. 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 retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: number format: float content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 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: Get Work Request Status tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Lists errors associated with the specified work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The list is being retrieved. 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-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/WorkRequestErrorCollection' 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: Lists work request errors tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Lists the logs associated with the specified work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The list is being retrieved. 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-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/WorkRequestLogEntryCollection' 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: Lists the work request logs tags: - optimizer x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: ResourceTypeQueryParam: description: Optional. A filter that returns results that match the resource type specified. in: query name: resourceType required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 CategoryIdPathParam: description: The unique OCID associated with the category. in: path name: categoryId required: true schema: type: string maxLength: 255 minLength: 1 RecommendationNameQueryParam: description: Optional. A filter that returns results that match the recommendation name specified. in: query name: recommendationName required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 OpcIfMatchHeaderParam: 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 maxLength: 255 PaginationTokenQueryParam: description: 'The value of the `opc-next-page` response header from the previous "List" call. ' in: query name: page x-default-description: 'null' schema: type: string maxLength: 1024 minLength: 1 RecommendationIdPathParam: description: The unique OCID associated with the recommendation. in: path name: recommendationId required: true schema: type: string maxLength: 255 minLength: 1 SortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. ' in: query name: sortBy required: false x-default-description: By default, TIMECREATED is used to sort by. schema: type: string enum: - NAME - TIMECREATED OpcRetryTokenHeader: 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 may be rejected). ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 EnrollmentStatusIdPathParam: description: The unique OCID associated with the enrollment status. in: path name: enrollmentStatusId required: true schema: type: string maxLength: 255 minLength: 1 CompartmentIdQueryParam: description: The OCID of the compartment. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return in a paginated "List" call. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 ResourceActionIdPathParam: description: The unique OCID associated with the resource action. in: path name: resourceActionId required: true schema: type: string maxLength: 255 minLength: 1 ProfileIdPathParam: description: The unique OCID of the profile. in: path name: profileId required: true schema: type: string maxLength: 255 minLength: 1 OptionalRecommendationIdQueryParam: description: The unique OCID associated with the recommendation. in: query name: recommendationId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 FilterByNameQueryParam: description: Optional. A filter that returns results that match the name specified. in: query name: name required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkRequestIdPathParam: description: The OCID of the work request. in: path name: workRequestId required: true schema: type: string maxLength: 255 minLength: 1 SortOrderQueryParam: description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). in: query name: sortOrder required: false x-default-description: For time-based fields, the default sort order is DESC (descending). For all others, it is ASC (ascending). x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC StatusQueryParam: description: 'A filter that returns recommendations that match the status specified. ' in: query name: status required: false x-default-description: Could be one of the possible status values x-obmcs-top-level-enum: '#/definitions/Status' schema: type: string enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED CategoryIdQueryParam: description: The unique OCID associated with the category. in: query name: categoryId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 OptimizerEnrollmentStatusQueryParam: description: 'A filter that returns results that match the Cloud Advisor enrollment status specified. ' in: query name: status required: false x-default-description: A filter that returns results that match the Cloud Advisor enrollment status specified. x-obmcs-top-level-enum: '#/definitions/OptimizerEnrollmentStatus' schema: type: string enum: - ACTIVE - INACTIVE OpcRequestIdHeaderParam: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string CompartmentIdInSubtreeQueryParam: description: 'When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`. Can only be set to true when performing ListCompartments on the tenancy (root compartment). ' in: query name: compartmentIdInSubtree required: true schema: type: boolean LifecycleStateQueryParam: description: 'A filter that returns results that match the lifecycle state specified. ' in: query name: lifecycleState required: false x-default-description: Could be one of the possible lifecycle state values x-obmcs-top-level-enum: '#/definitions/LifecycleState' schema: type: string enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING schemas: LevelConfiguration: description: Details about the configuration level for the recommendation. properties: level: description: The pre-defined profile level. maxLength: 255 minLength: 1 type: string recommendationId: description: The unique OCID of the recommendation. maxLength: 255 minLength: 1 type: string type: object ResourceAction: description: 'The metadata associated with the resource action. ' properties: action: $ref: '#/components/schemas/Action' categoryId: description: The unique OCID associated with the category. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string compartmentName: description: The name associated with the compartment. maxLength: 100 minLength: 1 type: string estimatedCostSaving: description: The estimated cost savings, in dollars, for the resource action. If cost information is not available, the value is -1. format: double minimum: 0 type: number extendedMetadata: additionalProperties: type: object description: 'Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` fields are string/string maps only). For example: `{"CurrentShape": {"name":"VM.Standard2.16"}, "RecommendedShape": {"name":"VM.Standard2.8"}}` ' type: object id: description: The unique OCID associated with the resource action. maxLength: 255 minLength: 1 type: string lifecycleState: description: The resource action's current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' metadata: additionalProperties: type: string description: "Custom metadata key/value pairs for the resource action.\n\n **Metadata Example**\n\n \"metadata\" : {\n \"cpuRecommendedShape\": \"VM.Standard1.1\",\n \"computeMemoryUtilization\": \"26.05734124418388\",\n \"currentShape\": \"VM.Standard1.2\",\n \"instanceRecommendedShape\": \"VM.Standard1.1\",\n \"computeCpuUtilization\": \"7.930035319720132\",\n \"memoryRecommendedShape\": \"None\"\n }\n" type: object name: description: The name assigned to the resource. maxLength: 255 minLength: 1 type: string recommendationId: description: The unique OCID associated with the recommendation. maxLength: 255 minLength: 1 type: string resourceId: description: The unique OCID associated with the resource. maxLength: 255 minLength: 1 type: string resourceType: description: The kind of resource. maxLength: 255 minLength: 1 type: string status: description: The current status of the resource action. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' timeCreated: description: The date and time the resource action details were created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeStatusBegin: description: 'The date and time that the resource action entered its current status. The format is defined by RFC3339. For example, "The status of the resource action changed from `pending` to `current(ignored)` on this date and time." ' format: date-time type: string timeStatusEnd: description: 'The date and time the current status will change. The format is defined by RFC3339. For example, "The current `postponed` status of the resource action will end and change to `pending` on this date and time." ' format: date-time type: string timeUpdated: description: The date and time the resource action details were last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - categoryId - recommendationId - resourceId - name - resourceType - compartmentId - compartmentName - action - lifecycleState - estimatedCostSaving - status - timeStatusBegin type: object ResourceCount: description: The count of resources in a category, grouped by status. properties: count: description: The count of resources. minimum: 0 type: integer status: description: The recommendation status of the resource. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' required: - status - count type: object RecommendationSummary: description: 'The metadata associated with the recommendation summary. ' properties: categoryId: description: The unique OCID associated with the category. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the tenancy. The tenancy is the root compartment. maxLength: 255 minLength: 1 type: string description: description: Text describing the recommendation. maxLength: 400 minLength: 1 type: string estimatedCostSaving: description: The estimated cost savings, in dollars, for the recommendation. If cost information is not available, the value is -1. format: double minimum: 0 type: number extendedMetadata: additionalProperties: type: string description: 'Additional metadata key/value pairs for the recommendation summary. For example: `{"EstimatedSaving": "200"}` ' maxLength: 255 maxProperties: 25 type: object id: description: The unique OCID associated with the recommendation. maxLength: 255 minLength: 1 type: string importance: description: The level of importance assigned to the recommendation. enum: - CRITICAL - HIGH - MODERATE - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/Importance' lifecycleState: description: The recommendation's current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The name assigned to the recommendation. maxLength: 255 minLength: 1 type: string resourceCounts: description: An array of `ResourceCount` objects grouped by the status of the resource actions. items: $ref: '#/components/schemas/ResourceCount' type: array status: description: The current status of the recommendation. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' supportedLevels: $ref: '#/components/schemas/SupportedLevels' timeCreated: description: The date and time the recommendation details were created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeStatusBegin: description: 'The date and time that the recommendation entered its current status. The format is defined by RFC3339. For example, "The status of the recommendation changed from `pending` to `current(ignored)` on this date and time." ' format: date-time type: string timeStatusEnd: description: 'The date and time the current status will change. The format is defined by RFC3339. For example, "The current `postponed` status of the recommendation will end and change to `pending` on this date and time." ' format: date-time type: string timeUpdated: description: The date and time the recommendation details were last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - compartmentId - categoryId - name - description - importance - resourceCounts - lifecycleState - estimatedCostSaving - status - timeStatusBegin type: object UpdateEnrollmentStatusDetails: description: 'The request object for updating the enrollment status details. ' properties: status: description: The Cloud Advisor enrollment status. enum: - ACTIVE - INACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OptimizerEnrollmentStatus' required: - status type: object SupportedLevel: description: 'A system defined profile level supported by the recommendation. ' properties: name: description: The name of the profile level. maxLength: 255 minLength: 1 type: string type: object HistoryCollection: description: 'A list containing the recommendation history items that match filter criteria, if any. Results contain `HistorySummary` objects. ' properties: items: description: A collection of history summaries. items: $ref: '#/components/schemas/HistorySummary' type: array required: - items type: object Error: description: The representation of an error. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message type: object UpdateProfileDetails: description: 'Details for updating a profile. ' properties: aggregationIntervalInDays: description: The time period over which to collect data for the recommendations, measured in number of days. maximum: 90 minimum: 1 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Text describing the profile. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair applied without any predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object levelsConfiguration: $ref: '#/components/schemas/LevelsConfiguration' name: description: The name assigned to the profile. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string targetCompartments: $ref: '#/components/schemas/TargetCompartments' targetTags: $ref: '#/components/schemas/TargetTags' type: object RecommendationStrategySummary: description: 'The metadata associated with the recommendation strategy. ' properties: name: description: The display name of the recommendation. maxLength: 255 minLength: 1 type: string strategies: description: The list of strategies used. items: $ref: '#/components/schemas/Strategy' type: array required: - name - strategies type: object HistorySummary: description: 'The metadata associated with the recommendation history and its related resources. ' properties: action: $ref: '#/components/schemas/Action' categoryId: description: The unique OCID associated with the category. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string compartmentName: description: The name assigned to the compartment. maxLength: 100 minLength: 1 type: string estimatedCostSaving: description: The estimated cost savings, in dollars, for the resource action. If cost information is not available, the value is -1. format: double minimum: 0 type: number extendedMetadata: additionalProperties: type: object description: 'Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` fields are string/string maps only). For example: `{"CurrentShape": {"name":"VM.Standard2.16"}, "RecommendedShape": {"name":"VM.Standard2.8"}}` ' type: object id: description: The unique OCID associated with the recommendation history. maxLength: 255 minLength: 1 type: string lifecycleState: description: The recommendation history's current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' metadata: additionalProperties: type: string description: "Custom metadata key/value pairs for the resource action.\n\n **Metadata Example**\n\n \"metadata\" : {\n \"cpuRecommendedShape\": \"VM.Standard1.1\",\n \"computeMemoryUtilization\": \"26.05734124418388\",\n \"currentShape\": \"VM.Standard1.2\",\n \"instanceRecommendedShape\": \"VM.Standard1.1\",\n \"computeCpuUtilization\": \"7.930035319720132\",\n \"memoryRecommendedShape\": \"None\"\n }\n" type: object name: description: The name assigned to the resource. maxLength: 255 minLength: 1 type: string recommendationId: description: The unique OCID associated with the recommendation. maxLength: 255 minLength: 1 type: string recommendationName: description: The name assigned to the recommendation. maxLength: 255 minLength: 1 type: string resourceActionId: description: The unique OCID associated with the resource action. maxLength: 255 minLength: 1 type: string resourceId: description: The unique OCID associated with the resource. maxLength: 255 minLength: 1 type: string resourceType: description: The kind of resource. maxLength: 255 minLength: 1 type: string status: description: The current status of the resource action. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' timeCreated: description: The date and time the recommendation history was created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - name - resourceType - categoryId - recommendationId - recommendationName - resourceId - resourceActionId - action - compartmentId - compartmentName - lifecycleState - estimatedCostSaving - status type: object EnrollmentStatus: description: 'The metadata associated with the enrollment status. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string id: description: The OCID of the enrollment status. maxLength: 255 minLength: 1 type: string lifecycleState: description: The enrollment status' current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' status: description: The current Cloud Advisor enrollment status. enum: - ACTIVE - INACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OptimizerEnrollmentStatus' statusReason: description: The reason for the enrollment status of the tenancy. maxLength: 400 minLength: 1 type: string timeCreated: description: The date and time the enrollment status was created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeUpdated: description: The date and time the enrollment status was last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - compartmentId - lifecycleState - status type: object LevelsConfiguration: description: A list of configuration levels for each recommendation. properties: items: description: The array of configuration levels. items: $ref: '#/components/schemas/LevelConfiguration' type: array type: object SupportedLevels: description: 'Optional. The profile levels supported by a recommendation. For example, profile level values could be `Low`, `Medium`, and `High`. Not all recommendations support this field. ' properties: items: description: The list of supported levels. items: $ref: '#/components/schemas/SupportedLevel' type: array type: object QueryableFieldSummary: description: 'An individual field that can be used as part of a query filter. ' properties: fieldName: description: 'The name of the field to use when constructing the query. Field names are present for all types except `OBJECT`. ' type: string fieldType: description: 'The type of the field, which dictates the semantics and query constraints that you can use when searching or querying. ' enum: - STRING - INTEGER - BOOLEAN - DATE_TIME - OBJECT type: string objectProperties: description: 'If the field type is `OBJECT`, this property lists the individual properties of the object that can be queried. ' items: $ref: '#/components/schemas/QueryableFieldSummary' type: array required: - fieldType - fieldName type: object x-example: "[\n {\n \"fieldName\": \"name\",\n \"fieldType\": \"STRING\",\n \"objectProperties\": null\n },\n {\n \"fieldName\": \"definedTags\",\n \"fieldType\": \"OBJECT\",\n \"possibleValues\": null,\n \"objectProperties\": [\n {\n \"fieldName\": \"definedTags.key\",\n \"fieldType\": \"STRING\",\n \"objectProperties\": null\n },\n {\n \"fieldName\": \"definedTags.namespace\",\n \"fieldType\": \"STRING\",\n \"objectProperties\": null\n },\n {\n \"fieldName\": \"definedTags.value\",\n \"fieldType\": \"STRING\",\n \"objectProperties\": null\n }\n ]\n }\n]\n" CategorySummary: description: 'The metadata associated with the category summary. ' properties: compartmentId: description: The OCID of the tenancy. The tenancy is the root compartment. maxLength: 255 minLength: 1 type: string description: description: Text describing the category. maxLength: 400 minLength: 1 type: string estimatedCostSaving: description: The estimated cost savings, in dollars, for the category. If cost information is not available, the value is -1. format: double minimum: 0 type: number extendedMetadata: additionalProperties: type: string description: 'Additional metadata key/value pairs for the category summary. For example: `{"EstimatedSaving": "200"}` ' maxLength: 255 maxProperties: 25 type: object id: description: The unique OCID of the category. maxLength: 255 minLength: 1 type: string lifecycleState: description: The category's current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The name assigned to the category. maxLength: 255 minLength: 1 type: string recommendationCounts: description: An array of `RecommendationCount` objects grouped by the level of importance assigned to each recommendation. items: $ref: '#/components/schemas/RecommendationCount' type: array resourceCounts: description: An array of `ResourceCount` objects grouped by the status of each recommendation. items: $ref: '#/components/schemas/ResourceCount' type: array timeCreated: description: The date and time the category details were created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeUpdated: description: The date and time the category details were last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - compartmentId - name - description - recommendationCounts - resourceCounts - lifecycleState - estimatedCostSaving - timeCreated - timeUpdated type: object WorkRequestCollection: description: 'A list of work requests that match filter criteria, if any. Results contain `WorkRequest` objects. ' properties: items: description: A collection of work requests. items: $ref: '#/components/schemas/WorkRequest' type: array required: - items type: object ProfileCollection: description: 'A list of profiles that match filter criteria, if any. Results contain `ProfileSummary` objects. ' properties: items: description: A collection of profile summaries. items: $ref: '#/components/schemas/ProfileSummary' type: array required: - items type: object TargetCompartments: description: 'Optional. The compartments specified in the profile override for a recommendation. ' properties: items: description: The list of OCIDs attached to the compartments specified in the current profile override. items: maxLength: 255 minLength: 1 type: string type: array required: - items type: object ResourceActionSummary: description: 'The metadata associated with the resource action summary. ' properties: action: $ref: '#/components/schemas/Action' categoryId: description: The unique OCID associated with the category. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string compartmentName: description: The name associated with the compartment. maxLength: 100 minLength: 1 type: string estimatedCostSaving: description: The estimated cost savings, in dollars, for the resource action. If cost information is not available, the value is -1. format: double minimum: 0 type: number extendedMetadata: additionalProperties: type: object description: 'Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the `metadata` object. They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata` fields are string/string maps only). For example: `{"CurrentShape": {"name":"VM.Standard2.16"}, "RecommendedShape": {"name":"VM.Standard2.8"}}` ' type: object id: description: The unique OCID associated with the resource action. maxLength: 255 minLength: 1 type: string lifecycleState: description: The resource action's current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' metadata: additionalProperties: type: string description: "Custom metadata key/value pairs for the resource action.\n\n **Metadata Example**\n\n \"metadata\" : {\n \"cpuRecommendedShape\": \"VM.Standard1.1\",\n \"computeMemoryUtilization\": \"26.05734124418388\",\n \"currentShape\": \"VM.Standard1.2\",\n \"instanceRecommendedShape\": \"VM.Standard1.1\",\n \"computeCpuUtilization\": \"7.930035319720132\",\n \"memoryRecommendedShape\": \"None\"\n }\n" type: object name: description: The name assigned to the resource. maxLength: 255 minLength: 1 type: string recommendationId: description: The unique OCID associated with the recommendation. maxLength: 255 minLength: 1 type: string resourceId: description: The unique OCID associated with the resource. maxLength: 255 minLength: 1 type: string resourceType: description: The kind of resource. maxLength: 255 minLength: 1 type: string status: description: The current status of the resource action. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' timeCreated: description: The date and time the resource action details were created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeStatusBegin: description: 'The date and time that the resource action entered its current status. The format is defined by RFC3339. For example, "The status of the resource action changed from `pending` to `current(ignored)` on this date and time." ' format: date-time type: string timeStatusEnd: description: 'The date and time the current status will change. The format is defined by RFC3339. For example, "The current `postponed` status of the resource action will end and change to `pending` on this date and time." ' format: date-time type: string timeUpdated: description: The date and time the resource action details were last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - categoryId - recommendationId - resourceId - name - resourceType - compartmentId - compartmentName - action - lifecycleState - estimatedCostSaving - status - timeStatusBegin type: object TargetTags: description: 'Optional. The tags specified in the profile override for a recommendation. ' properties: items: description: The list of tags specified in the current profile override. items: $ref: '#/components/schemas/TargetTag' type: array required: - items type: object TargetTag: description: 'A tag key definition used in the current profile override, including the tag namespace, tag key, tag value type, and tag values. Only defined tags are supported. For more information about tagging, see [Tagging Overview](/iaas/Content/Tagging/Concepts/taggingoverview.htm) ' properties: tagDefinitionName: description: The name you use to refer to the tag, also known as the tag key. maxLength: 100 minLength: 1 type: string tagNamespaceName: description: The name of the tag namespace. maxLength: 100 minLength: 1 type: string tagValueType: description: 'Specifies which tag value types in the `tagValues` field result in overrides of the recommendation criteria. When the value for this field is `ANY`, the `tagValues` field should be empty, which enforces overrides to the recommendation for resources with any tag values attached to them. When the value for this field value is `VALUE`, the `tagValues` field must include a specific value or list of values. Overrides to the recommendation criteria only occur for resources that match the values in the `tagValues` fields. ' enum: - VALUE - ANY type: string x-obmcs-top-level-enum: '#/definitions/TagValueType' tagValues: description: The list of tag values. The tag value is the value that the user applying the tag adds to the tag key. items: maxLength: 256 minLength: 1 type: string type: array required: - tagNamespaceName - tagDefinitionName - tagValueType type: object Strategy: description: 'The metadata associated with the strategy. The strategy is the method used to apply the recommendation. ' properties: isDefault: description: Whether this is the default recommendation strategy. type: boolean parametersDefinition: description: The list of strategies for the parameters. items: $ref: '#/components/schemas/StrategyParameter' type: array strategyName: description: The name of the strategy. maxLength: 255 minLength: 1 type: string required: - strategyName - isDefault type: object QueryableFieldCollection: description: 'List of the fields that are indexed for querying and their associated value types. Results contain `QueryableFieldSummary` objects. ' properties: items: description: A collection of queryable field summaries. items: $ref: '#/components/schemas/QueryableFieldSummary' type: array required: - items type: object ProfileSummary: description: 'The metadata associated with the profile summary. ' properties: aggregationIntervalInDays: description: The time period over which to collect data for the recommendations, measured in number of days. maximum: 90 minimum: 1 type: integer compartmentId: description: The OCID of the tenancy. The tenancy is the root compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Text describing the profile. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair applied without any predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The unique OCID of the profile. maxLength: 255 minLength: 1 type: string levelsConfiguration: $ref: '#/components/schemas/LevelsConfiguration' lifecycleState: description: The profile's current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The name assigned to the profile. maxLength: 255 minLength: 1 type: string targetCompartments: $ref: '#/components/schemas/TargetCompartments' targetTags: $ref: '#/components/schemas/TargetTags' timeCreated: description: The date and time the profile was created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeUpdated: description: The date and time the profile was last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - compartmentId - name - description - lifecycleState - timeCreated - timeUpdated type: object BulkApplyResourceAction: description: The resource action that a recommendation will be applied to. properties: parameters: additionalProperties: type: object description: 'Additional parameter key-value pairs defining the resource action. For example: `{"timeAmount": 15, "timeUnit": "seconds"}` ' type: object resourceActionId: description: The unique OCIDs of the resource actions that recommendations are applied to. maxLength: 255 minLength: 1 type: string status: description: The current status of the recommendation. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' strategyName: description: The name of the strategy. maxLength: 255 minLength: 1 type: string timeStatusEnd: description: 'The date and time the current status will change. The format is defined by RFC3339. For example, "The current `postponed` status of the resource action will end and change to `pending` on this date and time." ' format: date-time type: string required: - resourceActionId type: object WorkRequestResource: description: Details about the resource entity. properties: actionType: description: 'The way in which this resource was affected by the work tracked by the work request. A resource being created, updated, or deleted remains in the `IN_PROGRESS` state until work is complete for that resource. At that point, the resource transitions to the `CREATED`, `UPDATED`, or `DELETED` state. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata type: string identifier: description: The resource identifier the work request affects. type: string metadata: additionalProperties: type: string description: Additional information about the resource. enum: - OPERATION_NAME type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier type: object RecommendationStrategyCollection: description: 'A list of strategies that match filter criteria, if any. Results contain `RecommendationStrategySummary` objects. ' properties: items: description: A collection of recommendation strategy summaries. items: $ref: '#/components/schemas/RecommendationStrategySummary' type: array required: - items type: object Recommendation: description: 'The metadata associated with the recommendation. ' properties: categoryId: description: The unique OCID associated with the category. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the tenancy. The tenancy is the root compartment. maxLength: 255 minLength: 1 type: string description: description: Text describing the recommendation. maxLength: 400 minLength: 1 type: string estimatedCostSaving: description: The estimated cost savings, in dollars, for the recommendation. If cost information is not available, the value is -1. format: double minimum: 0 type: number extendedMetadata: additionalProperties: type: string description: 'Additional metadata key/value pairs for the recommendation. For example: `{"EstimatedSaving": "200"}` ' maxLength: 255 maxProperties: 25 type: object id: description: The unique OCID associated with the recommendation. maxLength: 255 minLength: 1 type: string importance: description: The level of importance assigned to the recommendation. enum: - CRITICAL - HIGH - MODERATE - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/Importance' lifecycleState: description: The recommendation's current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The name assigned to the recommendation. maxLength: 255 minLength: 1 type: string resourceCounts: description: An array of `ResourceCount` objects grouped by the status of the resource actions. items: $ref: '#/components/schemas/ResourceCount' type: array status: description: The current status of the recommendation. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' supportedLevels: $ref: '#/components/schemas/SupportedLevels' timeCreated: description: The date and time the recommendation details were created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeStatusBegin: description: 'The date and time that the recommendation entered its current status. The format is defined by RFC3339. For example, "The status of the recommendation changed from `pending` to `current(ignored)` on this date and time." ' format: date-time type: string timeStatusEnd: description: 'The date and time the current status will change. The format is defined by RFC3339. For example, "The current `postponed` status of the recommendation will end and change to `pending` on this date and time." ' format: date-time type: string timeUpdated: description: The date and time the recommendation details were last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - compartmentId - categoryId - name - description - importance - resourceCounts - lifecycleState - estimatedCostSaving - status - timeStatusBegin type: object RecommendationCollection: description: 'A list of recommendations that match filter criteria, if any. Results contain `RecommendationSummary` objects. ' properties: items: description: A collection of recommendations. items: $ref: '#/components/schemas/RecommendationSummary' type: array required: - items type: object UpdateRecommendationDetails: description: The request object for updating the recommendation details. properties: status: description: The status of the recommendation. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' timeStatusEnd: description: 'The date and time the current status will change. The format is defined by RFC3339. For example, "The current `postponed` status of the recommendation will end and change to `pending` on this date and time." ' format: date-time type: string required: - status type: object CategoryCollection: description: 'A list of categories that match filter criteria, if any. Results contain `CategorySummary` objects. ' properties: items: description: A collection of category summaries. items: $ref: '#/components/schemas/CategorySummary' type: array required: - items type: object QueryDetails: description: The request object for querying the resource action details. properties: query: description: 'The query describing which resources to search for. For more information, see [Query Language Syntax](/iaas/Content/CloudAdvisor/Reference/query-syntax.htm). ' type: string type: object x-example: "{\n \"query\": \"query resourceAction where resourceType = 'compute' && name =~ 'VM instance' && ( definedTags.tagNamespace = 'categorization' && definedTags.tagKey = 'region' && definedTags.tagValue = 'phx') sorted by name desc\"\n}\n" EvaluatedMetric: description: One of the metrics that will be evaluated by profiles using this profile level. properties: name: description: The name of the metric (e.g., `CpuUtilization`). maxLength: 255 minLength: 1 type: string statistic: description: The name of the statistic (e.g., `p95`). maxLength: 255 minLength: 1 type: string target: description: Optional. The metric value that the recommendation will target. format: double type: number threshold: description: The threshold that must be crossed for the recommendation to appear. format: double type: number required: - name - statistic - threshold type: object WorkRequest: description: The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. ' type: string id: description: The OCID of the work request. type: string operationType: description: An enum-like description of the type of work the work request is doing. enum: - BULK_APPLY_RECOMMENDATIONS type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: How much progress the operation has made. format: float type: number resources: description: The resources this work request affects. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'Date and time the work was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'Date and time the work completed, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'Date and time the work started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted type: object EnrollmentStatusCollection: description: 'A list of enrollment statuses that match filter criteria, if any. Results contain `EnrollmentStatusSummary` objects. ' properties: items: description: A collection of enrollment status summaries. items: $ref: '#/components/schemas/EnrollmentStatusSummary' type: array required: - items type: object Profile: description: 'The metadata associated with the profile. ' properties: aggregationIntervalInDays: description: The time period over which to collect data for the recommendations, measured in number of days. maximum: 90 minimum: 1 type: integer compartmentId: description: The OCID of the tenancy. The tenancy is the root compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Text describing the profile. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair applied without any predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The unique OCID of the profile. maxLength: 255 minLength: 1 type: string levelsConfiguration: $ref: '#/components/schemas/LevelsConfiguration' lifecycleState: description: The profile's current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The name assigned to the profile. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string targetCompartments: $ref: '#/components/schemas/TargetCompartments' targetTags: $ref: '#/components/schemas/TargetTags' timeCreated: description: The date and time the profile was created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeUpdated: description: The date and time the profile was last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - compartmentId - name - description - lifecycleState - timeCreated - timeUpdated type: object WorkRequestErrorCollection: description: 'A list of work request errors that match filter criteria, if any. Results contain `WorkRequestError` objects. ' properties: items: description: A collection of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object ProfileLevelCollection: description: 'A list of profile levels that match the filter criteria, if any. The result contains `ProfileLevelSummary` objects. ' properties: items: description: A collection of profile levels. items: $ref: '#/components/schemas/ProfileLevelSummary' type: array required: - items type: object UpdateResourceActionDetails: description: The request object for updating the resource action details. properties: status: description: The status of the resource action. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' timeStatusEnd: description: 'The date and time the current status will change. The format is defined by RFC3339. For example, "The current `postponed` status of the resource action will end and change to `pending` on this date and time." ' format: date-time type: string required: - status type: object ProfileLevelSummary: description: 'The metadata associated with the profile level summary. ' properties: defaultInterval: description: 'The default aggregation interval (in days) for profiles using this profile level. ' minimum: 1 type: integer metrics: description: The metrics that will be evaluated by profiles using this profile level. items: $ref: '#/components/schemas/EvaluatedMetric' type: array name: description: A unique name for the profile level. maxLength: 255 minLength: 1 type: string recommendationName: description: The name of the recommendation this profile level applies to. maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the category details were created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeUpdated: description: The date and time the category details were last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string validIntervals: description: 'An array of aggregation intervals (in days) allowed for profiles using this profile level. ' items: minimum: 1 type: integer type: array uniqueItems: true required: - name - recommendationName - metrics - defaultInterval - validIntervals - timeCreated - timeUpdated type: object EnrollmentStatusSummary: description: 'The metadata associated with the enrollment status summary. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string id: description: The OCID of the enrollment status. maxLength: 255 minLength: 1 type: string lifecycleState: description: The enrollment status' current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' status: description: The current Cloud Advisor enrollment status. enum: - ACTIVE - INACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OptimizerEnrollmentStatus' statusReason: description: The reason for the enrollment status of the tenancy. maxLength: 400 minLength: 1 type: string timeCreated: description: The date and time the enrollment status was created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeUpdated: description: The date and time the enrollment status was last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - compartmentId - lifecycleState - status type: object Category: description: 'The metadata associated with the category. ' properties: compartmentId: description: The OCID of the tenancy. The tenancy is the root compartment. maxLength: 255 minLength: 1 type: string description: description: Text describing the category. maxLength: 400 minLength: 1 type: string estimatedCostSaving: description: The estimated cost savings, in dollars, for the category. If cost information is not available, the value is -1. format: double minimum: 0 type: number extendedMetadata: additionalProperties: type: string description: 'Additional metadata key/value pairs for the category. For example: `{"EstimatedSaving": "200"}` ' maxLength: 255 maxProperties: 25 type: object id: description: The unique OCID of the category. maxLength: 255 minLength: 1 type: string lifecycleState: description: The category's current state. enum: - ACTIVE - FAILED - INACTIVE - ATTACHING - DETACHING - DELETING - DELETED - UPDATING - CREATING type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The name assigned to the category. maxLength: 255 minLength: 1 type: string recommendationCounts: description: An array of `RecommendationCount` objects grouped by the level of importance assigned to the recommendation. items: $ref: '#/components/schemas/RecommendationCount' type: array resourceCounts: description: An array of `ResourceCount` objects grouped by the status of the recommendation. items: $ref: '#/components/schemas/ResourceCount' type: array timeCreated: description: The date and time the category details were created, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string timeUpdated: description: The date and time the category details were last updated, in the format defined by RFC3339. example: '2020-08-25T21:10:29.600Z' format: date-time type: string required: - id - compartmentId - name - description - recommendationCounts - resourceCounts - lifecycleState - estimatedCostSaving - timeCreated - timeUpdated type: object WorkRequestError: description: Details about errors encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occurred. ' type: string message: description: A human-readable error string. type: string timestamp: description: 'Date and time the error happened, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - code - message - timestamp type: object RecommendationCount: description: The count of recommendations in a category, grouped by importance. properties: count: description: The count of recommendations. minimum: 0 type: integer importance: description: The level of importance assigned to the recommendation. enum: - CRITICAL - HIGH - MODERATE - LOW - MINOR type: string x-obmcs-top-level-enum: '#/definitions/Importance' required: - importance - count type: object StrategyParameter: description: 'The metadata associated with the strategy parameter. ' properties: defaultValue: description: A default value used for the strategy parameter. type: object description: description: Text describing the strategy parameter. maxLength: 400 minLength: 1 type: string isRequired: description: Whether this parameter is required. type: boolean name: description: The name of the strategy parameter. maxLength: 255 minLength: 1 type: string possibleValues: description: The list of possible values used for these strategy parameters. items: type: object type: array type: description: The type of strategy parameter. enum: - STRING - BOOLEAN - NUMBER - DATETIME type: string x-obmcs-top-level-enum: '#/definitions/StrategyParameterType' required: - name - type - description - isRequired type: object Action: description: 'Details about the recommended action. ' properties: description: description: Text describing the recommended action. maxLength: 400 minLength: 1 type: string type: description: The status of the resource action. enum: - KB_ARTICLE type: string x-obmcs-top-level-enum: '#/definitions/ActionType' url: description: The URL path to documentation that explains how to perform the action. maxLength: 255 minLength: 1 type: string required: - type - description - url type: object ResourceActionCollection: description: 'A list of resource actions that match filter criteria, if any. Results contain `ResourceActionSummary` objects. ' properties: items: description: A collection of resource actions. items: $ref: '#/components/schemas/ResourceActionSummary' type: array required: - items type: object WorkRequestLogEntry: description: Details about the log entity. properties: message: description: A human-readable error string. type: string timestamp: description: 'Date and time the log was written, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - message - timestamp type: object CreateProfileDetails: description: 'Details for creating a profile. ' properties: aggregationIntervalInDays: description: The time period over which to collect data for the recommendations, measured in number of days. maximum: 90 minimum: 1 type: integer compartmentId: description: The OCID of the tenancy. The tenancy is the root compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Text describing the profile. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair applied without any predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object levelsConfiguration: $ref: '#/components/schemas/LevelsConfiguration' name: description: The name assigned to the profile. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string targetCompartments: $ref: '#/components/schemas/TargetCompartments' targetTags: $ref: '#/components/schemas/TargetTags' required: - compartmentId - name - description - levelsConfiguration type: object BulkApplyRecommendationsDetails: description: Details about bulk recommendation actions. properties: actions: description: The unique resource actions that recommendations are applied to. items: $ref: '#/components/schemas/BulkApplyResourceAction' type: array uniqueItems: true resourceActionIds: description: 'The unique OCIDs of the resource actions that recommendations are applied to. This field is deprecated. ' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true status: description: The current status of the recommendation. enum: - PENDING - DISMISSED - POSTPONED - IMPLEMENTED type: string x-obmcs-top-level-enum: '#/definitions/Status' timeStatusEnd: description: 'The date and time the current status will change. The format is defined by RFC3339. For example, "The current `postponed` status of the resource action will end and change to `pending` on this date and time." ' format: date-time type: string required: - status type: object WorkRequestLogEntryCollection: description: 'A list of work request logs that match filter criteria, if any. Results contain `WorkRequestLogEntry` objects. ' properties: items: description: A collection of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object 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 list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' 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 request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: float type: number x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are 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. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair applied without any predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }` ' type: object x-oracle-package: com.oracle.oci.optimizer