openapi: 3.2.0 info: title: Oracle Cost Ad API version: '20190111' description: 'Operations tagged costAd across 2 of this provider''s published API definitions: oci-budgets-openapi.yaml, oci-cost-anomaly-openapi.yaml. Each path carries the servers of the definition it was published in.' servers: - url: http://127.0.0.1/20190111 - url: https://127.0.0.1/20190111 tags: - name: costAd paths: /costAlertSubscriptions: get: description: 'Gets a list of Cost Alert Subscription in a compartment. ' operationId: ListCostAlertSubscriptions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/CostAlertSubscriptionLifecycleStateQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of CostAlertSubscriptionSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. 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/CostAlertSubscriptionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of Cost Alert Subscriptions tags: - costAd post: description: 'Creates a new CostAlert Subscription. ' operationId: CreateCostAlertSubscription parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The costAlertSubscription was successfully 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/CostAlertSubscription' 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 Cost Alert Subscription tags: - costAd x-example: "POST /20190111/costAlertSubscription\nHost: usage.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrvur7xq\",\n \"name\": \"Department A email list\",\n \"channels\" : {\"email\": [\"abc123@example.com\",\"example-user@domain-ex.com\"]}\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCostAlertSubscriptionDetails' description: Details for the new subscription. required: true /costAlertSubscriptions/{costAlertSubscriptionId}: delete: description: Deletes a specified CostAlertSubscription resource. operationId: DeleteCostAlertSubscription parameters: - $ref: '#/components/parameters/CostAlertSubscriptionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: CostAlertSubscription is successfully 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: Delete a CostAlertSubscription tags: - costAd x-related-resource: '#/definitions/CostAlertSubscription' get: description: Gets a CostAlertSubscription by the identifier. operationId: GetCostAlertSubscription parameters: - $ref: '#/components/parameters/CostAlertSubscriptionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the CostAlertSubscription with the given OCID. 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/CostAlertSubscription' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a CostAlertSubscription tags: - costAd put: description: Update a CostAlertSubscription identified by the OCID. operationId: UpdateCostAlertSubscription parameters: - $ref: '#/components/parameters/CostAlertSubscriptionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The CostAlertSubscription was successfully 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/CostAlertSubscription' 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 a CostAlertSubscription tags: - costAd requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCostAlertSubscriptionDetails' description: The information to be updated. required: true /costAnomalyEventAnalytics: get: description: 'Gets a list of Cost Anomaly Events analytics summary - aggregated metrics for a given time period. ' operationId: SummarizeCostAnomalyEventAnalytics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/CostMonitorIdQueryParam' - $ref: '#/components/parameters/TargetTenantIdQueryParam' - $ref: '#/components/parameters/StartDateQueryParam' - $ref: '#/components/parameters/EndDateQueryParam' - $ref: '#/components/parameters/RegionQueryParam' - $ref: '#/components/parameters/CostImpactQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of CostAnomalyEventAnalyticSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. 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/CostAnomalyEventAnalyticCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of Cost Anomaly Events analytics summary. tags: - costAd x-related-resource: '#/definitions/CostAnomalyEvent' /costAnomalyEvents: get: description: 'Gets a list of Cost Anomaly Event in a compartment. ' operationId: ListCostAnomalyEvents parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/CostMonitorIdQueryParam' - $ref: '#/components/parameters/TargetTenantIdQueryParam' - $ref: '#/components/parameters/StartDateQueryParam' - $ref: '#/components/parameters/EndDateQueryParam' - $ref: '#/components/parameters/RegionQueryParam' - $ref: '#/components/parameters/CostImpactQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of CostAnomalyEventSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. 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/CostAnomalyEventCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of Cost Anomaly Event tags: - costAd /costAnomalyEvents/{costAnomalyEventId}: get: description: Gets a CostAnomalyEvent by the identifier. operationId: GetCostAnomalyEvent parameters: - $ref: '#/components/parameters/CostAnomalyEventIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the CostAnomalyEvent with the given OCID. 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/CostAnomalyEvent' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a CostAnomalyEvent tags: - costAd put: description: Update a CostAnomalyEvent identified by the OCID. operationId: UpdateCostAnomalyEvent parameters: - $ref: '#/components/parameters/CostAnomalyEventIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The CostAnomalyEvent was successfully 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/CostAnomalyEvent' 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 a CostAnomalyEvent tags: - costAd requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCostAnomalyEventDetails' description: The information to be updated. required: true /costAnomalyMonitors: get: description: 'Gets a list of Cost Anomaly Monitors in a compartment. ' operationId: ListCostAnomalyMonitors parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/CostAnomalyMonitorLifecycleStateQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/TargetTenantIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of CostAnomalyMonitorSummary objects. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. 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/CostAnomalyMonitorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of Cost Anomaly Monitors tags: - costAd post: description: 'Creates a new costAnomaly Monitor. ' operationId: CreateCostAnomalyMonitor parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The cost anomaly monitor is successfully 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/CostAnomalyMonitor' 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 costAnomaly Monitor tags: - costAd x-example: "POST /20250520/costAnomalyMonitor\nHost: usage.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n compartmentId: \"ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrvur7xq\",\n name: \"sample cost monitor\",\n targetResourceFilter: {\n operator: \"AND\",\n filters: [\n {\n operator: \"OR\",\n dimensions: [\n {key: \"compartment\",value: \"ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrtge6tg\"},\n {key: \"compartment\",value: \"ocid1.compartment.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrtbefww\"}\n ],\n tags: [],\n filters: []\n },\n {\n operator: \"OR\",\n dimensions: [\n {key: \"service\",value: \"compute\"},\n {key: \"service\",value: \"network\"}\n ],\n tags: [],\n filters: []\n },\n {\n operator: \"OR\",\n dimensions: [],\n tags: [\n {namespace: \"Oracle-Tags\", key: \"CreatedBy\", value: \"ocid1.user.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrfffebde\"},\n {namespace: \"Oracle-Tags\", key: \"CreatedBy\", value: \"ocid1.user.oc1..aaaaaaaayzfqeibduyox6iib3olcmdar3ugly4fmameq4h7lcdlihrpounnhr\"}\n ],\n filters: []\n }\n ]\n dimensions: [],\n tags: []\n }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCostAnomalyMonitorDetails' description: Details for the new monitor. required: true /costAnomalyMonitors/{costAnomalyMonitorId}: delete: description: Deletes a specified CostAnomalyMonitor resource. operationId: DeleteCostAnomalyMonitor parameters: - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The CostAnomalyMonitor is successfully 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: Delete a CostAnomalyMonitor tags: - costAd x-related-resource: '#/definitions/CostAnomalyMonitor' get: description: Gets a CostAnomalyMonitor by the identifier. operationId: GetCostAnomalyMonitor parameters: - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the CostAnomalyMonitor with the given OCID. 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/CostAnomalyMonitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a CostAnomalyMonitor tags: - costAd put: description: Update a CostAnomalyMonitor identified by the OCID. operationId: UpdateCostAnomalyMonitor parameters: - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Cost Anomaly Monitor is successfully 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/CostAnomalyMonitor' 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 a Cost Anomaly Monitor tags: - costAd requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCostAnomalyMonitorDetails' description: The information to be updated. required: true /costAnomalyMonitors/{costAnomalyMonitorId}/actions/disable: post: description: Disables the cost anomaly monitor. This stops cost anomaly detection for targeted resource(s). operationId: DisableCostAnomalyMonitor parameters: - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The cost anomaly monitor has been disabled. 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/CostAnomalyMonitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Disables the cost anomaly monitor. tags: - costAd x-obmcs-terraform: actionType: DISABLE identifier: CostAnomalyMonitorEnableToggle x-related-resource: '#/definitions/CostAnomalyMonitor' /costAnomalyMonitors/{costAnomalyMonitorId}/actions/enable: post: description: Enables the cost anomaly monitor. This (re)starts the cost anomaly detection for targeted resource(s). operationId: EnableCostAnomalyMonitor parameters: - $ref: '#/components/parameters/CostAnomalyMonitorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The cost anomaly monitor has been enabled. 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/CostAnomalyMonitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Enables the cost anomaly monitor. tags: - costAd x-obmcs-terraform: actionType: ENABLE identifier: CostAnomalyMonitorEnableToggle x-related-resource: '#/definitions/CostAnomalyMonitor' components: schemas: CostAnomalyEventAnalyticCollection: description: Results of a CostAnomalyEventAnalytics search. properties: items: description: The list of CostAnomalyEvent Analytic summary. items: $ref: '#/components/schemas/CostAnomalyEventAnalyticSummary' type: array required: - items RootCauseDetail: description: The root cause details of the cost anomaly event. properties: value: description: The json object representing the root cause details of the anomaly event. type: object type: object Dimension: description: 'The dimension used for filtering. Available dimensions are: "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "tenantName, "tenantId", "platform", "region", "logicalAd", "resourceId". For example: `[{value: "COMPUTE", key: "service"}]` ' properties: key: description: The dimension key. maxLength: 255 minLength: 1 type: string value: description: The dimension value. maxLength: 255 minLength: 1 type: string required: - key - value type: object UpdateCostAnomalyMonitorDetails: description: Update CostAnomalyMonitor details. properties: costAlertSubscriptionMap: $ref: '#/components/schemas/CostAlertSubscriptionMap' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the cost anomaly monitor. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message CostAlertSubscriptionSummary: description: A CostAlertSubscription. properties: compartmentId: description: The OCID of the compartment which hold the cost alert subscription resource. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Cost Alert Subscription. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the cost alert subscription. type: string x-obmcs-enumref: '#/definitions/CostAlertSubscription/lifecycleState' name: description: The name of the cost alert subscription. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - id - compartmentId - name - lifecycleState CostAlertSubscription: description: A CostAlertSubscription. properties: channels: description: The notification channels string. maxLength: 1000 minLength: 1 type: string compartmentId: description: The OCID of the compartment which hold the cost alert subscription resource. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the cost alert subscription. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Cost Alert Subscription. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the cost alert subscription. enum: - ACTIVE - INACTIVE type: string name: description: The name of the cost alert subscription. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time that the cost alert subscription was created. format: date-time type: string timeUpdated: description: The time that the cost alert subscription was updated. format: date-time type: string type: description: Type of alert subscription enum: - DEFAULT - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/MonitorType' required: - id - compartmentId - name - lifecycleState - channels - timeCreated - timeUpdated CostAlertSubscriptionCollection: description: Results of a costAlertSubscription search. Contains both CostAlertSubscriptionSummary items and other data. properties: items: description: A page of CostAnomalyMonitorSummary objects. items: $ref: '#/components/schemas/CostAlertSubscriptionSummary' type: array required: - items type: object UpdateCostAnomalyEventDetails: description: 'The update CostAnomalyEvent details. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object feedbackResponse: description: The feedback response for the cost anomaly event. type: string x-obmcs-enumref: '#/definitions/CostAnomalyEvent/feedbackResponse' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object CostAnomalyEventAnalyticSummary: description: A CostAnomalyEventAnalyticSummary. properties: averageCostImpact: description: The average cost impact of the anomaly events in the given time period. format: double type: number averageCostVariance: description: The average cost variance of the anomaly events in the given time period. format: double type: number count: description: The number of cost anomaly events in the given time period. type: integer timeAnomalyEventEndDate: description: startDate for anomaly event date. format: date-time type: string timeAnomalyEventStartDate: description: startDate for anomaly event date. format: date-time type: string required: - timeAnomalyEventStartDate - timeAnomalyEventEndDate - count - averageCostImpact - averageCostVariance CostAnomalyEventCollection: description: Results of a costAnomalyEvent search. Contains both CostAnomalyEventSummary items and other data. properties: items: description: A page of CostAnomalyMonitorSummary objects. items: $ref: '#/components/schemas/CostAnomalyEventSummary' type: array required: - items type: object CostAnomalyEvent: description: A CostAnomalyEvent. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string costImpact: description: The cost impact of the detected anomaly. format: double type: number costMonitorId: description: The OCID of the associated cost monitor. maxLength: 255 minLength: 1 type: string costMonitorName: description: The name of the associated cost monitor. maxLength: 255 minLength: 1 type: string costVariancePercentage: description: The cost variance percentage of the detected anomaly. format: double type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object feedbackResponse: description: The feedback response for the cost anomaly event. enum: - ACCURATE_ANOMALY - EXPECTED_ANOMALY - NOT_AN_ANOMALY type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Cost Anomaly Event. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the cost anomaly event. enum: - ACTIVE - INACTIVE type: string rootCauseDetail: $ref: '#/components/schemas/RootCauseDetail' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetResourceFilter: $ref: '#/components/schemas/TargetResourceFilter' timeAnomalyEventDate: description: The event date of the anomaly event. format: date-time type: string timeCreated: description: The created time of the cost anomaly event. format: date-time type: string timeUpdated: description: The updated time of the cost anomaly event. format: date-time type: string required: - id - compartmentId - costMonitorId - lifecycleState - costMonitorName - targetResourceFilter - timeAnomalyEventDate - timeCreated - timeUpdated UpdateCostAlertSubscriptionDetails: description: 'The update CostAlertSubscriptionDetails details. ' properties: channels: description: The notification channels string. maxLength: 1000 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the cost alert subscription. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object Tag: description: The tag used for filtering. properties: key: description: The tag key. maxLength: 255 minLength: 1 type: string namespace: description: The tag namespace. maxLength: 255 minLength: 1 type: string value: description: The tag value. maxLength: 100 minLength: 1 type: string type: object CreateCostAlertSubscriptionDetails: description: 'The create CostAlertSubscriptionDetails details. The clients should pass compartmentId where the resource should belong, description and channels. ' properties: channels: description: The notification channels string. maxLength: 1000 minLength: 1 type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the cost alert subscription. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Cost Anomaly Subscription. maxLength: 255 minLength: 1 type: string name: description: The name of the cost alert subscription. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string type: description: Type of alert subscription enum: - DEFAULT - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/MonitorType' required: - compartmentId - name - type - channels TargetResourceFilter: description: "The filter object to target resources for cost monitor. \nCost generated by one or more resources identified by this \nfilter is monitored for anomalous deviations.\n" properties: dimensions: description: The dimensions to filter on. items: $ref: '#/components/schemas/Dimension' maxItems: 100 type: array filters: description: The nested filter object. items: $ref: '#/components/schemas/TargetResourceFilter' maxItems: 100 type: array operator: description: 'The filter operator. Example: ''AND'', ''OR'', ''NOT''.' enum: - AND - NOT - OR type: string tags: description: The tags to filter on. items: $ref: '#/components/schemas/Tag' maxItems: 100 type: array type: object CostAnomalyMonitor: description: A CostAnomalyMonitor. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string costAlertSubscriptionMap: $ref: '#/components/schemas/CostAlertSubscriptionMap' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the budget. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Cost Anomaly Monitor. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'The current state details of the cost monitor. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the cost monitor. enum: - ACTIVE - INACTIVE - DELETED type: string name: description: The name of the cost anomaly monitor. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetResourceFilter: $ref: '#/components/schemas/TargetResourceFilter' timeCreated: description: The time that the cost monitor was created. format: date-time type: string timeUpdated: description: The time that the cost monitor was last updated. format: date-time type: string type: description: Type of cost monitor enum: - DEFAULT - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/MonitorType' required: - id - compartmentId - name - lifecycleState - targetResourceFilter - timeCreated - timeUpdated CostAnomalyEventSummary: description: A CostAnomalyEvent. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string costImpact: description: The cost impact of the detected anomaly. format: double type: number costMonitorId: description: The OCID of the associated cost monitor. maxLength: 255 minLength: 1 type: string costMonitorName: description: The name of the associated cost monitor. maxLength: 255 minLength: 1 type: string costVariancePercentage: description: The cost variance percentage of the detected anomaly. format: double type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Cost Anomaly Event. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the cost anomaly event. type: string x-obmcs-enumref: '#/definitions/CostAnomalyEvent/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetResourceFilter: $ref: '#/components/schemas/TargetResourceFilter' timeAnomalyEventDate: description: The event date of the anomaly event. format: date-time type: string required: - id - compartmentId - costMonitorId - costMonitorName - targetResourceFilter - timeAnomalyEventDate CostAnomalyMonitorCollection: description: Results of a costAnomalyMonitor search. Contains both CostAnomalyMonitorSummary items and other data. properties: items: description: A page of CostAnomalyMonitorSummary objects. items: $ref: '#/components/schemas/CostAnomalyMonitorSummary' type: array required: - items type: object CreateCostAnomalyMonitorDetails: description: 'The create CostAnomalyMonitor details. The clients should pass ocid of the compartmentId for the monitor resource to be created. tenantIdFilter and resourceFilter targets resources to monitor in a given tenancy. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string costAlertSubscriptionMap: $ref: '#/components/schemas/CostAlertSubscriptionMap' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the cost anomaly monitor. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: The name of the cost anomaly monitor. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string targetResourceFilter: $ref: '#/components/schemas/TargetResourceFilter' required: - compartmentId - name - targetResourceFilter CostAlertSubscriptionMap: description: The mapping of cost monitor to alert subscription along with thresholds. properties: costAlertSubscriptionId: description: The costAlertSubscription ocid which the cost monitor alert maps to. type: string operator: description: 'The filter operator. Example: ''AND'', ''OR'', ''NOT''.' enum: - AND - NOT - OR type: string thresholdAbsoluteValue: description: The absolute threshold value. minimum: 0 type: integer thresholdRelativePercent: description: The relative percentage threshold value. minimum: 0 type: integer type: object CostAnomalyMonitorSummary: description: A CostAnomalyMonitor. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' 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: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the budget. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the Cost Anomaly Monitor. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the cost monitor. type: string x-obmcs-enumref: '#/definitions/CostAnomalyMonitor/lifecycleState' name: description: The name of the cost anomaly monitor. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetResourceFilter: $ref: '#/components/schemas/TargetResourceFilter' timeCreated: description: The time that the cost monitor was created. format: date-time type: string timeUpdated: description: The time that the cost monitor was last updated. format: date-time type: string type: description: Type of cost monitor enum: - DEFAULT - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/MonitorType' required: - id - compartmentId - name - lifecycleState - targetResourceFilter - timeCreated - timeUpdated parameters: NameQueryParam: description: 'Unique, non-changeable resource name. ' in: query name: name x-default-description: '' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page x-default-description: '' schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName default: timeCreated EndDateQueryParam: description: endDate for anomaly event date. in: query name: timeAnomalyEventEndDate required: true x-default-description: '' schema: type: string format: date-time IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string CostAlertSubscriptionLifecycleStateQueryParam: description: The current state of the cost alert subscription. in: query name: lifecycleState x-obmcs-enumref: '#/definitions/CostAlertSubscription/lifecycleState' schema: type: string RegionQueryParam: description: region of the anomaly event. in: query name: region required: true x-default-description: '' schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 25 maximum: 1000 minimum: 1 CostAnomalyMonitorLifecycleStateQueryParam: description: The current state of the cost monitor. in: query name: lifecycleState x-obmcs-enumref: '#/definitions/CostAnomalyMonitor/lifecycleState' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-default-description: '' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC CostAnomalyMonitorIdPathParam: description: The unique costAnomalyMonitor OCID. in: path name: costAnomalyMonitorId required: true x-default-description: '' schema: type: string maxLength: 255 minLength: 1 TargetTenantIdQueryParam: description: The target tenantId ocid filter param. in: query name: targetTenantId x-default-description: '' schema: type: string maxLength: 255 minLength: 1 CostMonitorIdQueryParam: description: The cost monitor ocid. in: query name: costAnomalyMonitorId required: true x-default-description: '' schema: type: string maxLength: 255 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 CostAlertSubscriptionIdPathParam: description: The unique costAlertSubscription OCID. in: path name: costAlertSubscriptionId required: true x-default-description: '' schema: type: string maxLength: 255 minLength: 1 CostImpactQueryParam: description: cost impact of the anomaly event. in: query name: costImpact required: true x-default-description: '' schema: type: number format: double RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string StartDateQueryParam: description: startDate for anomaly event date. in: query name: timeAnomalyEventStartDate required: true x-default-description: '' schema: type: string format: date-time CostAnomalyEventIdPathParam: description: The unique costAnomalyEventId OCID. in: path name: costAnomalyEventId required: true x-default-description: '' schema: type: string maxLength: 255 minLength: 1 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-refined-from: - oci-budgets-openapi.yaml - oci-cost-anomaly-openapi.yaml 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-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. type: integer 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. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, 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-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.idm.agcs.cp