openapi: 3.2.0 info: description: The OpenSearch service API provides access to OCI Search Service with OpenSearch. title: OpenSearch Service Opensearch Cluster API version: '20180828' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/db7aead90481c47e0d0e3f85d7516754adc899cb5606ea20d87eb9c20d2c0d0e.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the OpenSearch Service 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/db7aead90481c47e0d0e3f85d7516754adc899cb5606ea20d87eb9c20d2c0d0e.yaml what: the harvested document for OpenSearch Service API servers: - url: http://127.0.0.1/20180828 - url: https://127.0.0.1/20180828 tags: - name: opensearchCluster paths: /opensearch/versions: get: description: 'Lists the supported Opensearch versions ' operationId: ListOpensearchVersions parameters: - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OpensearchVersionsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Opensearch Versions tags: - opensearchCluster x-related-resource: '#/definitions/OpensearchVersionsCollection' /opensearchClusters: get: description: 'Returns a list of OpensearchClusters. ' operationId: ListOpensearchClusters parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OpensearchClusterLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/OpensearchClusterIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of OpensearchClusterSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-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/OpensearchClusterCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all OpensearchClusters in a compartment tags: - opensearchCluster x-related-resource: '#/definitions/OpensearchClusterCollection' post: description: 'Creates a new OpensearchCluster. ' operationId: CreateOpensearchCluster parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpensearchCluster 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new OpensearchCluster tags: - opensearchCluster x-related-resource: '#/definitions/OpensearchCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOpensearchClusterDetails' description: Details for the new OpensearchCluster. required: true /opensearchClusters/{opensearchClusterId}: delete: description: Deletes a OpensearchCluster resource by identifier operationId: DeleteOpensearchCluster parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpensearchCluster will be 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned OpensearchCluster tags: - opensearchCluster x-related-resource: '#/definitions/OpensearchCluster' get: description: Gets a OpensearchCluster by identifier operationId: GetOpensearchCluster parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the OpensearchCluster with the given id 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/OpensearchCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get OpensearchCluster tags: - opensearchCluster put: description: Updates the OpensearchCluster operationId: UpdateOpensearchCluster parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpensearchCluster 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the OpensearchCluster identified by the id tags: - opensearchCluster x-related-resource: '#/definitions/OpensearchCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOpensearchClusterDetails' description: Update the opensearch cluster details. required: true /opensearchClusters/{opensearchClusterId}/actions/backup: post: description: Backup the opensearch cluster details. operationId: BackupOpensearchCluster parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpensearchClusterBackup 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Backup the opensearch cluster. tags: - opensearchCluster x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/OpensearchCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupOpensearchClusterDetails' description: Backup the opensearch cluster details. required: true /opensearchClusters/{opensearchClusterId}/actions/configureOutboundCluster: post: description: Configure Outbound cluster for cross-cluster operations operationId: ConfigureOutboundCluster parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpensearchCluster 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Configure Outbound cluster for cross-cluster operations tags: - opensearchCluster x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/OpensearchCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureOutboundClusterDetails' description: Configure Outbound cluster details required: true /opensearchClusters/{opensearchClusterId}/actions/configureRemote: post: description: Configure the cluster to work remotely. operationId: ConfigureRemoteCluster parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpensearchCluster 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Configure the cluster to work remotely. tags: - opensearchCluster x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/OpensearchCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureRemoteClusterDetails' description: Configure remote cluster details required: true /opensearchClusters/{opensearchClusterId}/actions/resizeHorizontal: post: description: Resize the opensearch cluster horizontal details. operationId: ResizeOpensearchClusterHorizontal parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpensearchCluster 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Resize the opensearch cluster horizontal details. tags: - opensearchCluster x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/OpensearchCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ResizeOpensearchClusterHorizontalDetails' description: Resize the opensearch cluster horizontal details. required: true /opensearchClusters/{opensearchClusterId}/actions/resizeVertical: post: description: Resize the opensearch cluster vertical details. operationId: ResizeOpensearchClusterVertical parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpensearchCluster 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Resize the opensearch cluster vertical details. tags: - opensearchCluster x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/OpensearchCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ResizeOpensearchClusterVerticalDetails' description: Resize the opensearch cluster vertical details. required: true /opensearchClusters/{opensearchClusterId}/actions/restore: post: description: Restore the opensearch cluster details. operationId: OpensearchClusterRestore parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpensearchCluster 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Restore the opensearch cluster. tags: - opensearchCluster x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/OpensearchCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreOpensearchClusterDetails' description: Restore the opensearch cluster details. required: true /opensearchClusters/{opensearchClusterId}/actions/upgrade: post: description: Upgrade or clone the opensearch cluster. operationId: UpgradeOpenSearchCluster parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpenSearch Cluster will be upgraded. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Upgrade the opensearch Cluster. tags: - opensearchCluster x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/OpensearchCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpgradeOpenSearchClusterDetails' description: Upgrade Open Search Cluster Details required: true /opensearchClusters/{opensearchClusterId}/internal: get: description: Gets a OpensearchCluster by identifier operationId: GetOpensearchClusterInternalDetails parameters: - $ref: '#/components/parameters/OpensearchClusterIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the OpensearchCluster with the given id 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/OpensearchClusterInternalDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get OpensearchCluster Internal Details tags: - opensearchCluster /shapes: get: description: Retrieves available OpenSearch Cluster node shapes. operationId: ListOpensearchClusterShapes responses: 200: description: Retrieves a list of flex shapes that can be used to create OpenSearch Clusters. 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/ShapesDetails' 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' tags: - opensearchCluster /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/SourceResourceIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Requests tags: - opensearchCluster x-related-resource: '#/definitions/WorkRequestCollection' /workRequests/{workRequestId}: get: description: Gets the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: 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/default' summary: GET Work Request Status tags: - opensearchCluster x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - opensearchCluster x-related-resource: '#/definitions/WorkRequestErrorCollection' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - opensearchCluster x-related-resource: '#/definitions/WorkRequestLogEntryCollection' components: schemas: BackupPolicy: description: 'Backup policy as optionally used for Opensearch cluster. ' properties: frequencyInHours: default: 24 description: Specifies how often backup should be performed type: integer isEnabled: default: true description: Specifies if automatic backups are enabled. type: boolean retentionInDays: default: 14 description: Specifies how long backup copy should remain on Storage in days type: integer RestoreOpensearchClusterDetails: description: Information about the OpenSearch cluster backup to restore. properties: compartmentId: description: The OCID of the compartment where the cluster backup is located. maxLength: 255 minLength: 1 type: string opensearchClusterBackupId: description: The OCID of the cluster backup to restore. maxLength: 255 minLength: 1 type: string prefix: description: The prefix for the indices in the cluster backup. maxLength: 255 minLength: 1 type: string required: - opensearchClusterBackupId - compartmentId type: object SecuritySamlConfig: description: 'SAML policy is optionally used for Opensearch cluster to config SAML authentication ' properties: adminBackendRole: description: The backend role of admins who have all permissions like local master user type: string idpEntityId: description: The unique name for a identity provider entity type: string idpMetadataContent: description: The content of identity provider metadata type: string isEnabled: default: false description: A flag determine whether SAML is enabled type: boolean opendashboardUrl: default: https://localhost:5601 description: The endpoint of opendashboard type: string rolesKey: description: The roles key is sued to get backend roles from SAML assertion type: string subjectKey: description: The subject key is used to get username from SAML assertion. By default, it is NameID type: string required: - isEnabled - idpMetadataContent - idpEntityId 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 ResizeOpensearchClusterVerticalDetails: description: The OCPU and memory configuration to update on an existing OpenSearch cluster for [vertical resizing](/iaas/Content/search-opensearch/Tasks/resizingacluster.htm#vertical). properties: dataNodeHostMemoryGB: description: The amount of memory in GB, to configure for the cluster's data nodes. maximum: 99999 minimum: 1 type: integer dataNodeHostOcpuCount: description: The number of OCPUs to configure for the cluster's data nodes. maximum: 9999 minimum: 1 type: integer dataNodeHostShape: description: The node shape for the cluster's data nodes. maxLength: 255 minLength: 1 type: string dataNodeStorageGB: description: The amount of storage in GB, to configure per node for the cluster's data nodes. maximum: 99999 minimum: 1 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. 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 masterNodeHostMemoryGB: description: The amount of memory in GB, to configure for the cluster's master nodes. maximum: 99999 minimum: 1 type: integer masterNodeHostOcpuCount: description: The number of OCPUs to configure for the cluster's master nodes. maximum: 9999 minimum: 1 type: integer masterNodeHostShape: description: The node shape for the cluster's master nodes. maxLength: 255 minLength: 1 type: string opendashboardNodeHostMemoryGB: description: The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes. maximum: 99999 minimum: 1 type: integer opendashboardNodeHostOcpuCount: description: The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes. maximum: 9999 minimum: 1 type: integer opendashboardNodeHostShape: description: The node shape for the cluster's OpenSearch Dashboard nodes. maximum: 255 minimum: 1 type: string type: object WorkRequestCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: List of workRequests. items: $ref: '#/components/schemas/WorkRequest' type: array required: - items type: object UpgradeOpenSearchClusterDetails: description: Minor or major version upgrade of a cluster. 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 desiredSoftwareVersion: description: The software version the cluster is desired. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isClone: default: true description: The cluster would be cloned for true and updated for false with the provided version. type: boolean originalClusterDisplayName: description: 'The display name of the original cluster. This is required to validate that the cluster ID has the same display name. ' maxLength: 255 minLength: 1 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: `{"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 upgradeType: description: The upgrade type of cluster (major or minor). enum: - MINOR - MAJOR type: string x-obmcs-top-level-enum: '#/definitions/UpgradeType' required: - originalClusterDisplayName - desiredSoftwareVersion - upgradeType type: object ResizeOpensearchClusterHorizontalDetails: description: The node count configuration to update on an existing OpenSearch cluster for [horizontal resizing](/iaas/Content/search-opensearch/Tasks/resizingacluster.htm#horizontalresize). properties: dataNodeCount: description: The number of data nodes to configure for the cluster. maximum: 999 minimum: 1 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. 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 masterNodeCount: description: The number of master nodes to configure for the cluster. maximum: 999 minimum: 1 type: integer opendashboardNodeCount: description: The number of OpenSearch Dashboard nodes to configure for the cluster. maximum: 999 minimum: 1 type: integer type: object UpdateMaintenanceDetails: description: Details for update of maintenance details properties: notificationEmailIds: description: The Email IDs given by the customer to get notified about maintenance activities items: maxLength: 320 minLength: 1 type: string type: array type: object CreateMaintenanceDetails: description: Details for creation of maintenance details properties: notificationEmailIds: description: The Email IDs given by the customer to get notified about maintenance activities items: maxLength: 320 minLength: 1 type: string type: array type: object OpensearchClusterCollection: description: The list of OpenSearch clusters returned in a cluster search. properties: items: description: The list of clusters. items: $ref: '#/components/schemas/OpensearchClusterSummary' type: array required: - items type: object WorkRequestResource: description: A resource that is created or operated on by an asynchronous operation that is tracked by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that you can use for a GET request to access the resource metadata. type: string identifier: description: The OCID of the resource the work request affects. type: string required: - actionType - entityType - identifier BackupOpensearchClusterDetails: description: Information about an OpenSearch cluster backup. properties: compartmentId: description: The OCID of the compartment where the cluster backup is located. type: string displayName: description: The name of the cluster backup. Avoid entering confidential information. type: string required: - compartmentId - displayName type: object ShapesDetails: description: Shapes for OpenSearch Cluster. properties: shapes: description: List of Shapes. items: maxLength: 255 minLength: 1 type: string type: array type: object ConfigureOutboundClusterDetails: description: Details for configuring the cluster to work as an Outbound cluster properties: inboundClusterIds: description: List of inbound clusters that will be queried using cross cluster search items: maxLength: 255 minLength: 1 type: string type: array required: - inboundClusterIds type: object WorkRequest: description: An asynchronous work request. properties: compartmentId: description: The OCID of the compartment that contains the work request. type: string id: description: The OCID of the work request. type: string operationType: description: The type of operation that spawned the work request. enum: - CREATE_OPENSEARCH_CLUSTER - UPDATE_OPENSEARCH_CLUSTER - DELETE_OPENSEARCH_CLUSTER - MOVE_OPENSEARCH_CLUSTER - RESTORE_OPENSEARCH_CLUSTER - BACKUP_OPENSEARCH_CLUSTER - UPDATE_OPENSEARCH_CLUSTER_BACKUP - MOVE_OPENSEARCH_CLUSTER_BACKUP - DELETE_OPENSEARCH_CLUSTER_BACKUP - UPDATE_OPENSEARCH_CLUSTER_SECURITY_CONFIG - CONFIGURE_REMOTE_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: The percentage complete of the operation tracked by the work request. format: float type: number resources: description: The resources that are affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeFinished: description: The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeStarted: description: The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted CreateOpensearchClusterDetails: description: The configuration details for a new OpenSearch cluster. properties: backupPolicy: $ref: '#/components/schemas/BackupPolicy' certificateConfig: $ref: '#/components/schemas/CertificateConfig' compartmentId: description: The OCID of the compartment to create the cluster in. maxLength: 255 minLength: 1 type: string dataNodeCount: description: The number of data nodes to configure for the cluster. maximum: 999 minimum: 1 type: integer dataNodeHostBareMetalShape: description: The bare metal shape for the cluster's data nodes. maxLength: 255 minLength: 1 type: string dataNodeHostMemoryGB: description: The amount of memory in GB, to configure per node for the cluster's data nodes. maximum: 99999 minimum: 1 type: integer dataNodeHostOcpuCount: description: The number of OCPUs to configure for the cluster's data nodes. maximum: 9999 minimum: 1 type: integer dataNodeHostShape: description: The node shape for the cluster's data nodes. maxLength: 255 minLength: 1 type: string dataNodeHostType: description: TThe instance type for the cluster's data nodes. enum: - FLEX - BM type: string x-obmcs-top-level-enum: '#/definitions/DataNodeHostType' dataNodeStorageGB: description: The amount of storage in GB, to configure per node for the cluster's data nodes. maximum: 99999 minimum: 1 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The name of the cluster. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object inboundClusterIds: description: List of inbound clusters that will be queried using cross cluster search items: maxLength: 255 minLength: 1 type: string type: array loadBalancerConfig: $ref: '#/components/schemas/LoadBalancerConfig' maintenanceDetails: $ref: '#/components/schemas/CreateMaintenanceDetails' masterNodeCount: description: The number of master nodes to configure for the cluster. maximum: 999 minimum: 1 type: integer masterNodeHostBareMetalShape: description: The bare metal shape for the cluster's master nodes. maxLength: 255 minLength: 1 type: string masterNodeHostMemoryGB: description: The amount of memory in GB, to configure per node for the cluster's master nodes. maximum: 99999 minimum: 1 type: integer masterNodeHostOcpuCount: description: The number of OCPUs to configure for the cluser's master nodes. maximum: 9999 minimum: 1 type: integer masterNodeHostShape: description: The node shape for the cluster's master nodes. maxLength: 255 minLength: 1 type: string masterNodeHostType: description: The instance type for the cluster's master nodes. enum: - FLEX - BM type: string x-obmcs-top-level-enum: '#/definitions/MasterNodeHostType' opendashboardNodeCount: description: The number of OpenSearch Dashboard nodes to configure for the cluster. maximum: 999 minimum: 1 type: integer opendashboardNodeHostMemoryGB: description: The amount of memory in GB, to configure for the cluster's OpenSearch Dashboard nodes. maximum: 9999 minimum: 1 type: integer opendashboardNodeHostOcpuCount: description: The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes. maximum: 9999 minimum: 1 type: integer opendashboardNodeHostShape: description: The node shape for the cluster's OpenSearch Dashboard nodes. maximum: 255 minimum: 1 type: string outboundClusterConfig: $ref: '#/components/schemas/OutboundClusterConfig' remoteClusterConfig: $ref: '#/components/schemas/RemoteClusterConfig' securityMasterUserName: description: The name of the master user that are used to manage security config maxLength: 255 minLength: 1 type: string securityMasterUserPasswordHash: description: The password hash of the master user that are used to manage security config maxLength: 255 minLength: 1 type: string securityMode: description: The security mode of the cluster. enum: - DISABLED - PERMISSIVE - ENFORCING type: string x-obmcs-top-level-enum: '#/definitions/SecurityMode' securitySamlConfig: $ref: '#/components/schemas/SecuritySamlConfig' softwareVersion: description: The version of the software the cluster is running. maxLength: 255 minLength: 1 type: string sourceClusterIds: description: List of source clusters from where cluster will be queried using cross cluster search. items: maxLength: 255 minLength: 1 type: string type: array subnetCompartmentId: description: The OCID for the compartment where the cluster's subnet is located. maxLength: 255 minLength: 1 type: string subnetId: description: The OCID of the cluster's subnet. maxLength: 255 minLength: 1 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: `{"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 vcnCompartmentId: description: The OCID for the compartment where the cluster's VCN is located. maxLength: 255 minLength: 1 type: string vcnId: description: The OCID of the cluster's VCN. maxLength: 255 minLength: 1 type: string required: - displayName - compartmentId - softwareVersion - vcnId - subnetId - vcnCompartmentId - subnetCompartmentId - masterNodeHostType - masterNodeCount - masterNodeHostOcpuCount - masterNodeHostMemoryGB - dataNodeHostType - dataNodeCount - dataNodeHostOcpuCount - dataNodeHostMemoryGB - dataNodeStorageGB - opendashboardNodeCount - opendashboardNodeHostOcpuCount - opendashboardNodeHostMemoryGB type: object WorkRequestErrorCollection: description: The list of work request errors returned in a work request error search. properties: items: description: A list of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object OpensearchVersionsCollection: description: The list of OpenSearch versions returned in an OpenSearch version search. properties: items: description: A list of OpenSearch versions. items: $ref: '#/components/schemas/OpensearchVersionsSummary' type: array required: - items type: object OpensearchClusterSummary: description: The summary of information about an OpenSearch cluster. properties: availabilityDomains: description: The availability domains to distribute the cluser nodes across. items: maxLength: 255 minLength: 1 type: string maxItems: 3 minItems: 1 type: array backupPolicy: $ref: '#/components/schemas/BackupPolicy' compartmentId: description: The OCID for the compartment where the cluster is located. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The name of the cluster. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the cluster. type: string lifecycleDetails: description: Additional information about the current lifecycle state of the cluster. type: string lifecycleState: description: The current state of the cluster. type: string x-obmcs-enumref: '#/definitions/OpensearchCluster/lifecycleState' loadBalancerConfig: $ref: '#/components/schemas/LoadBalancerConfig' outboundClusterConfig: $ref: '#/components/schemas/OutboundClusterConfig' remoteClusterConfig: $ref: '#/components/schemas/RemoteClusterConfig' securityMode: description: The security mode of the cluster. enum: - DISABLED - PERMISSIVE - ENFORCING type: string x-obmcs-top-level-enum: '#/definitions/SecurityMode' softwareVersion: description: The software version the cluster is running. maxLength: 255 minLength: 1 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: `{"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 timeCreated: description: 'The date and time the cluster was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the cluster was updated. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string totalStorageGB: description: The total amount of storage in GB, for the cluster. maximum: 99999 minimum: 1 type: integer required: - id - compartmentId - softwareVersion - totalStorageGB type: object OutboundClusterSummary: description: 'Contains details of a Outbound cluster ' properties: displayName: description: Name of the Outbound cluster. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string isSkipUnavailable: default: true description: Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable type: boolean mode: default: SEARCH_ONLY description: Mode for the cross cluster connection enum: - SEARCH_ONLY - REPLICATION_ONLY - SEARCH_AND_REPLICATION type: string x-obmcs-top-level-enum: '#/definitions/CccMode' pingSchedule: description: Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent. type: string seedClusterId: description: OCID of the Outbound cluster maxLength: 255 minLength: 1 type: string required: - displayName - seedClusterId CertificateConfig: description: Custom certificate config. properties: clusterCertificateMode: description: Specifies whether the certificate to be used in cluster is managed by OpenSearch or OCI Certificates service. enum: - OCI_CERTIFICATES_SERVICE - OPENSEARCH_SERVICE type: string x-obmcs-top-level-enum: '#/definitions/CertificateMode' dashboardCertificateMode: description: Specifies whether the certificate to be used in dashboard is managed by OpenSearch or OCI Certificates service. enum: - OCI_CERTIFICATES_SERVICE - OPENSEARCH_SERVICE type: string x-obmcs-top-level-enum: '#/definitions/CertificateMode' openSearchApiCertificateId: description: certificate to be used for OpenSearch cluster api communication type: string openSearchDashboardCertificateId: description: certificate to be used for OpenSearch dashboard api communication type: string type: object ConfigureRemoteClusterDetails: description: Details for configuring the cluster to work as remote cluster. properties: sourceClusterIds: description: List of Source clusters from where cluster will be queried using cross cluster search. items: maxLength: 255 minLength: 1 type: string type: array required: - sourceClusterIds type: object RemoteClusterSummary: description: 'This config is used to pass request information to add remote cluster/s to the coordinating cluster which in this case is the cluster from which request is originated. ' properties: displayName: description: The name of the remote cluster. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string isSkipUnavailable: default: true description: A flag to determine whether to skip an unavailable remote cluster during cross cluster search type: boolean mode: default: SEARCH_ONLY description: Mode for the cross cluster connection enum: - SEARCH_ONLY - REPLICATION_ONLY - SEARCH_AND_REPLICATION type: string x-obmcs-top-level-enum: '#/definitions/CccMode' pingSchedule: description: Sets the time interval between regular application-level ping messages that are sent to try and keep remote cluster connections alive. If set to -1, application-level ping messages to this remote cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent. type: string seedClusterId: description: The OCID of the remote OpenSearch clusters. maxLength: 255 minLength: 1 type: string required: - displayName - seedClusterId OpensearchVersionsSummary: description: A description of Opensearch versions properties: version: description: The version of OpenSearch. type: string required: - version type: object WorkRequestError: description: An error encountered while executing an operation that is tracked by a work request. properties: code: description: 'A machine-usable code for the error that occured. For a list of error codes, see [API Errors](https://docs.cloud.oracle.com/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable string describing the error that occurred. type: string timestamp: description: The day and time the error occured, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - code - message - timestamp MaintenanceDetails: description: Details for the maintenance activity. properties: endTime: description: End time of the maintenance activity format: date-time type: string notificationEmailIds: description: The Email Ids given the by customer to get notified about maintenance activities items: maxLength: 320 minLength: 1 type: string type: array startTime: description: Start time of the maintenance activity format: date-time type: string state: default: TO_BE_SCHEDULED description: State of the maintenance activity enum: - SCHEDULED - RESCHEDULED - TO_BE_SCHEDULED type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceState' required: - state type: object UpdateOpensearchClusterDetails: description: 'The configuration to update on an existing OpenSearch cluster. Software version and security config are not allowed to be updated at the same time. ' properties: backupPolicy: $ref: '#/components/schemas/BackupPolicy' certificateConfig: $ref: '#/components/schemas/CertificateConfig' 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 displayName: description: The name of the cluster. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object loadBalancerConfig: $ref: '#/components/schemas/LoadBalancerConfig' maintenanceDetails: $ref: '#/components/schemas/UpdateMaintenanceDetails' outboundClusterConfig: $ref: '#/components/schemas/OutboundClusterConfig' remoteClusterConfig: $ref: '#/components/schemas/RemoteClusterConfig' securityMasterUserName: description: The name of the master user that are used to manage security config maxLength: 255 minLength: 1 type: string securityMasterUserPasswordHash: description: The password hash of the master user that are used to manage security config maxLength: 255 minLength: 1 type: string securityMode: description: The security mode of the cluster. enum: - DISABLED - PERMISSIVE - ENFORCING type: string x-obmcs-top-level-enum: '#/definitions/SecurityMode' securitySamlConfig: $ref: '#/components/schemas/SecuritySamlConfig' softwareVersion: maxLength: 6 minLength: 3 type: string required: - displayName type: object OpensearchClusterInternalDetails: description: 'This is the ClusterLoadBalancer which can store the State of the cluster, opensearchLoadbalancerIps, remoteLoadbalancerIps ' 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 elasticLoadBalancerIps: description: List of OpenSearch elastic LoadbalancerIps items: maxLength: 1024 minLength: 1 type: string type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object remoteLoadBalancerIps: description: List of OpenSearch remote LoadbalancerIps items: maxLength: 1024 minLength: 1 type: string type: array state: description: The state of the cluster. maxLength: 255 minLength: 1 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: `{"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 required: - state - elasticLoadBalancerIps - remoteLoadBalancerIps type: object OutboundClusterConfig: description: 'This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster) ' properties: isEnabled: default: false description: Flag to indicate whether outbound cluster configuration is enabled type: boolean outboundClusters: description: List of outbound clusters to be connected to the inbound cluster items: $ref: '#/components/schemas/OutboundClusterSummary' type: array required: - isEnabled - outboundClusters RemoteClusterConfig: description: 'This config is used to pass request information to add remote cluster/s to the coordinating cluster which in this case is the cluster from which request is originated. ' properties: isEnabled: default: false description: A flag determine whether remote config is enabled type: boolean remote: description: List of remote cluster to be added to the coordinating cluster. items: $ref: '#/components/schemas/RemoteClusterSummary' type: array required: - isEnabled - remote WorkRequestLogEntry: description: A log message from executing an operation that is tracked by a work request. properties: message: description: A human-readable log message. type: string timestamp: description: The day and time the log message was written, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - message - timestamp WorkRequestLogEntryCollection: description: The list of work request log entries returned in a work request log search. properties: items: description: A list of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object OpensearchCluster: description: 'An OpenSearch cluster resource. An OpenSearch cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see [About Search Service with OpenSearch](/iaas/Content/search-opensearch/Concepts/ociopensearch.htm). ' properties: availabilityDomains: description: The availability domains to distribute the cluser nodes across. items: maxLength: 255 minLength: 1 type: string maxItems: 3 minItems: 1 type: array backupPolicy: $ref: '#/components/schemas/BackupPolicy' certificateConfig: $ref: '#/components/schemas/CertificateConfig' compartmentId: description: The OCID of the compartment where the cluster is located. maxLength: 255 minLength: 1 type: string dataNodeCount: description: The number of data nodes configured for the cluster. maximum: 999 minimum: 1 type: integer dataNodeHostBareMetalShape: description: The bare metal shape for the cluster's data nodes. maxLength: 255 minLength: 1 type: string dataNodeHostMemoryGB: description: The amount of memory in GB, for the cluster's data nodes. maximum: 99999 minimum: 1 type: integer dataNodeHostOcpuCount: description: The number of OCPUs configured for the cluster's data nodes. maximum: 9999 minimum: 1 type: integer dataNodeHostShape: description: The node shape for the cluster's data nodes. maxLength: 255 minLength: 1 type: string dataNodeHostType: description: The instance type for the cluster's data nodes. enum: - FLEX - BM type: string x-obmcs-top-level-enum: '#/definitions/DataNodeHostType' dataNodeStorageGB: description: The amount of storage in GB, to configure per node for the cluster's data nodes. maximum: 99999 minimum: 1 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The name of the cluster. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string fqdn: description: The fully qualified domain name (FQDN) for the cluster's API endpoint. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the cluster. maxLength: 255 minLength: 1 type: string inboundClusterIds: description: List of inbound clusters for which this cluster is an outbound cluster items: maxLength: 255 minLength: 1 type: string type: array lifecycleDetails: description: Additional information about the current lifecycle state of the cluster. type: string lifecycleState: description: The current state of the cluster. enum: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED type: string loadBalancerConfig: $ref: '#/components/schemas/LoadBalancerConfig' maintenanceDetails: $ref: '#/components/schemas/MaintenanceDetails' masterNodeCount: description: The number of master nodes configured for the cluster. maximum: 999 minimum: 1 type: integer masterNodeHostBareMetalShape: description: The bare metal shape for the cluster's master nodes. maxLength: 255 minLength: 1 type: string masterNodeHostMemoryGB: description: The amount of memory in GB, for the cluster's master nodes. maximum: 99999 minimum: 1 type: integer masterNodeHostOcpuCount: description: The number of OCPUs configured for cluster's master nodes. maximum: 9999 minimum: 1 type: integer masterNodeHostShape: description: The node shape for the cluster's master nodes. maxLength: 255 minLength: 1 type: string masterNodeHostType: description: The instance type for the cluster's master nodes. enum: - FLEX - BM type: string x-obmcs-top-level-enum: '#/definitions/MasterNodeHostType' opendashboardFqdn: description: The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint. maxLength: 255 minLength: 1 type: string opendashboardNodeCount: description: The number of OpenSearch Dashboard nodes configured for the cluster. maximum: 999 minimum: 1 type: integer opendashboardNodeHostMemoryGB: description: The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes. maximum: 9999 minimum: 1 type: integer opendashboardNodeHostOcpuCount: description: The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes. maximum: 9999 minimum: 1 type: integer opendashboardNodeHostShape: description: The node shape for the cluster's OpenSearch Dashboard nodes. maximum: 255 minimum: 1 type: string opendashboardPrivateIp: description: The private IP address for the cluster's OpenSearch Dashboard. maxLength: 255 minLength: 1 type: string opensearchFqdn: description: The fully qualified domain name (FQDN) for the cluster's API endpoint. maxLength: 255 minLength: 1 type: string opensearchPrivateIp: description: The cluster's private IP address. maxLength: 255 minLength: 1 type: string outboundClusterConfig: $ref: '#/components/schemas/OutboundClusterConfig' remoteClusterConfig: $ref: '#/components/schemas/RemoteClusterConfig' securityMasterUserName: description: The name of the master user that are used to manage security config maxLength: 255 minLength: 1 type: string securityMasterUserPasswordHash: description: The password hash of the master user that are used to manage security config maxLength: 255 minLength: 1 type: string securityMode: description: The security mode of the cluster. enum: - DISABLED - PERMISSIVE - ENFORCING type: string x-obmcs-top-level-enum: '#/definitions/SecurityMode' securitySamlConfig: $ref: '#/components/schemas/SecuritySamlConfig' softwareVersion: description: The software version the cluster is running. maxLength: 255 minLength: 1 type: string sourceClusterIds: description: The list of source clusters for which the cluster is remote items: maxLength: 255 minLength: 1 type: string type: array subnetCompartmentId: description: The OCID for the compartment where the cluster's subnet is located. maxLength: 255 minLength: 1 type: string subnetId: description: The OCID of the cluster's subnet. maxLength: 255 minLength: 1 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: `{"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 timeCreated: description: The amount of time in milliseconds since the cluster was created. format: date-time type: string timeDeleted: description: The amount of time in milliseconds since the cluster was updated. format: date-time type: string timeUpdated: description: The amount of time in milliseconds since the cluster was updated. format: date-time type: string totalStorageGB: description: The size in GB of the cluster's total storage. maximum: 99999 minimum: 1 type: integer vcnCompartmentId: description: The OCID for the compartment where the cluster's VCN is located. maxLength: 255 minLength: 1 type: string vcnId: description: The OCID of the cluster's VCN. maxLength: 255 minLength: 1 type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - softwareVersion - totalStorageGB - vcnId - subnetId - vcnCompartmentId - subnetCompartmentId - opensearchFqdn - opensearchPrivateIp - opendashboardFqdn - opendashboardPrivateIp - availabilityDomains - masterNodeHostType - masterNodeCount - masterNodeHostOcpuCount - masterNodeHostMemoryGB - dataNodeHostType - dataNodeCount - dataNodeHostOcpuCount - dataNodeHostMemoryGB - dataNodeStorageGB - opendashboardNodeCount - opendashboardNodeHostOcpuCount - opendashboardNodeHostMemoryGB type: object LoadBalancerConfig: description: 'This config is used to choose the load balancer service and bandwidth for OpenSearch and OpenDashboard load balancers. ' properties: loadBalancerMaxBandwidthInMbps: description: Maximum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service. maximum: 8000 minimum: 500 type: integer loadBalancerMinBandwidthInMbps: description: Minimum bandwidth (Mbps) of OpenSearch load balancer. Not applicable for network load balancer service. maximum: 8000 minimum: 30 type: integer loadBalancerServiceType: default: LOAD_BALANCER description: Load balancer service for OpenSearch and OpenDashboard load balancer. Default value is LOAD_BALANCER. enum: - LOAD_BALANCER - NETWORK_LOAD_BALANCER type: string required: - loadBalancerServiceType parameters: OpensearchClusterLifecycleStateQueryParam: description: A filter to return only OpensearchClusters their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/OpensearchCluster/lifecycleState' schema: type: string OpensearchClusterIdentifierQueryParam: description: unique OpensearchCluster identifier in: query name: id x-default-description: 'null' schema: type: string 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 schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated 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 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string OpensearchClusterIdentifierPathParam: description: unique OpensearchCluster identifier in: path name: opensearchClusterId required: true schema: type: string 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 SourceResourceIdQueryParam: description: The ID of the source resource to list work requests. in: query name: sourceResourceId required: false schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-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-oracle-package: com.oracle.pic.opensearch.mp