openapi: 3.2.0 info: description: 'Analytics API. ' license: name: Oracle Corporation title: Analytics API version: '20190331' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/9bcc53a4edfb39ed432d422fd992444b637d99197bac3f5aedeb0d97eb42188a.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Analytics 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/9bcc53a4edfb39ed432d422fd992444b637d99197bac3f5aedeb0d97eb42188a.yaml what: the harvested document for Analytics API servers: - url: /20190331 tags: - name: analytics paths: /analyticsInstances: get: description: 'List Analytics instances. ' operationId: ListAnalyticsInstances parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ResourceNameQueryParam' - $ref: '#/components/parameters/CapacityTypeQueryParam' - $ref: '#/components/parameters/FeatureSetQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: 'List of Analytics instances (paginated, see page and limit query parameters). ' 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 maxLength: 1024 minLength: 1 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: items: $ref: '#/components/schemas/AnalyticsInstanceSummary' type: array 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/DefaultError' summary: List Analytics instances. tags: - analytics post: description: 'Create a new AnalyticsInstance in the specified compartment. The operation is long-running and creates a new WorkRequest. ' operationId: CreateAnalyticsInstance parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 201: description: 'The Analytics instance was created. A background task is configuring various dependencies before the instance becomes fully operational. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' 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 opc-work-request-id: description: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AnalyticsInstance' 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/DefaultError' summary: Create an Analytics instance. tags: - analytics requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAnalyticsInstanceDetails' description: 'Analytics Instance details. ' required: true /analyticsInstances/{analyticsInstanceId}: delete: description: 'Terminates the specified Analytics instance. The operation is long-running and creates a new WorkRequest. ' operationId: DeleteAnalyticsInstance parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: 'The Analytics instance is being terminated. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Delete an Analytics instance. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' get: description: 'Info for a specific Analytics instance. ' operationId: GetAnalyticsInstance parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Expected response for a valid request. ' 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/AnalyticsInstance' 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/DefaultError' summary: Retrieve Analytics instance metadata. tags: - analytics put: description: 'Updates certain fields of an Analytics instance. Fields that are not provided in the request will not be updated. ' operationId: UpdateAnalyticsInstance parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The Analytics instance 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/AnalyticsInstance' 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/DefaultError' summary: Update an Analytics instance. tags: - analytics x-obmcs-client-retries-enabled: false requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAnalyticsInstanceDetails' description: 'The Analytics Instance fields to update. Fields that are not provided will not be updated. ' required: true /analyticsInstances/{analyticsInstanceId}/actions/changeCompartment: post: description: 'Change the compartment of an Analytics instance. The operation is long-running and creates a new WorkRequest. ' operationId: ChangeAnalyticsInstanceCompartment parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request to move compartments was accepted. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Change the compartment of an Analytics instance. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: 'Input payload to move the resource to a different compartment. ' required: true /analyticsInstances/{analyticsInstanceId}/actions/changeNetworkEndpoint: post: description: 'Change an Analytics instance network endpoint. The operation is long-running and creates a new WorkRequest. ' operationId: ChangeAnalyticsInstanceNetworkEndpoint parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and the Analytics instance network endpoint will be updated. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Change an Analytics instance network endpoint. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAnalyticsInstanceNetworkEndpointDetails' description: 'Input payload for changing an Analytics instance network endpoint. ' required: true /analyticsInstances/{analyticsInstanceId}/actions/scale: post: description: 'Scale an Analytics instance up or down. The operation is long-running and creates a new WorkRequest. ' operationId: ScaleAnalyticsInstance parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and the Analytics instance will be scaled up or down. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Scale an Analytics instance up or down. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScaleAnalyticsInstanceDetails' description: 'Input payload for scaling an Analytics instance up or down. ' required: true /analyticsInstances/{analyticsInstanceId}/actions/setFeatureBundle: post: description: 'Set the external service properties of an Analytics instance. ' operationId: SetFeatureBundle parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and the Analytics instance feature bundle will be set. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Set the feature bundle of an Analytics instance. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/SetFeatureBundleDetails' description: 'Input payload for the feature set of an Analytics instance. ' required: true /analyticsInstances/{analyticsInstanceId}/actions/setKmsKey: post: description: 'Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key. ' operationId: SetKmsKey parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and re-encryption of the customer data will begin. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Encrypts customer data with an OCI Vault key or reverts back to Oracle managed key. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/SetKmsKeyDetails' description: 'Input payload to reset the OCI Vault encryption key. ' required: true /analyticsInstances/{analyticsInstanceId}/actions/start: post: description: 'Starts the specified Analytics instance. The operation is long-running and creates a new WorkRequest. ' operationId: StartAnalyticsInstance parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and the Analytics instance will be started. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Starts the specified Analytics instance. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' /analyticsInstances/{analyticsInstanceId}/actions/stop: post: description: 'Stop the specified Analytics instance. The operation is long-running and creates a new WorkRequest. ' operationId: StopAnalyticsInstance parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and the Analytics instance will be stopped. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Stop the specified Analytics instance. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' /analyticsInstances/{analyticsInstanceId}/privateAccessChannels: post: description: 'Create an Private access Channel for the Analytics instance. The operation is long-running and creates a new WorkRequest. ' operationId: CreatePrivateAccessChannel parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and the private access channel for the Analytics instance will be created. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Create a Private access Channel for the Analytics instance. tags: - analytics x-example: "POST /20190331/analyticsInstances/<analytics_instance_OCID>/privateAccessChannels\nHost: analytics.<region>.ocp.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"example_private_access_channel\",\n \"vcnId\": \"ocid1.vcn.<unique_part_vcn_id>\",\n \"subnetId\": \"ocid1.subnet.<unique_part_subnet_id>\",\n \"privateSourceDnsZones\" : [\n { \"dnsZone\" : \"example-vcn.oraclevcn.com\", \"description\" : \"Example OCI VCN DNS label\" },\n { \"dnsZone\" : \"example.com\", \"description\" : \"Example DNS Zone / Domain for On-Premise\" }\n ]\n}\n" x-related-resource: '#/definitions/AnalyticsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePrivateAccessChannelDetails' description: 'Input payload for creating a private access channel for an Analytics instance. ' required: true /analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}: delete: description: 'Delete an Analytics instance''s Private access channel with the given unique identifier key. ' operationId: DeletePrivateAccessChannel parameters: - $ref: '#/components/parameters/PrivateAccessChannelKeyPathParam' - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: 'The Analytics instance''s Private Access Channel is being terminated. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Delete an Analytics instance's Private access channel with the given unique identifier key. tags: - analytics x-example: 'DELETE /20190331/analyticsInstances/<analytics_instance_OCID>/privateAccessChannels/<private_access_channel_Key> Host: analytics.<region>.ocp.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/AnalyticsInstance' get: description: 'Retrieve private access channel in the specified Analytics Instance. ' operationId: GetPrivateAccessChannel parameters: - $ref: '#/components/parameters/PrivateAccessChannelKeyPathParam' - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Returns Private Access Channel with the given name. ' 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/PrivateAccessChannel' 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/DefaultError' summary: Retrieve private access channel in the specified Analytics Instance. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' put: description: 'Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance. ' operationId: UpdatePrivateAccessChannel parameters: - $ref: '#/components/parameters/PrivateAccessChannelKeyPathParam' - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and the Analytics instance private access channel will be updated. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Update the Private Access Channel. tags: - analytics x-example: "PUT /20190331/analyticsInstances/<analytics_instance_OCID>/privateAccessChannels/<private_access_channel_Key>\nHost: analytics.<region>.ocp.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"example_private_access_channel\",\n \"vcnId\": \"ocid1.vcn.<unique_part_vcn_id>\",\n \"subnetId\": \"ocid1.subnet.<unique_part_subnet_id>\",\n \"privateSourceDnsZones\" : [\n { \"dnsZone\" : \"example-vcn.oraclevcn.com\", \"description\" : \"Example OCI VCN DNS label\" },\n { \"dnsZone\" : \"example.com\", \"description\" : \"Example DNS Zone / Domain for On-Premise\" }\n ]\n}\n" x-related-resource: '#/definitions/AnalyticsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePrivateAccessChannelDetails' description: 'Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance. ' required: true /analyticsInstances/{analyticsInstanceId}/vanityUrls: post: description: 'Allows specifying a custom host name to be used to access the analytics instance. This requires prior setup of DNS entry and certificate for this host. ' operationId: CreateVanityUrl parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and creation of the vanity url will begin. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Create a vanity URL for the Analytics Instance. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVanityUrlDetails' description: 'Vanity url details. ' required: true /analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}: delete: description: 'Allows deleting a previously created vanity url. ' operationId: DeleteVanityUrl parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/VanityUrlKeyPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and deletion of the vanity url will begin. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Delete a vanity URL for the Analytics Instance. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' put: description: 'Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring. ' operationId: UpdateVanityUrl parameters: - $ref: '#/components/parameters/AnalyticsInstanceIdPathParam' - $ref: '#/components/parameters/VanityUrlKeyPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'The request was accepted and update of the vanity url will begin. ' 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: 'The OCID of the work request. Use [GetWorkRequest](#/en/iaas/20160918/WorkRequests/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 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/DefaultError' summary: Upload a new certificate for a vanity url. tags: - analytics x-related-resource: '#/definitions/AnalyticsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVanityUrlDetails' description: 'Vanity url details to update (certificate). ' required: true /workRequests: get: description: 'List all work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestResourceIdQueryParam' - $ref: '#/components/parameters/WorkRequestResourceTypeQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: 'The list of work request summary 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 maxLength: 1024 minLength: 1 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: items: $ref: '#/components/schemas/WorkRequestSummary' type: array 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/DefaultError' summary: List all work requests. tags: - analytics /workRequests/{workRequestId}: delete: description: 'Cancel a work request that has not started yet. ' operationId: DeleteWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The work request was cancelled. 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Cancel a work request. tags: - analytics x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/WorkRequest' get: description: 'Get the details of a work request. ' operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: 'Retrieve a work request resource. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: 'The number of seconds a client should wait before polling this endpoint again. ' schema: type: integer 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/DefaultError' summary: Get work request details. tags: - analytics /workRequests/{workRequestId}/errors: get: description: 'Get the errors of a work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: 'The list of errors for the work request. ' 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 maxLength: 1024 minLength: 1 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: items: $ref: '#/components/schemas/WorkRequestError' type: array 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/DefaultError' summary: Get work request errors. tags: - analytics /workRequests/{workRequestId}/logs: get: description: 'Get the logs of a work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list of logs for the work request. 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 maxLength: 1024 minLength: 1 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: items: $ref: '#/components/schemas/WorkRequestLog' type: array 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/DefaultError' summary: Get work request logs. tags: - analytics components: schemas: Capacity: description: 'Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...). ' properties: capacityType: description: 'The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT ' enum: - OLPU_COUNT - USER_COUNT type: string x-obmcs-top-level-enum: '#/definitions/CapacityType' capacityValue: description: 'The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance. ' minimum: 1 type: integer required: - capacityType - capacityValue type: object NetworkEndpointDetails: description: 'Base representation of a network endpoint. ' discriminator: propertyName: networkEndpointType properties: networkEndpointType: description: 'The type of network endpoint. ' enum: - PUBLIC - PRIVATE type: string x-obmcs-top-level-enum: '#/definitions/NetworkEndpointType' required: - networkEndpointType type: object 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 UpdateAnalyticsInstanceDetails: description: 'Input payload to update an Analytics instance. Fields that are not provided will not be updated. ' 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 description: description: 'Optional description. ' maxLength: 512 minLength: 0 type: string emailNotification: description: 'Email address receiving notifications. ' maxLength: 512 minLength: 0 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 licenseType: description: 'The license used for the service. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string x-obmcs-top-level-enum: '#/definitions/LicenseType' updateChannel: description: 'Analytics instance update channel. ' enum: - REGULAR - EARLY - PHASE_2 - PHASE_1 type: string x-obmcs-top-level-enum: '#/definitions/UpdateChannel' CreateAnalyticsInstanceDetails: description: 'Input payload to create an Anaytics instance. ' properties: adminUser: description: 'user name of the authorized user. ' maxLength: 255 type: string capacity: $ref: '#/components/schemas/Capacity' 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: 'Optional description. ' maxLength: 512 minLength: 0 type: string domainId: description: 'domain id for which the user is authorized. ' maxLength: 255 type: string emailNotification: description: 'Email address receiving notifications. ' maxLength: 512 minLength: 0 type: string featureBundle: description: 'The feature set of an Analytics instance. ' enum: - FAW_PAID - FAW_FREE - EE_EMBEDDED - SE_EMBEDDED type: string x-obmcs-top-level-enum: '#/definitions/FeatureBundle' featureSet: description: 'Analytics feature set. ' enum: - SELF_SERVICE_ANALYTICS - ENTERPRISE_ANALYTICS type: string x-obmcs-top-level-enum: '#/definitions/FeatureSet' 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 idcsAccessToken: description: 'IDCS access token identifying a stripe and service administrator user. ' maxLength: 8192 type: string kmsKeyId: description: 'OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption. ' maxLength: 255 minLength: 0 type: string licenseType: description: 'The license used for the service. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string x-obmcs-top-level-enum: '#/definitions/LicenseType' name: description: 'The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed. ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z](-?[a-zA-Z0-9])*$ type: string networkEndpointDetails: $ref: '#/components/schemas/NetworkEndpointDetails' updateChannel: description: 'Analytics instance update channel. ' enum: - REGULAR - EARLY - PHASE_2 - PHASE_1 type: string x-obmcs-top-level-enum: '#/definitions/UpdateChannel' required: - name - compartmentId - capacity - featureSet - licenseType PrivateAccessChannel: description: 'Analytics Instance Private Access Channel model. ' properties: displayName: description: 'Display Name of the Private Access Channel. ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$ type: string egressSourceIpAddresses: description: 'The list of IP addresses from the customer subnet connected to private access channel, used as a source Ip by Private Access Channel for network traffic from the AnalyticsInstance to Private Sources. ' items: maxLength: 46 minLength: 8 type: string type: array ipAddress: description: 'IP Address of the Private Access channel. ' maxLength: 255 minLength: 1 type: string key: description: 'Private Access Channel unique identifier key. ' maxLength: 255 minLength: 1 type: string networkSecurityGroupIds: description: 'Network Security Group OCIDs for an Analytics instance. ' items: maxLength: 255 minLength: 1 type: string maxLength: 5 type: array privateSourceDnsZones: description: 'List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered. ' items: $ref: '#/components/schemas/PrivateSourceDnsZone' maxLength: 30 minLength: 1 type: array privateSourceScanHosts: description: 'List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance. ' items: $ref: '#/components/schemas/PrivateSourceScanHost' maxLength: 15 type: array subnetId: description: 'OCID of the customer subnet connected to private access channel. ' maxLength: 255 minLength: 1 type: string vcnId: description: 'OCID of the customer VCN peered with private access channel. ' maxLength: 255 minLength: 1 type: string required: - key - displayName - vcnId - subnetId - ipAddress - egressSourceIpAddresses ChangeCompartmentDetails: description: 'Input payload to change a resource''s compartment. ' properties: compartmentId: description: 'The OCID of the new compartment. ' maxLength: 255 minLength: 1 type: string required: - compartmentId CreateVanityUrlDetails: description: 'Input payload to create a vanity url. ' properties: caCertificate: description: 'PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates. ' minLength: 1 type: string description: description: 'Optional description. ' maxLength: 512 minLength: 0 type: string hosts: description: 'List of fully qualified hostnames supported by this vanity URL definition (max of 3). ' items: maxLength: 255 minLength: 1 type: string maxItems: 3 minItems: 1 type: array passphrase: description: 'Passphrase for the PEM Private key (if any). ' type: string privateKey: description: 'PEM Private key for HTTPS connections. ' minLength: 1 type: string publicCertificate: description: 'PEM certificate for HTTPS connections. ' minLength: 1 type: string required: - hosts - caCertificate - privateKey - publicCertificate SetKmsKeyDetails: description: 'Input payload to reset the OCI Vault encryption key. ' properties: kmsKeyId: description: 'OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. An empty value indicates Oracle managed default encryption (null is not supported in this API). ' maxLength: 255 minLength: 0 type: string required: - kmsKeyId SetFeatureBundleDetails: description: 'Input payload for the feature set of an Analytics instance. ' properties: featureBundle: description: 'The feature set of an Analytics instance. ' enum: - FAW_PAID - FAW_FREE - EE_EMBEDDED - SE_EMBEDDED type: string x-obmcs-top-level-enum: '#/definitions/FeatureBundle' PrivateSourceDnsZone: description: 'Private source DNS Zone model. ' properties: description: description: 'Description of private source dns zone. ' maxLength: 255 minLength: 0 type: string dnsZone: description: 'Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com. ' maxLength: 253 minLength: 1 type: string required: - dnsZone CreatePrivateAccessChannelDetails: description: 'Input payload to create a Private Access Channel. ' properties: displayName: description: 'Display Name of the Private Access Channel. ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$ type: string networkSecurityGroupIds: description: 'Network Security Group OCIDs for an Analytics instance. ' items: maxLength: 255 minLength: 1 type: string maxLength: 5 type: array privateSourceDnsZones: description: 'List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered. ' items: $ref: '#/components/schemas/PrivateSourceDnsZone' maxLength: 30 minLength: 1 type: array privateSourceScanHosts: description: 'List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance. ' items: $ref: '#/components/schemas/PrivateSourceScanHost' maxLength: 15 type: array subnetId: description: 'OCID of the customer subnet connected to private access channel. ' maxLength: 255 minLength: 1 type: string vcnId: description: 'OCID of the customer VCN peered with private access channel. ' maxLength: 255 minLength: 1 type: string required: - displayName - vcnId - subnetId - privateSourceDnsZones type: object WorkRequestResource: properties: actionResult: description: 'The way in which this resource was affected by this work request. ' enum: - COMPARTMENT_CHANGED - CREATED - DELETED - STARTED - STOPPED - SCALED - NETWORK_ENDPOINT_CHANGED - VANITY_URL_CREATED - VANITY_URL_UPDATED - VANITY_URL_DELETED - PRIVATE_ACCESS_CHANNEL_CREATED - PRIVATE_ACCESS_CHANNEL_UPDATED - PRIVATE_ACCESS_CHANNEL_DELETED - NONE type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestActionResult' identifier: description: The OCID of the resource the work request is affecting. maxLength: 255 minLength: 1 type: string metadata: additionalProperties: type: string description: 'Additional metadata of the resource. ' type: object resourceType: description: 'The type of the resource the work request is affecting. ' enum: - ANALYTICS_INSTANCE type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceType' resourceUri: description: 'The URI of the affected resource. ' type: string required: - actionResult - resourceType - identifier - resourceUri VanityUrlDetails: description: 'Vanity url configuration details. ' properties: description: description: 'Description of the vanity url. ' maxLength: 512 minLength: 1 type: string hosts: description: 'List of fully qualified hostnames supported by this vanity URL definition (max of 3). ' items: maxLength: 255 minLength: 1 type: string maxItems: 3 minItems: 1 type: array key: description: 'The vanity url unique identifier key. ' maxLength: 255 minLength: 1 type: string publicCertificate: description: 'PEM certificate for HTTPS connections. ' minLength: 1 type: string urls: description: 'List of urls supported by this vanity URL definition (max of 3). ' items: maxLength: 255 minLength: 1 type: string maxItems: 3 minItems: 1 type: array type: object UpdatePrivateAccessChannelDetails: description: 'Input payload to update a Private Access Channel. ' properties: displayName: description: 'Display Name of the Private Access Channel. ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$ type: string networkSecurityGroupIds: description: 'Network Security Group OCIDs for an Analytics instance. ' items: maxLength: 255 minLength: 1 type: string maxLength: 5 type: array privateSourceDnsZones: description: 'List of Private Source DNS zones registered with Private Access Channel, where datasource hostnames from these dns zones / domains will be resolved in the peered VCN for access from Analytics Instance. Min of 1 is required and Max of 30 Private Source DNS zones can be registered. ' items: $ref: '#/components/schemas/PrivateSourceDnsZone' maxLength: 30 minLength: 1 type: array privateSourceScanHosts: description: 'List of Private Source DB SCAN hosts registered with Private Access Channel for access from Analytics Instance. ' items: $ref: '#/components/schemas/PrivateSourceScanHost' maxLength: 15 type: array subnetId: description: 'OCID of the customer subnet connected to private access channel. ' maxLength: 255 minLength: 1 type: string vcnId: description: 'OCID of the customer VCN peered with private access channel. ' maxLength: 255 minLength: 1 type: string type: object WorkRequest: description: 'An asynchronous work request. ' properties: compartmentId: description: 'The compartment OCID of this work request. ' maxLength: 255 minLength: 1 type: string id: description: 'The resource OCID. ' maxLength: 255 minLength: 1 type: string operationType: description: 'The operation performed by the work request. ' enum: - CREATE_ANALYTICS_INSTANCE - DELETE_ANALYTICS_INSTANCE - START_ANALYTICS_INSTANCE - STOP_ANALYTICS_INSTANCE - SCALE_ANALYTICS_INSTANCE - CHANGE_ANALYTICS_INSTANCE_COMPARTMENT - CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT - CREATE_VANITY_URL - UPDATE_VANITY_URL - DELETE_VANITY_URL - CREATE_PRIVATE_ACCESS_CHANNEL - UPDATE_PRIVATE_ACCESS_CHANNEL - DELETE_PRIVATE_ACCESS_CHANNEL - UPDATE_INSTANCE_ENCRYPTION_KEY type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' percentComplete: description: 'Percentage of the request completed. ' 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/WorkRequestStatus' timeAccepted: description: 'The time the work request was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The time the work request was finished, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'The time the work request was started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - operationType - status - compartmentId - resources - percentComplete - timeAccepted type: object WorkRequestLog: description: 'Log entries related to a specific work request. ' properties: message: description: 'The description of the event that occurred. ' type: string timestamp: description: 'The date and time the log entry occured, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - message - timestamp type: object ScaleAnalyticsInstanceDetails: description: 'Input payload to scale an Analytics instance up or down. ' properties: capacity: $ref: '#/components/schemas/Capacity' required: - capacity UpdateVanityUrlDetails: description: 'Input payload to update a vanity url. ' properties: caCertificate: description: 'PEM CA certificate(s) for HTTPS connections. This may include multiple PEM certificates. ' minLength: 1 type: string passphrase: description: 'Passphrase for the PEM Private key (if any). ' type: string privateKey: description: 'PEM Private key for HTTPS connections. ' minLength: 1 type: string publicCertificate: description: 'PEM certificate for HTTPS connections. ' minLength: 1 type: string required: - caCertificate - privateKey - publicCertificate PrivateSourceScanHost: description: 'Private source Scan Hostname model. ' properties: description: description: 'Description of private source scan host zone. ' maxLength: 255 minLength: 1 type: string scanHostname: description: 'Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com. ' maxLength: 255 minLength: 1 type: string scanPort: description: 'Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521). ' minimum: 1 type: integer required: - scanHostname - scanPort AnalyticsInstance: description: 'Analytics Instance metadata. ' properties: capacity: $ref: '#/components/schemas/Capacity' 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: 'Optional description. ' maxLength: 512 minLength: 0 type: string domainId: description: 'Identity domain OCID. ' type: string emailNotification: description: 'Email address receiving notifications. ' maxLength: 512 minLength: 0 type: string featureBundle: description: 'The feature set of an Analytics instance. ' enum: - FAW_PAID - FAW_FREE - EE_EMBEDDED - SE_EMBEDDED type: string x-obmcs-top-level-enum: '#/definitions/FeatureBundle' featureSet: description: 'Analytics feature set. ' enum: - SELF_SERVICE_ANALYTICS - ENTERPRISE_ANALYTICS type: string x-obmcs-top-level-enum: '#/definitions/FeatureSet' 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 resource OCID. ' maxLength: 255 minLength: 1 type: string kmsKeyId: description: 'OCID of the OCI Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption. ' maxLength: 255 minLength: 0 type: string licenseType: description: 'The license used for the service. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string x-obmcs-top-level-enum: '#/definitions/LicenseType' lifecycleState: description: 'The current state of an instance. ' enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - INACTIVE - UPDATING type: string x-obmcs-top-level-enum: '#/definitions/AnalyticsInstanceLifecycleState' name: description: 'The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed. ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z](-?[a-zA-Z0-9])*$ type: string networkEndpointDetails: $ref: '#/components/schemas/NetworkEndpointDetails' privateAccessChannels: additionalProperties: $ref: '#/components/schemas/PrivateAccessChannel' description: 'Map of PrivateAccessChannel unique identifier key as KEY and PrivateAccessChannel Object as VALUE. ' type: object serviceUrl: description: 'URL of the Analytics service. ' maxLength: 1024 minLength: 0 type: string 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: `{"key": "value"}` ' type: object description: 'System tags for this resource. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"key": "value"}}` ' type: object timeCreated: description: 'The date and time the instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it. ' format: date-time type: string updateChannel: description: 'Analytics instance update channel. ' enum: - REGULAR - EARLY - PHASE_2 - PHASE_1 type: string x-obmcs-top-level-enum: '#/definitions/UpdateChannel' vanityUrlDetails: additionalProperties: $ref: '#/components/schemas/VanityUrlDetails' description: 'Map of VanityUrl unique identifier key as KEY and VanityUrl Object as VALUE. ' type: object required: - id - name - compartmentId - lifecycleState - capacity - networkEndpointDetails - featureSet - timeCreated ChangeAnalyticsInstanceNetworkEndpointDetails: description: 'Input payload to update an Analytics instance endpoint details. ' properties: networkEndpointDetails: $ref: '#/components/schemas/NetworkEndpointDetails' required: - networkEndpointDetails WorkRequestSummary: description: An asynchronous work request. properties: compartmentId: description: 'The compartment OCID of this work request. ' maxLength: 255 minLength: 1 type: string id: description: 'The resource OCID. ' maxLength: 255 minLength: 1 type: string operationType: description: 'The operation performed by the work request. ' enum: - CREATE_ANALYTICS_INSTANCE - DELETE_ANALYTICS_INSTANCE - START_ANALYTICS_INSTANCE - STOP_ANALYTICS_INSTANCE - SCALE_ANALYTICS_INSTANCE - CHANGE_ANALYTICS_INSTANCE_COMPARTMENT - CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT - CREATE_VANITY_URL - UPDATE_VANITY_URL - DELETE_VANITY_URL - CREATE_PRIVATE_ACCESS_CHANNEL - UPDATE_PRIVATE_ACCESS_CHANNEL - DELETE_PRIVATE_ACCESS_CHANNEL - UPDATE_INSTANCE_ENCRYPTION_KEY type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' 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/WorkRequestStatus' timeAccepted: description: 'The time the work request was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'The time the work request was finished, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'The time the work request was started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - operationType - status - compartmentId - resources - timeAccepted type: object WorkRequestError: description: 'Error encountered during the execution of a work request. ' properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. ' type: string message: description: 'Error message. ' type: string timestamp: description: 'The date and time the error occured, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - code - message - timestamp type: object AnalyticsInstanceSummary: description: 'Analytics Instance metadata (summary view). ' properties: capacity: $ref: '#/components/schemas/Capacity' 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: 'Optional description. ' maxLength: 512 minLength: 0 type: string emailNotification: description: 'Email address receiving notifications. ' maxLength: 512 minLength: 0 type: string featureSet: description: 'Analytics feature set. ' enum: - SELF_SERVICE_ANALYTICS - ENTERPRISE_ANALYTICS type: string x-obmcs-top-level-enum: '#/definitions/FeatureSet' 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 resource OCID. ' maxLength: 255 minLength: 1 type: string licenseType: description: 'The license used for the service. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string x-obmcs-top-level-enum: '#/definitions/LicenseType' lifecycleState: description: 'The current state of an instance. ' enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - INACTIVE - UPDATING type: string x-obmcs-top-level-enum: '#/definitions/AnalyticsInstanceLifecycleState' name: description: 'The name of the Analytics instance. This name must be unique in the tenancy and cannot be changed. ' maxLength: 32 minLength: 1 pattern: ^[a-zA-Z](-?[a-zA-Z0-9])*$ type: string networkEndpointDetails: $ref: '#/components/schemas/NetworkEndpointDetails' serviceUrl: description: 'URL of the Analytics service. ' maxLength: 1024 minLength: 0 type: string 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: `{"key": "value"}` ' type: object description: 'System tags for this resource. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"key": "value"}}` ' type: object timeCreated: description: 'The date and time the instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it. ' format: date-time type: string required: - id - name - compartmentId - lifecycleState - capacity - networkEndpointDetails - featureSet - timeCreated parameters: PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page required: false schema: type: string maxLength: 512 minLength: 1 SortByQueryParam: description: 'The field to sort by (one column only). Default sort order is ascending exception of `timeCreated` column (descending). ' in: query name: sortBy required: false x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - capacityType - capacityValue - featureSet - lifecycleState - name - timeCreated CompartmentIdQueryParam: description: 'The OCID of the compartment. ' in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string WorkRequestStatusQueryParam: description: 'One or more work request status values to filter on. ' in: query name: status required: false style: form explode: true schema: type: array items: enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' AnalyticsInstanceIdPathParam: description: 'The OCID of the AnalyticsInstance. ' in: path name: analyticsInstanceId required: true schema: type: string PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit required: false schema: type: integer maximum: 1000 minimum: 1 FeatureSetQueryParam: description: 'A filter to only return resources matching the feature set. Values are case-insensitive. ' in: query name: featureSet required: false x-obmcs-top-level-enum: '#/definitions/FeatureSet' schema: type: string enum: - SELF_SERVICE_ANALYTICS - ENTERPRISE_ANALYTICS PrivateAccessChannelKeyPathParam: description: 'The unique identifier key of the Private Access Channel. ' in: path name: privateAccessChannelKey required: true schema: type: string maxLength: 255 minLength: 1 WorkRequestIdPathParam: description: 'The OCID of the work request. ' in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). ' in: query name: sortOrder required: false x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC ResourceNameQueryParam: description: 'A filter to return only resources that match the given name exactly. ' in: query name: name required: false 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 may be rejected). ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 WorkRequestSortByQueryParam: description: 'The field used for sorting work request results. ' in: query name: sortBy required: false x-obmcs-top-level-enum: '#/definitions/WorkRequestSortBy' schema: type: string enum: - id - operationType - status - timeAccepted - timeStarted - timeFinished RequestIdHeader: description: 'Unique 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 pattern: ^[a-zA-Z0-9_./-]+$ WorkRequestResourceIdQueryParam: description: 'The OCID of the resource associated with a work request. ' in: query name: resourceId required: false schema: type: string WorkRequestResourceTypeQueryParam: description: 'Type of the resource associated with a work request. ' in: query name: resourceType required: false x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceType' schema: type: string enum: - ANALYTICS_INSTANCE CapacityTypeQueryParam: description: 'A filter to only return resources matching the capacity type enum. Values are case-insensitive. ' in: query name: capacityType required: false x-obmcs-top-level-enum: '#/definitions/CapacityType' schema: type: string enum: - OLPU_COUNT - USER_COUNT LifecycleStateQueryParam: description: 'A filter to only return resources matching the lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-top-level-enum: '#/definitions/AnalyticsInstanceLifecycleState' schema: type: string enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED - INACTIVE - UPDATING VanityUrlKeyPathParam: description: 'Specify unique identifier key of a vanity url to update or delete. ' in: path name: vanityUrlKey required: true schema: type: string responses: DefaultError: description: An error has occurred. 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-obmcs-client-circuit-breaker-enabled: true x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.bmc.analytics