openapi: 3.2.0 info: description: 'REST API for Oracle Big Data Service. Use this API to build, deploy, and manage fully elastic Big Data Service clusters. Build on Hadoop, Spark and Data Science distributions, which can be fully integrated with existing enterprise data in Oracle Database and Oracle applications. ' title: Big Data Service Bds API version: '20190531' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/3fff4afa0b61b05911fb25ab1754e331bb0c263d4f0561e89fba8bc90cd06dc2.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Big Data 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/3fff4afa0b61b05911fb25ab1754e331bb0c263d4f0561e89fba8bc90cd06dc2.yaml what: the harvested document for Big Data Service API servers: - url: /20190531 tags: - name: bds paths: /bdsCapacityReports: post: description: 'Create a detailed capacity report for BDS service ' operationId: CreateBdsCapacityReport parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: A report of the BDS host capacity within an region or availability domain that is available for you to create BDS instances. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BdsCapacityReport' 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/DefaultError' summary: Create a Bds Capacity Report tags: - bds requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBdsCapacityReportDetails' description: Details for the capacity reports requests required: true /bdsClusterVersions: get: description: 'Returns a list of cluster versions with associated odh and bds versions. ' operationId: ListBdsClusterVersions parameters: - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByBdsVersionQueryParam' - $ref: '#/components/parameters/DefaultDescSortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of cluster versions with associated odh and bds versions. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BdsClusterVersionSummary' 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 cluster versions available for creation tags: - bds x-obmcs-authz-declarations: authorizationRequired: false /bdsInstances: get: description: 'Returns a list of all Big Data Service clusters in a compartment. ' operationId: ListBdsInstances parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of Big Data Service clusters. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BdsInstanceSummary' 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: View the Clusters in a Compartment tags: - bds post: description: 'Creates a Big Data Service cluster. ' operationId: CreateBdsInstance parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The cluster will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Create a Cluster tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBdsInstanceDetails' description: Details for the new cluster. required: true /bdsInstances/{bdsInstanceId}: delete: description: Deletes the cluster identified by the given ID. operationId: DeleteBdsInstance parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The cluster will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete a Cluster tags: - bds x-related-resource: '#/definitions/BdsInstance' get: description: Returns information about the Big Data Service cluster identified by the given ID. operationId: GetBdsInstance parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns information about the cluster identified by 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BdsInstance' 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: View a Cluster tags: - bds put: description: Updates the Big Data Service cluster identified by the given ID. operationId: UpdateBdsInstance parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The cluster will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Update a Cluster tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBdsInstanceDetails' description: Details for the cluster to be updated. required: true /bdsInstances/{bdsInstanceId}/actions/addBlockStorage: post: description: 'Adds block storage to existing worker/compute only worker nodes. The same amount of storage will be added to all worker/compute only worker nodes. No change will be made to storage that is already attached. Block storage cannot be removed. ' operationId: AddBlockStorage parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The additional block volume will be added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Add Block Storage to a Cluster tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddBlockStorageDetails' description: Details for the added block storage. required: true /bdsInstances/{bdsInstanceId}/actions/addCloudSql: post: description: 'Adds Cloud SQL to your cluster. You can use Cloud SQL to query against non-relational data stored in multiple big data sources, including Apache Hive, HDFS, Oracle NoSQL Database, and Apache HBase. Adding Cloud SQL adds a query server node to the cluster and creates cell servers on all the worker nodes in the cluster. ' operationId: AddCloudSql parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Cloud SQL will be added to the cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Add Cloud SQL to a Cluster tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddCloudSqlDetails' description: Details for the Cloud SQL capability required: true /bdsInstances/{bdsInstanceId}/actions/addKafka: post: description: 'Adds Kafka to a cluster. ' operationId: AddKafka parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Kafka will be added to the cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Add Kafka to a Cluster tags: - bds x-example: "POST /20190531/bdsInstances//actions/addKafka\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n\n{\n \"shape\" : \"VM.Standard2.1\",\n \"numberOfKafkaNodes\" : 2,\n \"blockVolumeSizeInGBs\" : 150,\n \"clusterAdminPassword\" : \"dGVzdDEyMw==\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddKafkaDetails' description: Details of the Kafka broker nodes to employ to enable the service. required: true /bdsInstances/{bdsInstanceId}/actions/addMasterNodes: post: description: 'Increases the size (scales out) of a cluster by adding master nodes. The added master nodes will have the same shape and will have the same amount of attached block storage as other master nodes in the cluster. ' operationId: AddMasterNodes parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The additional nodes will be added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Add Master Nodes to a Cluster tags: - bds x-example: "POST /20190531/bdsInstances//actions/addMasterNodes\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n\n{\n \"shape\" : \"VM.Standard2.1\",\n \"numberOfMasterNodes\" : 2,\n \"blockVolumeSizeInGBs\" : 150,\n \"clusterAdminPassword\" : \"dGVzdDEyMw==\"\n}\n" x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddMasterNodesDetails' description: Details for the newly added nodes. required: true /bdsInstances/{bdsInstanceId}/actions/addUtilityNodes: post: description: 'Increases the size (scales out) of a cluster by adding utility nodes. The added utility nodes will have the same shape and will have the same amount of attached block storage as other utility nodes in the cluster. ' operationId: AddUtilityNodes parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The additional nodes will be added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Add Utility Nodes to a Cluster tags: - bds x-example: "POST /20190531/bdsInstances//actions/addUtilityNodes\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n\n{\n \"shape\" : \"VM.Standard2.1\",\n \"numberOfUtilityNodes\" : 2,\n \"blockVolumeSizeInGBs\" : 150,\n \"clusterAdminPassword\" : \"dGVzdDEyMw==\"\n}\n" x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddUtilityNodesDetails' description: Details for the newly added nodes. required: true /bdsInstances/{bdsInstanceId}/actions/addWorkerNodes: post: description: 'Increases the size (scales out) of a cluster by adding worker nodes (data/compute/edge). The added worker and compute only worker nodes will have the same amount of attached block storage as other nodes of the same type in the cluster. Edge nodes can have different block storage sizes within the valid range (50GB-10TB). ' operationId: AddWorkerNodes parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The additional nodes will be added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Add Worker Nodes to a Cluster tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddWorkerNodesDetails' description: Details for the newly added nodes. required: true /bdsInstances/{bdsInstanceId}/actions/backupNodes: post: description: 'Takes a backup of of given nodes. ' operationId: BackupNode parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request to take node backups headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Takes the backup of given nodes. tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupNodeDetails' description: Details for Taking the node's backup required: true /bdsInstances/{bdsInstanceId}/actions/changeCompartment: post: description: 'Moves a Big Data Service cluster into a different compartment. ' operationId: ChangeBdsInstanceCompartment parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The cluster will be moved to another compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Move a Cluster to a Different Compartment tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBdsInstanceCompartmentDetails' description: Details for the comparment change. required: true /bdsInstances/{bdsInstanceId}/actions/changeShape: post: description: 'Changes the size of a cluster by scaling up or scaling down the nodes. Nodes are scaled up or down by changing the shapes of all the nodes of the same type to the next larger or smaller shape. The node types are master, utility, worker, and Cloud SQL. Only nodes with VM-STANDARD shapes can be scaled. ' operationId: ChangeShape parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request accepted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Resize a Cluster by Changing Node Shapes tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeShapeDetails' description: Individual change shape settings per node type. You can change the shape of master, worker, utility and Cloud SQL nodes. required: true /bdsInstances/{bdsInstanceId}/actions/disableOdhServiceCertificate: post: description: 'Disabling TLS/SSL for various ODH services running on the BDS cluster. ' operationId: DisableCertificate parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Workflow for disabling TLS/SSL is initiated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Disabling TLS/SSL Encryption for ODH Services. tags: - bds x-example: "POST /20190531/bdsInstances//actions/disableOdhServiceCertificate\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n\n{\n \"services\" : \"lakehouse\",\n \"clusterAdminPassword\" : \"dGVzdDEyMw==\"\n}\n" x-obmcs-terraform: actionType: DISABLE identifier: OPERATION_CERTIFICATE_MANAGEMENT x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/DisableCertificateDetails' description: Details for disabling certificate. required: true /bdsInstances/{bdsInstanceId}/actions/enableOdhServiceCertificate: post: description: 'Configuring TLS/SSL for various ODH services running on the BDS cluster. ' operationId: EnableCertificate parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Workflow for enabling TLS/SSL is initiated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Configuring TLS/SSL Encryption for ODH Services. tags: - bds x-example: "POST /20190531/bdsInstances//actions/enableOdhServiceCertificate\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n\n{\n \"services\" : \"lakehouse\",\n \"clusterAdminPassword\" : \"dGVzdDEyMw==\",\n \"rootCertificate\" : \"root_certificate\",\n \"hostCertDetails\" : [{\n \"hostName\": \"host1\",\n \"certificate\": \"certificate1\",\n \"privateKey\": \"privatekey1\"\n }],\n \"serverKeyPassword\" : \"dGVzdDEyMw==\"\n}\n" x-obmcs-terraform: actionType: ENABLE identifier: OPERATION_CERTIFICATE_MANAGEMENT x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableCertificateDetails' description: Details for configuring certificate. required: true /bdsInstances/{bdsInstanceId}/actions/executeBootstrapScript: post: description: 'Execute bootstrap script. ' operationId: ExecuteBootstrapScript parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Bootstrap script will be executed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Execute bootstrap script. tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExecuteBootstrapScriptDetails' description: Details of the bootstrap script to execute on this cluster. required: true /bdsInstances/{bdsInstanceId}/actions/fetchOdhServiceCertificate: post: description: 'A list of services and their certificate details. ' operationId: CertificateServiceInfo parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: A list of services, their certificate status and details. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/CertificateServiceInfoSummary' type: array 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: A list of services and their certificate details. tags: - bds x-example: "POST /20190531/bdsInstances//actions/fetchOdhServiceCertificate\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n\n{\n \"services\" : \"ZOOKEEPER, KAFKA\"\n}\n" x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificateServiceInfoDetails' description: Details for certificate service info required: true /bdsInstances/{bdsInstanceId}/actions/generateBdsCertificate: post: description: 'Generating certificates under BDS cluster nodes. ' operationId: GenerateBdsCertificate parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Workflow for generating certificates is initiated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Generating certificates under BDS cluster nodes. tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateBdsCertificateDetails' description: Details for generating BDS certificates. required: true /bdsInstances/{bdsInstanceId}/actions/getOsPatch: post: description: Get the details of an os patch operationId: GetOsPatchDetails parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/OsPatchVersionParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Details of an os patch 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OsPatchDetails' 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' tags: - bds x-related-resource: '#/definitions/BdsInstance' /bdsInstances/{bdsInstanceId}/actions/installOsPatch: post: description: 'Install an os patch on a cluster ' operationId: InstallOsPatch parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The os patch will be installed on the cluster headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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 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' tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/InstallOsPatchDetails' description: Details of the target os patch that will be installed required: true /bdsInstances/{bdsInstanceId}/actions/installPatch: post: description: 'Install the specified patch to this cluster. ' operationId: InstallPatch parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The patch will be installed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Install the specified patch to this cluster. tags: - bds x-obmcs-terraform: actionType: MANAGEMENT_RESOURCE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/InstallPatchDetails' description: Details of the patch to be installed. required: true /bdsInstances/{bdsInstanceId}/actions/installSoftwareUpdates: post: description: 'Install the specified software update to this cluster. ' operationId: InstallSoftwareUpdates parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The software update will be installed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Install the specified software update to this cluster. tags: - bds x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/InstallSoftwareUpdatesDetails' description: Details of the software update to be installed. required: true /bdsInstances/{bdsInstanceId}/actions/listOsPatches: post: description: List all available os patches for a given cluster operationId: ListOsPatches parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/DefaultDescSortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: A page of available os patch summaries headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: 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. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/OsPatchSummary' type: array 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' tags: - bds x-related-resource: '#/definitions/BdsInstance' /bdsInstances/{bdsInstanceId}/actions/removeCloudSql: post: description: 'Removes Cloud SQL from the cluster. ' operationId: RemoveCloudSql parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Cloud SQL will be removed from the cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Remove Cloud SQL from a Cluster tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveCloudSqlDetails' description: Details for the Cloud SQL capability required: true /bdsInstances/{bdsInstanceId}/actions/removeKafka: post: description: 'Remove Kafka from the cluster. ' operationId: RemoveKafka parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Kafka will be removed from the cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Remove Kafka from the cluster. tags: - bds x-example: "POST /20190531/bdsInstances//actions/removeKafka\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n\n{\n \"clusterAdminPassword\" : \"dGVzdDEyMw==\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveKafkaDetails' description: Details for the Kafka capability. required: true /bdsInstances/{bdsInstanceId}/actions/removeNode: post: description: 'Remove a single node of a Big Data Service cluster ' operationId: RemoveNode parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The node will be removed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Remove a Node tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveNodeDetails' description: Details for the node to be removed. required: true /bdsInstances/{bdsInstanceId}/actions/removeNodes: post: description: 'Removes list of nodes from a Big Data Service cluster ' operationId: RemoveNodes parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The list of nodes will be removed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Remove multiple Nodes tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveNodesDetails' description: Details for the list of nodes to be removed. required: true /bdsInstances/{bdsInstanceId}/actions/renewBdsCertificate: post: description: 'Renewing certificates under BDS cluster nodes. ' operationId: RenewBdsCertificate parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Workflow for renewing certificates is initiated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Renewing certificates under BDS cluster nodes. tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/RenewBdsCertificateDetails' description: Details for renewing BDS certificates. required: true /bdsInstances/{bdsInstanceId}/actions/renewOdhServiceCertificate: post: description: 'Renewing TLS/SSL for various ODH services running on the BDS cluster. ' operationId: RenewCertificate parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. Workflow for renewing TLS/SSL is initiated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Renewing TLS/SSL Encryption for ODH Services. tags: - bds x-example: "POST /20190531/bdsInstances//actions/renewOdhServiceCertificate\nHost: bigdataservice.us-ashburn-1.oci.oraclecloud.com\n\n{\n \"services\" : \"lakehouse\",\n \"clusterAdminPassword\" : \"dGVzdDEyMw==\",\n \"rootCertificate\" : \"root_certificate\",\n \"hostCertDetails\" : [{\n \"hostName\": \"host1\",\n \"certificate\": \"certificate1\",\n \"privateKey\": \"privatekey1\"\n }],\n \"serverKeyPassword\" : \"dGVzdDEyMw==\"\n}\n" x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/RenewCertificateDetails' description: Details for renewing certificate. required: true /bdsInstances/{bdsInstanceId}/actions/replaceNode: post: description: 'Replaces a node of a Big Data Service cluster from backup. ' operationId: ReplaceNode parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchBdsInstanceHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The node will be replaced. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Replace a failed node using its backup. tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ReplaceNodeDetails' description: Details for Replacing the node. required: true /bdsInstances/{bdsInstanceId}/actions/resetPassword: post: description: 'Admin function which allows the password reset of indicated service. ' operationId: BdsInstanceResetPassword parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: New password assigned to the requested service after the reset operation. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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 content: application/json: schema: $ref: '#/components/schemas/PasswordSummary' 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: Reset the indicated service's password. tags: - bds x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/BdsInstanceResetPasswordDetails' description: Parameters for resetting the admin password of the indicated component. required: true /bdsInstances/{bdsInstanceId}/actions/restartNode: post: description: 'Restarts a single node of a Big Data Service cluster ' operationId: RestartNode parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The node will be restarted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Restart a Node tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestartNodeDetails' description: Details for restarting the node. required: true /bdsInstances/{bdsInstanceId}/actions/start: post: description: 'Starts the BDS cluster that was stopped earlier. ' operationId: StartBdsInstance parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The BDS cluster will be started. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Starts the BDS cluster. tags: - bds x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartBdsInstanceDetails' description: Parameters for starting a cluster required: true /bdsInstances/{bdsInstanceId}/actions/stop: post: description: 'Stops the BDS cluster that can be started at later point of time. ' operationId: StopBdsInstance parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The BDS cluster will be stopped. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Stops the BDS cluster. tags: - bds x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/StopBdsInstanceDetails' description: Parameters for stopping a cluster required: true /bdsInstances/{bdsInstanceId}/apiKeys: get: description: 'Returns a list of all API keys associated with this Big Data Service cluster. ' operationId: ListBdsApiKeys parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/LifecycleStateBdsApiKeyQueryParam' - $ref: '#/components/parameters/UserIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of API keys associated with this Big Data Service cluster. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BdsApiKeySummary' 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: View all API keys associated with this Big Data Service cluster. tags: - bds x-related-resource: '#/definitions/BdsApiKey' post: description: 'Create an API key on behalf of the specified user. ' operationId: CreateBdsApiKey parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The API key will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Create a user API key. tags: - bds x-related-resource: '#/definitions/BdsApiKey' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBdsApiKeyDetails' description: Create a new user's API key. required: true /bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}: delete: description: Deletes the user's API key represented by the provided ID. operationId: DeleteBdsApiKey parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsApiKeyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The user's API key will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete a user's API key. tags: - bds x-related-resource: '#/definitions/BdsApiKey' get: description: Returns the user's API key information for the given ID. operationId: GetBdsApiKey parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsApiKeyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns information about the user's API key that corresponds to the provided 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BdsApiKey' 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: View user's API key information. tags: - bds /bdsInstances/{bdsInstanceId}/apiKeys/{apiKeyId}/actions/testObjectStorageConnection: post: description: Test access to specified Object Storage bucket using the API key. operationId: TestBdsObjectStorageConnection parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsApiKeyIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The connection with the specified bucket will be verified. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Test access to specified Object Storage bucket. tags: - bds x-related-resource: '#/definitions/BdsApiKey' requestBody: content: application/json: schema: $ref: '#/components/schemas/TestBdsObjectStorageConnectionDetails' description: Parameters required to validate access to the specified Object Storage bucket using the API key. required: true /bdsInstances/{bdsInstanceId}/autoScalingConfiguration: get: description: 'Returns information about the autoscaling configurations for a cluster. ' operationId: ListAutoScalingConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/AutoscaleLifecycleStateQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of autoscaling configurations. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/AutoScalingConfigurationSummary' 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: View Autoscale Configurations tags: - bds x-related-resource: '#/definitions/BdsInstance' post: description: 'Add an autoscale configuration to the cluster. ' operationId: AddAutoScalingConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The autoscaling will be configured. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Add an Autoscale Configuration to a Cluster tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddAutoScalingConfigurationDetails' description: Details for creating an autoscale configuration. required: true /bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId}: get: description: 'Returns details of the autoscale configuration identified by the given ID. ' operationId: GetAutoScalingConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the autoscaling configuration identified by 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AutoScalingConfiguration' 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/DefaultError' summary: View Details of an Autoscale Configuration tags: - bds x-related-resource: '#/definitions/BdsInstance' put: description: 'Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled. ' operationId: UpdateAutoScalingConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The autoscaling configuration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Modify an Autoscale Configuration tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAutoScalingConfigurationDetails' description: Details for update an autoscaling configuration. required: true /bdsInstances/{bdsInstanceId}/autoScalingConfiguration/{autoScalingConfigurationId}/actions/remove: post: description: 'Deletes an autoscale configuration. ' operationId: RemoveAutoScalingConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/AutoScalingConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The autoscale configuration will be removed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete an Autoscale Configuration tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveAutoScalingConfigurationDetails' description: Details for the autoscale configuration required: true /bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations: get: description: 'Returns a list of BDS certificate configurations associated with this Big Data Service cluster. ' operationId: ListBdsCertificateConfigurations parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/BdsCertificateConfigurationLifecycleStateQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of BDS certificate configurations associated with this Big Data Service cluster. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BdsCertificateConfigurationSummary' 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: View all BDS certificate configurations associated with this Big Data Service cluster. tags: - bds x-related-resource: '#/definitions/BdsCertificateConfiguration' post: description: 'Create a BDS certificate configuration for the cluster. ' operationId: CreateBdsCertificateConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request accepted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Create a BDS certificate configuration for the cluster. tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBdsCertificateConfigurationDetails' description: Details of creating BDS certificate configuration for the Big Data Service cluster. required: true /bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations/{bdsCertificateConfigurationId}: delete: description: Delete the BDS certificate configuration for the given ID. operationId: DeleteBdsCertificateConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsCertificateConfigurationIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The BDS certificate configuration will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete the BDS certificate configuration for the given ID. tags: - bds x-related-resource: '#/definitions/BdsCertificateConfiguration' get: description: 'Returns details of the BdsCertificateConfiguration identified by the given ID. ' operationId: GetBdsCertificateConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsCertificateConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the BdsCertificateConfiguration identified by 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BdsCertificateConfiguration' 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/DefaultError' summary: View Details of the indicated BdsCertificateConfiguration tags: - bds x-related-resource: '#/definitions/BdsCertificateConfiguration' /bdsInstances/{bdsInstanceId}/bdsCertificateConfigurations/{bdsCertificateConfigurationId}/actions/setDefault: post: description: 'Set specified BDS certificate configuration as default configuration. ' operationId: SetDefaultBdsCertificateConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsCertificateConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The bdsCertificateConfiguration will be set as Default. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Set specified BDS certificate configuration as default configuration. tags: - bds x-related-resource: '#/definitions/BdsCertificateConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/SetDefaultBdsCertificateConfigurationDetails' description: The request body when setting specified certificate configuration as default configuration. required: true /bdsInstances/{bdsInstanceId}/identityConfigurations: get: description: 'Returns a list of all identity configurations associated with this Big Data Service cluster. ' operationId: ListIdentityConfigurations parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IdentityConfigLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: A list of identityConfiguration summaries associated with this Big Data Service cluster. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/IdentityConfigurationSummary' 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: View all identity configurations associated with this Big Data Service cluster. tags: - bds x-related-resource: '#/definitions/IdentityConfiguration' post: description: Create an identity configuration for the cluster operationId: CreateIdentityConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The identity configuration will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Create an identity configuration for the cluster tags: - bds x-related-resource: '#/definitions/IdentityConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIdentityConfigurationDetails' description: Details for creating an identity configuration required: true /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}: delete: description: Delete the identity configuration represented by the provided ID. Deletion is only allowed if this identity configuration is not associated with any active IAM user sync configuration or UPST configuration. operationId: DeleteIdentityConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/IdentityConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The identity configuration will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete the specified identity configuration tags: - bds x-related-resource: '#/definitions/IdentityConfiguration' get: description: Get details of one identity config on the cluster operationId: GetIdentityConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/IdentityConfigurationIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Requested identity config associated with this Big Data Service cluster. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IdentityConfiguration' 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 details of one identity config on the cluster tags: - bds x-related-resource: '#/definitions/IdentityConfiguration' put: description: Update the IAM user sync and UPST configuration for the specified identity configuration operationId: UpdateIdentityConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/IdentityConfigurationIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The identity configuration will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the IAM user sync and UPST configuration for the specified identity configuration tags: - bds x-related-resource: '#/definitions/IdentityConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIdentityConfigurationDetails' description: Details for updating an identity configuration required: true /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/activateIamUserSyncConfiguration: post: description: Activate IAM user sync configuration for the given identity configuration operationId: ActivateIamUserSyncConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/IdentityConfigurationIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The IAM user sync config will be activated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Activate IAM user sync configuration for the given identity configuration tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/IdentityConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateIamUserSyncConfigurationDetails' description: Details for activating a new IAM user sync config. required: true /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/activateUpstConfiguration: post: description: Activate UPST configuration for the given identity configuration operationId: ActivateUpstConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/IdentityConfigurationIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The UPST config will be activated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Activate UPST configuration for the given identity configuration tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/IdentityConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateUpstConfigurationDetails' description: Details for activating UPST config required: true /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/deactivateIamUserSyncConfiguration: post: description: Deactivate the IAM user sync configuration. operationId: DeactivateIamUserSyncConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/IdentityConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The IAM user sync configuration will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Deactivate the specified IAM user sync configuration tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/IdentityConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeactivateIamUserSyncConfigurationDetails' description: Details for deactivating the IAM user sync config required: true /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/deactivateUpstConfiguration: post: description: Deactivate the UPST configuration represented by the provided ID. operationId: DeactivateUpstConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/IdentityConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The UPST configuration will be deactivated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Deactivate the specified UPST configuration tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/IdentityConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeactivateUpstConfigurationDetails' description: Details for deactivating the UPST config required: true /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/refreshConfidentialApplication: post: description: Refresh confidential application for the given identity configuration in case of any update to the confidential application (e.g. regenerated client secret) operationId: RefreshConfidentialApplication parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/IdentityConfigurationIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The UPST config will be activated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Refresh confidential application tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/IdentityConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/RefreshConfidentialApplicationDetails' description: Details for refreshing confidential application required: true /bdsInstances/{bdsInstanceId}/identityConfigurations/{identityConfigurationId}/actions/refreshUpstTokenExchangeKeytab: post: description: Refresh token exchange kerberos principal keytab for the UPST enabled identity configuration operationId: RefreshUpstTokenExchangeKeytab parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IdentityConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The keytab will be refreshed and updated as a new secret version in vault headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Refresh token exchange kerberos principal keytab for the UPST enabled identity configuration tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/IdentityConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/RefreshUpstTokenExchangeKeytabDetails' description: Details for refreshing User Principal Session (UPST) token exchange keytab required: true /bdsInstances/{bdsInstanceId}/metastoreConfigs: get: description: 'Returns a list of metastore configurations ssociated with this Big Data Service cluster. ' operationId: ListBdsMetastoreConfigurations parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsMetastoreTypeQueryParam' - $ref: '#/components/parameters/BdsMetastoreIdQueryParam' - $ref: '#/components/parameters/LifecycleStateBdsMetastoreQueryParam' - $ref: '#/components/parameters/BdsMetastoreApiKeyIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/DefaultDescSortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of metastore configurations associated with this Big Data Service cluster. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/BdsMetastoreConfigurationSummary' 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: View all metastore configurations associated with this Big Data Service cluster. tags: - bds x-related-resource: '#/definitions/BdsMetastoreConfiguration' post: description: 'Create and activate external metastore configuration. ' operationId: CreateBdsMetastoreConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The bdsMetastoreConfiguration will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Create and activate external metastore configuration. tags: - bds x-related-resource: '#/definitions/BdsMetastoreConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBdsMetastoreConfigurationDetails' description: The request body when creating and activating external metastore configuration. required: true /bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}: delete: description: Delete the BDS metastore configuration represented by the provided ID. operationId: DeleteBdsMetastoreConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsMetastoreConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The BDS metastore configuration will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete a BDS metastore configuration. tags: - bds x-related-resource: '#/definitions/BdsMetastoreConfiguration' get: description: Returns the BDS Metastore configuration information for the given ID. operationId: GetBdsMetastoreConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsMetastoreConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns information about the BDS Metastore configuration that corresponds to the provided 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BdsMetastoreConfiguration' 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: View BDS Metastore configuration information. tags: - bds x-related-resource: '#/definitions/BdsMetastoreConfiguration' put: description: Update the BDS metastore configuration represented by the provided ID. operationId: UpdateBdsMetastoreConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsMetastoreConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The BDS metastore configuration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Update a BDS metastore configuration. tags: - bds x-related-resource: '#/definitions/BdsMetastoreConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBdsMetastoreConfigurationDetails' description: Request body for updating BDS metastore configuration. required: true /bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}/actions/activate: post: description: 'Activate specified metastore configuration. ' operationId: ActivateBdsMetastoreConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsMetastoreConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The bdsMetastoreConfiguration will be activated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Activate specified metastore configuration. tags: - bds x-related-resource: '#/definitions/BdsMetastoreConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateBdsMetastoreConfigurationDetails' description: The request body when activating specified metastore configuration. required: true /bdsInstances/{bdsInstanceId}/metastoreConfigs/{metastoreConfigId}/actions/test: post: description: 'Test specified metastore configuration. ' operationId: TestBdsMetastoreConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/BdsMetastoreConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The bdsMetastoreConfiguration will be tested. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Test specified metastore configuration. tags: - bds x-related-resource: '#/definitions/BdsMetastoreConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/TestBdsMetastoreConfigurationDetails' description: Request body for testing BDS metastore configuration. required: true /bdsInstances/{bdsInstanceId}/nodeBackupConfigurations: get: description: 'Returns information about the NodeBackupConfigurations. ' operationId: ListNodeBackupConfigurations parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NodeBackupConfigurationLifecycleStateQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of NodeBackupConfigurations. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/NodeBackupConfigurationSummary' 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: View the list of NodeBackupConfigurations tags: - bds x-related-resource: '#/definitions/BdsInstance' post: description: 'Add a node volume backup configuration to the cluster for an indicated node type or node. ' operationId: CreateNodeBackupConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The NodeBackupConfigurationDetails will be added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Add a nodeBackupConfiguration to the indicated BDS Cluster for an indicated node type or node. tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodeBackupConfigurationDetails' description: Details for adding nodeBackupConfiguration to the BDS cluster. required: true /bdsInstances/{bdsInstanceId}/nodeBackupConfigurations/{nodeBackupConfigurationId}: delete: description: Delete the NodeBackupConfiguration represented by the provided ID. operationId: DeleteNodeBackupConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/NodeBackupConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The NodeBackupConfiguration will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete a NodeBackupConfiguration tags: - bds x-related-resource: '#/definitions/NodeBackupConfiguration' get: description: 'Returns details of the NodeBackupConfiguration identified by the given ID. ' operationId: GetNodeBackupConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/NodeBackupConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the NodeBackupConfiguration identified by 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NodeBackupConfiguration' 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/DefaultError' summary: View Details of the indicated NodeBackupConfiguration tags: - bds x-related-resource: '#/definitions/BdsInstance' put: description: 'Updates fields on NodeBackupConfiguration, including the name, the schedule. ' operationId: UpdateNodeBackupConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/NodeBackupConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The NodeBackupConfigurationDetails will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Modify a NodeBackupConfiguration tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodeBackupConfigurationDetails' description: Details for updating the NodeBackupConfiguration. required: true /bdsInstances/{bdsInstanceId}/nodeBackups: get: description: 'Returns information about the node Backups. ' operationId: ListNodeBackups parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NodeHostNameQueryParam' - $ref: '#/components/parameters/NodeBackupLifecycleStateQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NodeBackupDisplayNameQueryParam' responses: 200: description: A list of nodeBackups. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/NodeBackupSummary' 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: View List of NodeBackups tags: - bds x-related-resource: '#/definitions/BdsInstance' /bdsInstances/{bdsInstanceId}/nodeBackups/{nodeBackupId}: delete: description: Delete the NodeBackup represented by the provided ID. operationId: DeleteNodeBackup parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/NodeBackupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The NodeBackup will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete a NodeBackup tags: - bds x-related-resource: '#/definitions/NodeBackup' get: description: 'Returns details of NodeBackup identified by the given ID. ' operationId: GetNodeBackup parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/NodeBackupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves a nodeBackup identified by 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NodeBackup' 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/DefaultError' summary: View Details of NodeBackup tags: - bds x-related-resource: '#/definitions/BdsInstance' /bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations: get: description: 'Returns information about the NodeReplaceConfiguration. ' operationId: ListNodeReplaceConfigurations parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NodeReplaceConfigurationLifecycleStateQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of NodeReplaceConfigurations. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/NodeReplaceConfigurationSummary' 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: View the list of NodeReplaceConfigurations tags: - bds x-related-resource: '#/definitions/BdsInstance' post: description: 'Add a nodeReplaceConfigurations to the cluster. ' operationId: CreateNodeReplaceConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The NodeReplaceConfigurationDetails will be added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Add nodeReplaceConfiguration to the BDS Cluster for a node type. tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNodeReplaceConfigurationDetails' description: Details for adding nodeReplaceConfiguration to the BDS cluster. required: true /bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId}: get: description: 'Returns details of the nodeReplaceConfiguration identified by the given ID. ' operationId: GetNodeReplaceConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/NodeReplaceConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the NodeReplaceConfigurations identified by 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NodeReplaceConfiguration' 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/DefaultError' summary: View Details of the indicated nodeReplaceConfiguration tags: - bds x-related-resource: '#/definitions/BdsInstance' put: description: 'Updates fields on nodeReplaceConfigurations, including the name, the schedule ' operationId: UpdateNodeReplaceConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/NodeReplaceConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The NodeReplaceConfiguration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Modify a nodeReplaceConfigurations tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNodeReplaceConfigurationDetails' description: Details for updating the nodeReplaceConfiguration. required: true /bdsInstances/{bdsInstanceId}/nodeReplaceConfigurations/{nodeReplaceConfigurationId}/actions/remove: post: description: 'Deletes a nodeReplaceConfiguration ' operationId: RemoveNodeReplaceConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/NodeReplaceConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The NodeReplaceConfiguration will be removed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete a nodeReplaceConfiguration tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/NodeReplaceConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveNodeReplaceConfigurationDetails' description: Details for removing NodeReplaceConfiguration required: true /bdsInstances/{bdsInstanceId}/patchHistory: get: description: 'List the patch history of this cluster. ' operationId: ListPatchHistories parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/LifecycleStatePatchQueryParam' - $ref: '#/components/parameters/PatchVersionQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/DefaultDescSortOrderQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PatchTypeQueryParam' responses: 200: description: A list with the patch history of this cluster. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/PatchHistorySummary' 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 the patch history of this cluster. tags: - bds x-related-resource: '#/definitions/BdsInstance' /bdsInstances/{bdsInstanceId}/patches: get: description: 'List all the available patches for this cluster. ' operationId: ListPatches parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: A list of available patches for this cluster. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/PatchSummary' 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 the available patches for this cluster. tags: - bds x-related-resource: '#/definitions/BdsInstance' /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations: get: description: 'Returns information about the ResourcePrincipalConfiguration. ' operationId: ListResourcePrincipalConfigurations parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ResourcePrincipalConfigurationLifecycleStateQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of ResourcePrincipalConfigurations. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ResourcePrincipalConfigurationSummary' 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: View the list of ResourcePrincipalConfigurations tags: - bds x-related-resource: '#/definitions/BdsInstance' post: description: 'Create a resource principal session token configuration. ' operationId: CreateResourcePrincipalConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request accepted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Create a resource principal configuration for the cluster. tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateResourcePrincipalConfigurationDetails' description: Details of creating resource principal session token for the bds cluster. required: true /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}: get: description: 'Returns details of the resourcePrincipalConfiguration identified by the given ID. ' operationId: GetResourcePrincipalConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/ResourcePrincipalConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the ResourcePrincipalConfiguration identified by 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ResourcePrincipalConfiguration' 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/DefaultError' summary: View Details of the indicated resourcePrincipalConfiguration tags: - bds x-related-resource: '#/definitions/BdsInstance' put: description: 'Updates fields on resourcePrincipalConfiguration, including the name, the lifeSpanInHours of the token. ' operationId: UpdateResourcePrincipalConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/ResourcePrincipalConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The ResourcePrincipalConfiguration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Modify a resourcePrincipalConfiguration tags: - bds x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateResourcePrincipalConfigurationDetails' description: Details for updating the resourcePrincipalConfiguration. required: true ? /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}/actions/forceRefreshResourcePrincipal : post: description: 'Force Refresh Resource Principal for the cluster. ' operationId: ForceRefreshResourcePrincipal parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/ResourcePrincipalConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Request accepted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Force Refresh Resource Principal for the cluster. tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/BdsInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ForceRefreshResourcePrincipalDetails' description: Details of refreshing resource principal session token required: true /bdsInstances/{bdsInstanceId}/resourcePrincipalConfigurations/{resourcePrincipalConfigurationId}/actions/remove: post: description: 'Delete the resource principal configuration for the cluster. ' operationId: RemoveResourcePrincipalConfiguration parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/ResourcePrincipalConfigurationIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Request accepted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this 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/DefaultError' summary: Delete a ResourcePrincipalConfiguration. tags: - bds x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ResourcePrincipalConfiguration' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveResourcePrincipalConfigurationDetails' description: Details of removing a resource principal for the bds cluster. required: true /bdsInstances/{bdsInstanceId}/softwareUpdates: get: description: List all the available software updates for current cluster. operationId: ListSoftwareUpdates parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParamSplat' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/DefaultDescSortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The collection of all available software updates. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SoftwareUpdateCollection' 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' tags: - bds x-related-resource: '#/definitions/BdsInstance' /bdsInstances/{bdsInstanceId}/softwareUpdates/{softwareUpdateKey}: get: description: 'Get the details of the software update of the given SoftwareUpdateId ' operationId: GetSoftwareUpdate parameters: - $ref: '#/components/parameters/BdsInstanceIdPathParam' - $ref: '#/components/parameters/SoftwareUpdateKeyParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Details of the given software update. 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 request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SoftwareUpdate' 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' tags: - bds x-related-resource: '#/definitions/BdsInstance' /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequest' 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 Work Requests tags: - bds x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Returns the status of the work request identified by 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 request, provide this request ID. ' schema: type: string retry-after: description: 'A non-negative integer number representing the number of seconds the client should wait before polling this endpoint again. ' schema: type: number format: int32 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: View the Status of a Work Request tags: - bds x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a paginated list of errors for a work request identified by the given ID. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' 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 request, provide this 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: List Work Request Errors tags: - bds x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a paginated list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' 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 request, provide this request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkRequestLogEntry' 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 Work Request Logs tags: - bds x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: NodeTypeShapeConfig: description: Shape configuration at node type level. Start cluster will start all nodes as is if no config is specified. properties: nodeType: description: The Big Data Service cluster node type. type: string x-obmcs-enumref: '#/definitions/Node/nodeType' shape: description: "Shape of the node. This has to be specified when starting the cluster. Defaults to wn0 for homogeneous clusters and remains empty for heterogeneous clusters. \nIf provided, all nodes in the node type will adopt the specified shape; otherwise, nodes retain their original shapes.\n" maxLength: 255 minLength: 1 type: string required: - nodeType - shape type: object BackupNodeDetails: description: The information about the nodes to backup. properties: backupType: default: FULL description: Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created. type: string x-obmcs-enumref: '#/definitions/NodeBackup/backupType' levelTypeDetails: $ref: '#/components/schemas/LevelTypeDetails' required: - levelTypeDetails TestBdsObjectStorageConnectionDetails: description: Test access to specified Object Storage bucket using the API key. properties: objectStorageRegion: description: The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 . maxLength: 16 minLength: 1 type: string objectStorageUri: description: An Oracle Cloud Infrastructure URI to which this connection must be attempted. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. minLength: 1 type: string passphrase: description: Base64 passphrase used to secure the private key which will be created on user behalf. format: password maxLength: 255 minLength: 1 type: string required: - objectStorageUri - passphrase type: object ManageBdsCertificateLevelTypeDetails: description: Details of the type of level used to trigger certificate generation or renewal. discriminator: propertyName: triggerType properties: triggerType: description: Type of level used to trigger certificate generation or renewal. enum: - NODE_LEVEL - CONFIG_LEVEL type: string required: - triggerType type: object OsPatchPackageSummary: description: Summary of a package contained in a os patch. properties: packageName: description: The package's name. type: string packageType: description: Package type based on package installation manager. enum: - RPM - PIP - PIP3 - PIP3_8 type: string relatedCVEs: description: Related CVEs of the package update. items: type: string type: array targetVersion: description: The target version of the package. type: string updateType: description: The action that current package will be executed on the cluster. enum: - INSTALL - REMOVE - UPDATE type: string required: - packageName - updateType - relatedCVEs type: object DeactivateUpstConfigurationDetails: description: Details for deleting UPST config from cluster properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object RemoveCloudSqlDetails: description: The information about the Cloud SQL installation that was removed. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 1 type: string type: object HostSpecificCertificateDetails: description: Host specific certificate details properties: certificateType: description: Type of certificate self signed or CA signed enum: - CUSTOM_SIGNED - SELF_SIGNED type: string hostName: description: Name of the host. maxLength: 1024 minLength: 1 type: string timeExpiry: description: The time the certificate expires, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string type: object AddAutoScalingConfigurationDetails: description: The information about the autoscale configuration. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 8 type: string displayName: description: A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string isEnabled: description: Whether the autoscale configuration is enabled. type: boolean nodeType: description: A node type that is managed by an autoscale configuration. The only supported types are WORKER and COMPUTE_ONLY_WORKER. type: string x-obmcs-enumref: '#/definitions/Node/nodeType' policy: $ref: '#/components/schemas/AutoScalePolicy' policyDetails: $ref: '#/components/schemas/AddAutoScalePolicyDetails' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - isEnabled - nodeType type: object ForceRefreshResourcePrincipalDetails: description: Force Refresh Resource Principal Session Token Details. properties: clusterAdminPassword: description: Base-64 encoded Cluster Admin Password for cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object UpdateResourcePrincipalConfigurationDetails: description: Details of updating the resource principal configuration for the cluster. properties: displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string sessionTokenLifeSpanDurationInHours: description: Life span in hours for the resource principal session token. format: int32 maximum: 12 minimum: 1 type: integer type: object NodeReplaceConfiguration: description: The information about the NodeReplaceConfiguration. properties: bdsInstanceId: description: The OCID of the bdsInstance which is the parent resource id. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string durationInMinutes: description: This value is the minimum period of time to wait for metric emission before triggering node replacement. The value is in minutes. type: integer id: description: The unique identifier for the NodeReplaceConfiguration. maxLength: 255 minLength: 1 type: string levelTypeDetails: $ref: '#/components/schemas/LevelTypeDetails' lifecycleState: description: The state of the NodeReplaceConfiguration. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string metricType: description: Type of compute instance health metric to use for node replacement enum: - INSTANCE_STATUS - INSTANCE_ACCESSIBILITY_STATUS type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the NodeReplaceConfiguration was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: 'The time the NodeReplaceConfiguration was updated, shown as an RFC 3339 formatted datetime string. ' example: 2020-04-29 09:36:42+00:00 format: date-time type: string required: - id - bdsInstanceId - displayName - lifecycleState - timeCreated - timeUpdated - metricType - durationInMinutes - levelTypeDetails type: object UpdateBdsMetastoreConfigurationDetails: description: The request body when updating BDS metastore configuration. properties: bdsApiKeyId: description: The ID of BDS Api Key used for Data Catalog metastore integration. Set only if metastore's type is EXTERNAL. maxLength: 255 minLength: 1 type: string bdsApiKeyPassphrase: description: Base-64 encoded passphrase of the BDS Api Key. format: password maxLength: 255 minLength: 1 type: string clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string displayName: description: The display name of the metastore configuration. maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object NodeBackupSummary: description: The information about the nodeBackupSummary. properties: backupTriggerType: description: type based on how backup action was initiated. type: string x-obmcs-enumref: '#/definitions/NodeBackup/backupTriggerType' backupType: description: Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created type: string x-obmcs-enumref: '#/definitions/NodeBackup/backupType' displayName: description: BDS generated name for the backup. Format is nodeHostName_timeCreated. type: string id: description: The id of the node backup. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of NodeBackup. type: string x-obmcs-enumref: '#/definitions/NodeBackup/lifecycleState' nodeHostName: description: Host name of the node that the backup belongs to. maxLength: 255 minLength: 8 type: string nodeInstanceId: description: The instance OCID of the node, which is the resource from which the node backup was acquired. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the cluster was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string required: - id - displayName - nodeInstanceId - nodeHostName - backupTriggerType - backupType - lifecycleState - timeCreated type: object IdentityConfigurationSummary: description: Summary of the identity config properties: displayName: description: Display name of the identity config type: string id: description: The id of the identity config maxLength: 255 minLength: 1 type: string lifecycleState: description: Lifecycle state of the identity config type: string x-obmcs-enumref: '#/definitions/IdentityConfiguration/lifecycleState' required: - id - lifecycleState - displayName type: object BdsMetastoreConfiguration: description: The metastore configuration information. properties: bdsApiKeyId: description: The ID of BDS API Key used for metastore configuration. Set only if metastore's type is EXTERNAL. maxLength: 255 minLength: 1 type: string displayName: description: The display name of metastore configuration maxLength: 255 minLength: 1 type: string id: description: The ID of the metastore configuration maxLength: 255 minLength: 1 type: string lifecycleState: description: the lifecycle state of the metastore configuration. enum: - CREATING - ACTIVATING - ACTIVE - INACTIVE - UPDATING - FAILED - DELETING - DELETED type: string metastoreId: description: The OCID of the Data Catalog metastore. Set only if metastore's type is EXTERNAL. maxLength: 255 minLength: 1 type: string metastoreType: description: The type of the metastore in the metastore configuration. enum: - LOCAL - EXTERNAL type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string timeCreated: description: The time when the configuration was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-28 09:36:42+00:00 format: date-time type: string timeUpdated: description: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string required: - id - displayName - metastoreType - lifecycleState - timeCreated type: object SoftwareUpdateSummary: description: The software update that is currently available for the cluster. properties: lifecycleState: description: The lifecycle state of the software update. type: string x-obmcs-enumref: '#/definitions/SoftwareUpdate/lifecycleState' softwareUpdateKey: description: Unique identifier of a given software update maxLength: 255 minLength: 1 type: string softwareUpdateType: description: Type of current software update. type: string x-obmcs-enumref: '#/definitions/SoftwareUpdate/softwareUpdateType' softwareUpdateVersion: description: The version of the software update. maxLength: 255 minLength: 1 type: string timeReleased: description: The time when the software update was released. example: '2020-03-29T09:36:42Z' format: date-time type: string required: - softwareUpdateKey - softwareUpdateVersion - timeReleased - softwareUpdateType - lifecycleState type: object PatchSummary: description: The patch that is currently available for the cluster. properties: timeReleased: description: The time when the patch was released. example: 2020-03-29 09:36:42+00:00 format: date-time type: string version: description: The version of the patch. maxLength: 255 minLength: 1 type: string required: - version - timeReleased type: object CreateBdsCapacityReportDetails: description: The data to create a report of available BDS capacity. properties: compartmentId: description: The OCID for the compartment. This should always be the root compartment. maxLength: 255 minLength: 1 type: string shapeAvailabilities: description: Information about the shapes in the capacity report. items: $ref: '#/components/schemas/CreateCapacityReportShapeAvailabilityDetails' type: array required: - compartmentId - shapeAvailabilities IamUserSyncConfiguration: description: Information about the IAM user sync configuration. properties: isPosixAttributesAdditionRequired: description: whether to append POSIX attributes to IAM users type: boolean lifecycleState: description: Lifecycle state of the IAM user sync config enum: - CREATING - ACTIVE - INACTIVE - DELETING - UPDATING - FAILED type: string timeCreated: description: Time when this IAM user sync config was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time minLength: 1 type: string timeUpdated: description: Time when this IAM user sync config was updated, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time minLength: 1 type: string required: - lifecycleState - isPosixAttributesAdditionRequired - timeCreated - timeUpdated type: object BdsInstance: description: Description of the cluster. properties: bdsClusterVersionSummary: $ref: '#/components/schemas/BdsClusterVersionSummary' bootstrapScriptUrl: description: pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed. maxLength: 1024 minLength: 1 type: string cloudSqlDetails: $ref: '#/components/schemas/CloudSqlDetails' clusterDetails: $ref: '#/components/schemas/ClusterDetails' clusterProfile: description: Profile of the Big Data Service cluster. enum: - HADOOP_EXTENDED - HADOOP - HIVE - SPARK - HBASE - TRINO - KAFKA type: string clusterVersion: description: Version of the Hadoop distribution. enum: - CDH5 - CDH6 - ODH1 - ODH0_9 - ODH2_0 type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string createdBy: description: The user who created the cluster. 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. For example, `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The name of the cluster. 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. For example, `{"bar-key": "value"}` ' type: object id: description: The OCID of the Big Data Service resource. maxLength: 255 minLength: 1 type: string isCloudSqlConfigured: default: false description: Boolean flag specifying whether or not Cloud SQL should be configured. type: boolean isHighAvailability: description: Boolean flag specifying whether or not the cluster is highly available (HA) type: boolean isKafkaConfigured: default: false description: Boolean flag specifying whether or not Kafka should be configured. type: boolean isSecretReused: default: false description: Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations. type: boolean isSecure: description: Boolean flag specifying whether or not the cluster should be set up as secure. type: boolean kmsKeyId: description: The OCID of the Key Management master encryption key. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the cluster. enum: - CREATING - ACTIVE - UPDATING - SUSPENDING - SUSPENDED - RESUMING - DELETING - DELETED - FAILED - INACTIVE type: string networkConfig: $ref: '#/components/schemas/NetworkConfig' nodes: description: The list of nodes in the cluster. items: $ref: '#/components/schemas/Node' type: array numberOfNodes: description: Number of nodes that forming the cluster format: int32 maximum: 8192 minimum: 1 type: integer numberOfNodesRequiringMaintenanceReboot: description: Number of nodes that require a maintenance reboot format: int32 maximum: 8192 minimum: 1 type: integer secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the cluster was created, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeEarliestCertificateExpiration: description: The earliest time of certificate expiration date across the certificates of all current nodes under this cluster. example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: The time the cluster was updated, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - isHighAvailability - isSecure - isCloudSqlConfigured - isKafkaConfigured - numberOfNodes - nodes type: object MetricThresholdRule: description: An autoscale action is triggered when a performance metric exceeds a threshold. properties: durationInMinutes: default: 30 description: This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes. maximum: 10080 minimum: 5 type: integer operator: description: The comparison operator to use. Options are greater than (GT) or less than (LT). enum: - GT - LT type: string value: description: Integer non-negative value. 0 < value < 100 maximum: 99 minimum: 1 type: integer required: - durationInMinutes - operator - value type: object iamUserSyncConfigurationDetails: description: Details for activating/updating an IAM user sync configuration properties: isPosixAttributesAdditionRequired: default: false description: whether posix attribute needs to be appended to users, required for updating IAM user sync configuration type: boolean type: object AutoScalePolicy: description: 'This model for autoscaling policy is deprecated and not supported for ODH clusters. Use the `AutoScalePolicyDetails` model to manage autoscale policy details for ODH clusters. ' properties: policyType: description: Types of autoscale policies. Options are SCHEDULE-BASED or THRESHOLD-BASED. (Only THRESHOLD-BASED is supported in this release.) enum: - THRESHOLD_BASED - SCHEDULE_BASED - NONE type: string rules: description: The list of rules for autoscaling. If an action has multiple rules, the last rule in the array will be applied. items: $ref: '#/components/schemas/AutoScalePolicyRule' type: array required: - policyType - rules type: object AddUtilityNodesDetails: description: The information about added utility nodes. properties: blockVolumeSizeInGBs: description: 'The size of block volume in GB to be attached to the given node. It''s a read-only property. ' format: int64 minimum: 150 type: integer clusterAdminPassword: description: Base-64 encoded Cluster Admin Password for cluster admin user. format: password maxLength: 255 minLength: 1 type: string numberOfUtilityNodes: description: Number of additional utility nodes for the cluster. format: int32 maximum: 1024 minimum: 1 type: integer secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string shape: description: Shape of the node. It's a read-only property derived from existing Utility node. maxLength: 255 minLength: 1 type: string shapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' required: - numberOfUtilityNodes type: object RemoveKafkaDetails: description: The information about the Kafka installation to be removed. All configured Kafka nodes are considered for removal. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object StartClusterShapeConfigs: description: The shape configuration to be used to start the cluster. If the value is not set, the start cluster operation will try to start the cluster as is. properties: nodeTypeShapeConfigs: description: Shape configurations for each node type. items: $ref: '#/components/schemas/NodeTypeShapeConfig' type: array required: - nodeTypeShapeConfigs type: object RefreshUpstTokenExchangeKeytabDetails: description: Details for refreshing User Principal Session (UPST) token exchange keytab properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object StopBdsInstanceDetails: description: The request body for stopping a BDS cluster. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string isForceStopJobs: default: false description: Boolean indicating whether to force stop jobs while stopping cluster. Defaults to false. type: boolean secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object UpstConfiguration: description: Information about the UPST configuration. properties: keytabContent: description: The kerberos keytab content used for creating identity propagation trust config, in base64 format type: string lifecycleState: description: Lifecycle state of the UPST config enum: - CREATING - ACTIVE - DELETING - INACTIVE - UPDATING - FAILED type: string masterEncryptionKeyId: description: Master Encryption key used for encrypting token exchange keytab. maxLength: 255 minLength: 1 type: string secretId: description: Secret ID for token exchange keytab maxLength: 255 minLength: 1 type: string timeCreated: description: Time when this UPST config was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time minLength: 1 type: string timeTokenExchangeKeytabLastRefreshed: description: Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time minLength: 1 type: string timeUpdated: description: Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time minLength: 1 type: string tokenExchangePrincipalName: description: Token exchange kerberos Principal name in cluster type: string vaultId: description: The instance OCID of the node, which is the resource from which the node backup was acquired. maxLength: 255 minLength: 1 type: string required: - vaultId - masterEncryptionKeyId - secretId - timeTokenExchangeKeytabLastRefreshed - keytabContent - lifecycleState - timeCreated - timeUpdated type: object NetworkConfig: description: Additional configuration of the user's network. properties: cidrBlock: description: The CIDR IP address block of the VCN. example: 172.16.0.0/16 maxLength: 32 minLength: 1 type: string isNatGatewayRequired: description: A boolean flag whether to configure a NAT gateway. type: boolean type: object ChangeShapeDetails: description: Resize details specified for individual nodes. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 1 type: string nodes: $ref: '#/components/schemas/ChangeShapeNodes' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - nodes type: object RemoveResourcePrincipalConfigurationDetails: description: Details of removing a resource principal configuration for the cluster. properties: clusterAdminPassword: description: Base-64 encoded Cluster Admin Password for cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object SoftwareUpdate: description: Details about the given software update. discriminator: propertyName: softwareUpdateType properties: lifecycleState: description: The lifecycle state of the software update. enum: - WAITING - IN_PROGRESS - SUCCEEDED - FAILED - CANCELED type: string softwareUpdateKey: description: Unique identifier of a given software update maxLength: 255 minLength: 1 type: string softwareUpdateType: description: 'type of current software update. - Big Data Service''s micro service. BDS version will be changed after upgrade. ' enum: - BDS type: string softwareUpdateVersion: description: The version of the software update. maxLength: 255 minLength: 1 type: string timeReleased: description: The time when the software update was released. example: '2020-03-29T09:36:42Z' format: date-time type: string required: - softwareUpdateKey - softwareUpdateVersion - timeReleased - softwareUpdateType - lifecycleState type: object CreateNodeDetails: description: The information about the new node. properties: blockVolumeSizeInGBs: description: 'The size of block volume in GB to be attached to a given node. All the details needed for attaching the block volume are managed by service itself. ' format: int64 minimum: 150 type: integer nodeType: description: The Big Data Service cluster node type. type: string x-obmcs-enumref: '#/definitions/Node/nodeType' shape: description: Shape of the node. maxLength: 255 minLength: 1 type: string shapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' subnetId: description: The OCID of the subnet in which the node will be created. maxLength: 255 minLength: 1 type: string required: - nodeType - shape - blockVolumeSizeInGBs - subnetId type: object CertificateServiceInfoDetails: description: Details for certificate service info properties: services: description: List of services for which TLS/SSL needs to be enabled. items: $ref: '#/components/schemas/Service' type: array required: - services type: object CreateCapacityReportShapeAvailabilityDetails: description: Information about the shapes in a capacity report. properties: shape: description: The shape that you want to request a capacity report for. type: string shapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' required: - shape Service: description: The type of service. enum: - ZOOKEEPER - AMS - HDFS - YARN - MAPREDUCE - OOZIE - HBASE - SPARK - HIVE - KAFKA - FLINK - REGISTRY type: string ActivateIamUserSyncConfigurationDetails: description: Details for activating IAM user sync configuration properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string isPosixAttributesAdditionRequired: default: false description: whether posix attribute needs to be appended to users type: boolean secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object OsPatchDetails: description: Details of an os patch. properties: minBdsVersion: description: Minimum BDS version required to install current OS patch. type: string minCompatibleOdhVersionMap: additionalProperties: type: string description: 'Map of major ODH version to minimum ODH version required to install current OS patch. e.g. {ODH0.9: 0.9.1} ' properties: odhType: description: Type of hadoop distribution. type: string required: - odhType type: object osPatchVersion: description: Version of the os patch. type: string patchType: description: 'Type of a specific os patch. REGULAR means standard released os patches. CUSTOM means os patches with some customizations. EMERGENT means os patches with some emergency fixes that should be prioritized. ' enum: - REGULAR - CUSTOM - EMERGENT type: string releaseDate: description: Released date of the OS patch. example: 2023-03-01 09:36:42+00:00 format: date-time type: string targetPackages: description: List of summaries of individual target packages. items: $ref: '#/components/schemas/OsPatchPackageSummary' type: array required: - osPatchVersion - minBdsVersion - minCompatibleOdhVersionMap - releaseDate - targetPackages - patchType type: object InstallOsPatchDetails: description: Os patch details for installing a os patches to a cluster. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string isDryRun: default: false description: Perform dry run for the patch and stop. type: boolean osPatchVersion: description: The target os patch version. type: string patchingConfigs: $ref: '#/components/schemas/PatchingConfigs' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - osPatchVersion type: object BdsCertificateConfiguration: description: The BDS certificate configuration information. properties: bdsInstanceId: description: The OCID of the bdsInstance which is the parent resource id. maxLength: 255 minLength: 1 type: string certificateAuthorityId: description: The OCID of the certificate authority which is associated with this certificate configuration. The value is Null when this BDS certificate configuration type is SELF_SIGNED. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment of the certificate authority connecting to this certificate configuration. maxLength: 255 minLength: 1 type: string displayName: description: The display name of the BDS certificate configuration. maxLength: 50 minLength: 1 type: string id: description: The ID of the BDS certificate configuration defined under BDS resources, not OCID. maxLength: 255 minLength: 1 type: string isDefaultConfiguration: description: If this BDS certificate configuration is a default configuration or not. There will be only one Default certificate configuration per BDS cluster. type: boolean lifecycleState: description: The lifecycle status of the BDS certificate configuration. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED type: string timeCreated: description: The time when the BDS certificate configuration was created, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeLastRefreshedOrGenerated: description: The last time the BDS certificate configuration was used to generate or renew the certificate(s). example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: The time the BDS certificate configuration was updated, shown as an RFC 3339 formatted datetime string. example: 2020-04-29 09:36:42+00:00 format: date-time type: string type: description: The type of the BDS certificate configuration, also the type of the BDS certificates which will be generated by the BDS certificate configuration. enum: - SELF_SIGNED - OCI_CERTIFICATE type: string required: - lifecycleState - displayName - timeCreated - timeUpdated - type - bdsInstanceId - id - isDefaultConfiguration type: object AddAutoScalePolicyDetails: description: 'Policy definition for the autoscale configuration. An autoscaling policy is part of an autoscaling configuration. For more information, see [Autoscaling](/iaas/Content/bigdata/create-cluster.htm#cluster-autoscale) You can create following type of autoscaling policies: - **MetricBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered when a performance metric exceeds a threshold - **MetricBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered when a performance metric exceeds a threshold - **ScheduleBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered at the specific times that you schedule. - **ScheduleBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered at the specific times that you schedule. An autoscaling configuration can have one of above supported policies. ' discriminator: propertyName: policyType properties: policyType: description: Type of autoscaling policy. type: string x-obmcs-enumref: '#/definitions/AutoScalePolicyDetails/policyType' required: - policyType type: object CreateIdentityConfigurationDetails: description: Details for creating the identity configuration. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string confidentialApplicationId: description: Identity domain confidential application ID for the identity config, required for creating identity configuration maxLength: 255 minLength: 1 type: string displayName: description: Display name of the identity configuration, required for creating identity configuration. maxLength: 255 minLength: 1 type: string iamUserSyncConfigurationDetails: $ref: '#/components/schemas/iamUserSyncConfigurationDetails' identityDomainId: description: Identity domain OCID to use for identity config, required for creating identity configuration maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string upstConfigurationDetails: $ref: '#/components/schemas/upstConfigurationDetails' required: - displayName - identityDomainId - confidentialApplicationId type: object BdsCertificateConfigurationSummary: description: Summary details of the BDS certificate configuration. properties: bdsInstanceId: description: The OCID of the bdsInstance which is the parent resource id. maxLength: 255 minLength: 1 type: string certificateAuthorityId: description: The OCID of the certificate authority which is associated with this certificate configuration. The value is Null when this BDS certificate configuration type is SELF_SIGNED. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment of the certificate authority connecting to this certificate configuration. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. For example, `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The display name of BDS certificate configuration. maxLength: 50 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. For example, `{"bar-key": "value"}` ' type: object id: description: The ID of the BDS certificate configuration defined under BDS resources, not OCID. maxLength: 255 minLength: 1 type: string isDefaultConfiguration: description: If this BDS certificate configuration is a default configuration or not. There will be only one Default certificate configuration per BDS cluster. type: boolean lifecycleState: description: The lifecycle status of the BDS certificate configuration. type: string x-obmcs-enumref: '#/definitions/BdsCertificateConfiguration/lifecycleState' timeCreated: description: The time when the BDS certificate configuration was created, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeLastRefreshedOrGenerated: description: The last time the BDS certificate configuration was used to generate or renew the certificate(s). example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: The time the BDS certificate configuration was updated, shown as an RFC 3339 formatted datetime string. example: 2020-04-29 09:36:42+00:00 format: date-time type: string type: description: The type of the BDS certificate configuration, also the type of the BDS certificates which will be generated by the BDS certificate configuration. type: string x-obmcs-enumref: '#/definitions/BdsCertificateConfiguration/type' required: - lifecycleState - type - id - isDefaultConfiguration type: object NodeBackupConfigurationSummary: description: The information about the NodeBackupConfiguration. properties: bdsInstanceId: description: The OCID of the bdsInstance which is the parent resource id. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string id: description: The id of the NodeBackupConfiguration defined under BDS resources, not OCID. maxLength: 255 minLength: 1 type: string levelTypeDetails: $ref: '#/components/schemas/LevelTypeDetails' lifecycleState: description: The state of the NodeBackupConfiguration. type: string x-obmcs-enumref: '#/definitions/NodeBackupConfiguration/lifecycleState' timeCreated: description: The time the NodeBackupConfiguration was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: 'The time the NodeBackupConfiguration was updated, shown as an RFC 3339 formatted datetime string. ' example: 2020-04-29 09:36:42+00:00 format: date-time type: string required: - id - bdsInstanceId - displayName - lifecycleState - timeCreated - timeUpdated - levelTypeDetails type: object RenewBdsCertificateDetails: description: Request body for renewing certificates. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string manageCertificateLevelTypeDetails: $ref: '#/components/schemas/ManageBdsCertificateLevelTypeDetails' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - manageCertificateLevelTypeDetails DeactivateIamUserSyncConfigurationDetails: description: Details for deactivating an IAM user sync configuration properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object BdsInstanceSummary: description: Summary details of the Big Data Service cluster. properties: clusterProfile: description: Profile of the Big Data Service cluster. type: string x-obmcs-enumref: '#/definitions/BdsInstance/clusterProfile' clusterVersion: description: Version of the Hadoop distribution. type: string x-obmcs-enumref: '#/definitions/BdsInstance/clusterVersion' compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. For example, `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: The name of the cluster. 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. For example, `{"bar-key": "value"}` ' type: object id: description: The OCID of the Big Data Service resource. maxLength: 255 minLength: 1 type: string isCloudSqlConfigured: default: false description: Boolean flag specifying whether Cloud SQL is configured or not. type: boolean isHighAvailability: description: Boolean flag specifying whether or not the cluster is highly available(HA). type: boolean isKafkaConfigured: default: false description: Boolean flag specifying whether Kafka is configured or not. type: boolean isSecure: description: Boolean flag specifying whether or not the cluster should be set up as secure. type: boolean lifecycleState: description: The state of the cluster. type: string x-obmcs-enumref: '#/definitions/BdsInstance/lifecycleState' numberOfNodes: description: The number of nodes that form the cluster. format: int32 maximum: 8192 minimum: 1 type: integer numberOfNodesRequiringMaintenanceReboot: description: Number of nodes that require a maintenance reboot format: int32 maximum: 8192 minimum: 1 type: integer timeCreated: description: The time the cluster was created, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeEarliestCertificateExpiration: description: The earliest time of certificate expiration date across the certificates of all current nodes under this cluster. example: 2019-03-29 09:36:42+00:00 format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - isCloudSqlConfigured - isKafkaConfigured - numberOfNodes - isHighAvailability - isSecure - timeCreated type: object InstallPatchDetails: description: The reqeust body while installing a patch to a cluster. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string patchingConfig: $ref: '#/components/schemas/OdhPatchingConfig' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string version: description: The version of the patch to be installed. maxLength: 255 minLength: 1 type: string required: - version type: object DefaultError: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. maxLength: 255 minLength: 1 type: string message: description: A human-readable error string. maxLength: 1024 minLength: 1 type: string required: - code - message AutoScalePolicyRule: description: A rule that defines a specific autoscale action to take and the metric that triggers that action. properties: action: description: The valid value are CHANGE_SHAPE_SCALE_UP or CHANGE_SHAPE_SCALE_DOWN. enum: - CHANGE_SHAPE_SCALE_UP - CHANGE_SHAPE_SCALE_DOWN type: string metric: $ref: '#/components/schemas/AutoScalePolicyMetricRule' required: - action - metric type: object NodeReplaceConfigurationSummary: description: The information about the NodeReplaceConfigurationSummary. properties: bdsInstanceId: description: The OCID of the bdsInstance which is the parent resource id. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string id: description: The id of the NodeReplaceConfiguration defined under BDS resources, not OCID. maxLength: 255 minLength: 1 type: string levelTypeDetails: $ref: '#/components/schemas/LevelTypeDetails' lifecycleState: description: The state of the NodeReplaceConfiguration. type: string x-obmcs-enumref: '#/definitions/NodeReplaceConfiguration/lifecycleState' timeCreated: description: The time the NodeReplaceConfiguration was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: 'The time the NodeReplaceConfiguration was updated, shown as an RFC 3339 formatted datetime string. ' example: 2020-04-29 09:36:42+00:00 format: date-time type: string required: - id - bdsInstanceId - displayName - lifecycleState - timeCreated - timeUpdated - levelTypeDetails type: object UpdateBdsInstanceDetails: description: The information about to-be-updated Big Data Service cluster. properties: bootstrapScriptUrl: description: Pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed.. maxLength: 1024 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. For example, `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name of the cluster. 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. For example, `{"bar-key": "value"}` ' type: object isSecretReused: default: false description: Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations. type: boolean kmsKeyId: description: The OCID of the Key Management master encryption key. maxLength: 255 minLength: 1 type: string networkConfig: $ref: '#/components/schemas/NetworkConfig' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object TestBdsMetastoreConfigurationDetails: description: The reqeust body when testing a BDS metastore configuration properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object CapacityReportShapeAvailability: description: Detailed information about the availabilities of a shape in each domain. properties: domainLevelCapacityReports: description: Information about the capacity in each domain. items: $ref: '#/components/schemas/DomainTypeCapacityReport' maxItems: 3 type: array shape: description: The shape that the capacity report was requested for. type: string shapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' required: - shape - domainLevelCapacityReports AddWorkerNodesDetails: description: The information about added nodes. properties: blockVolumeSizeInGBs: description: 'The size of block volume in GB to be attached to the given node. This has to be specified when adding compute only worker or edge node at the first time. For EDGE nodes. Each node can have a different block storage size within the valid range (50GB-10TB) and the value must be specified. ' format: int64 minimum: 150 type: integer clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 1 type: string nodeType: description: Worker node types, can either be Worker Data node or Compute only worker node. enum: - WORKER - COMPUTE_ONLY_WORKER - EDGE - KAFKA_BROKER type: string numberOfWorkerNodes: description: Number of additional worker nodes for the cluster. format: int32 maximum: 1024 minimum: 1 type: integer secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string shape: description: Shape of the node. This has to be specified when adding compute only worker node at the first time. Otherwise, it's a read-only property. maxLength: 255 minLength: 1 type: string shapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' required: - numberOfWorkerNodes - nodeType type: object ShapeConfigDetails: description: The shape configuration requested for the node. properties: memoryInGBs: description: The total amount of memory available to the node, in gigabytes. minimum: 15 type: integer nvmes: description: The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. maximum: 4 minimum: 1 type: integer ocpus: description: The total number of OCPUs available to the node. minimum: 1 type: integer type: object RefreshConfidentialApplicationDetails: description: Details for refreshing confidential application properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object InstallSoftwareUpdatesDetails: description: Details for installing a software update to a cluster. properties: softwareUpdateKeys: description: A list of unique identifiers of target software updates. items: type: string type: array required: - softwareUpdateKeys type: object ChangeShapeNodes: description: Individual worker nodes groups details. properties: cloudsql: description: Change shape of the Cloud SQL node to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here. maxLength: 255 minLength: 1 type: string cloudsqlShapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' computeOnlyWorker: description: Change shape of compute only worker nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here. maxLength: 255 minLength: 1 type: string computeOnlyWorkerShapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' edge: description: Change shape of edge nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here. maxLength: 255 minLength: 1 type: string edgeShapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' kafkaBroker: description: Change shape of Kafka Broker nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here. maxLength: 255 minLength: 1 type: string kafkaBrokerShapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' master: description: Change shape of master nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here. maxLength: 255 minLength: 1 type: string masterShapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' utility: description: Change shape of utility nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here. maxLength: 255 minLength: 1 type: string utilityShapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' worker: description: Change shape of worker nodes to the desired target shape. Both VM_STANDARD and E4 Flex shapes are allowed here. maxLength: 255 minLength: 1 type: string workerShapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' type: object EnableCertificateDetails: description: The request body info about configure certificate service list. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string hostCertDetails: description: List of leaf certificates to use for services on each host. If custom host certificate is provided the root certificate becomes required. items: $ref: '#/components/schemas/HostCertDetails' type: array rootCertificate: description: Plain text certificate/s in order, separated by new line character. If not provided in request a self-signed root certificate is generated inside the cluster. In case hostCertDetails is provided, root certificate is mandatory. type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string serverKeyPassword: description: Base-64 encoded password for CA certificate's private key. This value can be empty. format: password type: string services: description: List of services for which certificate needs to be enabled. items: $ref: '#/components/schemas/Service' type: array required: - services type: object UpdateAutoScalePolicyDetails: description: Update details of an autoscaling policy. discriminator: propertyName: policyType properties: policyType: description: Type of autoscaling policy. type: string x-obmcs-enumref: '#/definitions/AutoScalePolicyDetails/policyType' required: - policyType type: object BdsApiKeySummary: description: The API key summary. properties: defaultRegion: description: 'The name of the region to establish the Object Storage endpoint which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 . ' maxLength: 16 minLength: 1 type: string id: description: Identifier of the user's API key. maxLength: 255 minLength: 1 type: string keyAlias: description: 'User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The current status of the API key. type: string x-obmcs-enumref: '#/definitions/BdsApiKey/lifecycleState' timeCreated: description: The time the API key was created, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string required: - id - keyAlias - lifecycleState - defaultRegion - timeCreated type: object upstConfigurationDetails: description: Details for activating/updating UPST config on the cluster properties: masterEncryptionKeyId: description: OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for activating UPST config maxLength: 255 minLength: 1 type: string vaultId: description: OCID of the vault to store token exchange service principal keyta, required for activating UPST config maxLength: 255 minLength: 1 type: string type: object CreateBdsMetastoreConfigurationDetails: description: The request body when creating BDS metastore configuration. properties: bdsApiKeyId: description: The ID of BDS Api Key used for Data Catalog metastore integration. maxLength: 255 minLength: 1 type: string bdsApiKeyPassphrase: description: Base-64 encoded passphrase of the BDS Api Key. format: password maxLength: 255 minLength: 1 type: string clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string displayName: description: The display name of the metastore configuration maxLength: 255 minLength: 1 type: string metastoreId: description: The OCID of the Data Catalog metastore. maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - metastoreId - bdsApiKeyId - bdsApiKeyPassphrase type: object PatchingConfigs: description: Detailed configurations for defining the behavior when installing os patches. If not provided, nodes will be patched and rebooted AD/FD by AD/FD for regular patches or will be patched with down time if the patch is an emergent patch. discriminator: propertyName: patchingConfigStrategy properties: patchingConfigStrategy: description: Type of strategy used for detailed patching configuration enum: - DOWNTIME_BASED - BATCHING_BASED - DOMAIN_BASED type: string required: - patchingConfigStrategy type: object ClusterDetails: description: Specific info about a Hadoop cluster properties: ambariUrl: description: The URL of Ambari maxLength: 1024 minLength: 1 type: string bdCellVersion: description: Cloud SQL cell version. maxLength: 255 minLength: 1 type: string bdaVersion: description: BDA version installed in the cluster maxLength: 255 minLength: 1 type: string bdmVersion: description: Big Data Manager version installed in the cluster. maxLength: 255 minLength: 1 type: string bdsVersion: description: Big Data Service version installed in the cluster. maxLength: 255 minLength: 1 type: string bigDataManagerUrl: description: The URL of Big Data Manager. maxLength: 1024 minLength: 1 type: string clouderaManagerUrl: description: The URL of Cloudera Manager maxLength: 1024 minLength: 1 type: string csqlCellVersion: description: Big Data SQL version. maxLength: 255 minLength: 1 type: string dbVersion: description: Cloud SQL query server database version. maxLength: 255 minLength: 1 type: string hueServerUrl: description: The URL of the Hue server. maxLength: 1024 minLength: 1 type: string jupyterHubUrl: description: The URL of the Jupyterhub. maxLength: 1024 minLength: 1 type: string odhVersion: description: Version of the ODH (Oracle Distribution including Apache Hadoop) installed on the cluster. maxLength: 255 minLength: 1 type: string osVersion: description: Oracle Linux version installed in the cluster. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the cluster was created, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeRefreshed: description: 'The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string. ' example: 2019-03-29 09:36:42+00:00 format: date-time type: string required: - timeCreated type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. maxLength: 1024 minLength: 1 type: string timestamp: description: The time the log message was written, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string required: - message - timestamp WorkRequest: description: Description of the work request status. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. ' maxLength: 255 minLength: 1 type: string id: description: The ID of the work request. maxLength: 255 minLength: 1 type: string operationType: description: The type of this work request. enum: - CREATE_BDS - UPDATE_BDS - DELETE_BDS - ADD_BLOCK_STORAGE - ADD_MASTER_NODES - ADD_UTILITY_NODES - ADD_WORKER_NODES - ADD_CLOUD_SQL - REMOVE_CLOUD_SQL - CHANGE_COMPARTMENT_FOR_BDS - CHANGE_SHAPE - UPDATE_INFRA - RESTART_NODE - REMOVE_NODE - CREATE_AUTOSCALE_CONFIG - UPDATE_AUTOSCALE_CONFIG - DELETE_AUTOSCALE_CONFIG - REMOVE_NODES - AUTOSCALE_CONFIG - AUTOSCALE_RUN - CREATE_API_KEY - DELETE_API_KEY - TEST_OBJECT_STORE_CONNECTION - CREATE_METASTORE_CONFIG - DELETE_METASTORE_CONFIG - UPDATE_METASTORE_CONFIG - ACTIVATE_METASTORE_CONFIG - TEST_METASTORE_CONFIG - PATCH_BDS - PATCH_ODH - PATCH_OS - STOP_BDS - START_BDS - ADD_KAFKA - REMOVE_KAFKA - EXECUTE_BOOTSTRAP_SCRIPT - ODH_SERVICE_CERTIFICATE_UPDATE - CREATE_BACKUP_CONFIG - UPDATE_BACKUP_CONFIG - DELETE_BACKUP_CONFIG - CREATE_NODE_REPLACE_CONFIG - UPDATE_NODE_REPLACE_CONFIG - DELETE_NODE_REPLACE_CONFIG - BACKUP_NODES - DELETE_NODE_BACKUP - REPLACE_NODE - CREATE_RESOURCE_PRINCIPAL_CONFIGURATION - DELETE_RESOURCE_PRINCIPAL_CONFIGURATION - UPDATE_RESOURCE_PRINCIPAL_CONFIGURATION - REFRESH_RESOURCE_PRINCIPAL - CREATE_IDENTITY_CONFIG - DELETE_IDENTITY_CONFIG - UPDATE_IDENTITY_CONFIG - ACTIVATE_UPST_CONFIG - DEACTIVATE_UPST_CONFIG - REFRESH_CONFIDENTIAL_APPLICATION - REFRESH_TOKEN_EXCHANGE_KEYTAB - ACTIVATE_IAM_USER_SYNC_CONFIG - DEACTIVATE_IAM_USER_SYNC_CONFIG - INSTALL_SOFTWARE_UPDATES - RESET_PASSWORD - GENERATE_CERTIFICATE - RENEW_CERTIFICATE - CREATE_CERT_CONFIG - SET_DEFAULT_CERT_CONFIG - DELETE_CERT_CONFIG type: string x-obmcs-top-level-enum: '#/definitions/OperationTypes' percentComplete: description: Percentage of this work request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of this 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 request was created, shown as an RFC 3339 formatted datetime string. ' example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeFinished: description: 'The time the object was finished, shown as an RFC 3339 formatted datetime string. ' example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeStarted: description: 'The time the request was started, shown as an RFC 3339 formatted datetime string. ' example: 2019-03-29 09:36:42+00:00 format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted UpdateNodeBackupConfigurationDetails: description: The information about the NodeBackupConfiguration that is being updated. properties: backupType: default: FULL description: Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created. type: string x-obmcs-enumref: '#/definitions/NodeBackup/backupType' displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string levelTypeDetails: $ref: '#/components/schemas/LevelTypeDetails' numberOfBackupsToRetain: default: 3 description: Number of backup copies to retain. maximum: 5 minimum: 1 type: integer schedule: description: 'Day/time recurrence (specified following RFC 5545) at which to trigger the backup process. Currently only DAILY, WEEKLY and MONTHLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR. Other fields are not supported. ' format: x-obmcs-recurring-time type: string x-example: 'FREQ=WEEKLY;BYDAY=FR;BYHOUR=18 - Triggers on every Friday of the week at 06:00 pm ' timezone: default: Etc/UTC description: The time zone of the execution schedule, in IANA time zone database name format example: America/Los_Angeles format: x-obmcs-time-zone type: string type: object CloudSqlDetails: description: The information about added Cloud SQL capability properties: blockVolumeSizeInGBs: description: 'The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself. ' format: int64 type: integer ipAddress: description: IP address of the Cloud SQL node. maxLength: 255 minLength: 1 type: string isKerberosMappedToDatabaseUsers: default: true description: 'Boolean flag specifying whether or not Kerberos principals are mapped to database users. ' type: boolean kerberosDetails: description: Details about the Kerberos principals. items: $ref: '#/components/schemas/KerberosDetails' type: array shape: description: Shape of the node maxLength: 255 minLength: 1 type: string required: - shape - ipAddress type: object GenerateBdsCertificateDetails: description: Request body for generating certificates. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string manageCertificateLevelTypeDetails: $ref: '#/components/schemas/ManageBdsCertificateLevelTypeDetails' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - manageCertificateLevelTypeDetails CreateBdsApiKeyDetails: description: API key created on user's behalf. properties: defaultRegion: description: 'The name of the region to establish the Object Storage endpoint. See https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/Region/ for additional information. ' maxLength: 16 minLength: 1 type: string domainOcid: description: Identity domain OCID , where user is present. For default domain , this field will be optional. maxLength: 255 minLength: 1 type: string keyAlias: description: 'User friendly identifier used to uniquely differentiate between different API keys associated with this Big Data Service cluster. Only ASCII alphanumeric characters with no spaces allowed. ' maxLength: 255 minLength: 1 type: string passphrase: description: Base64 passphrase used to secure the private key which will be created on user behalf. format: password maxLength: 255 minLength: 1 type: string userId: description: The OCID of the user for whom this new generated API key pair will be created. maxLength: 255 minLength: 1 type: string required: - userId - passphrase - keyAlias type: object AutoScalingConfiguration: description: The information about the autoscale configuration. properties: displayName: description: A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string id: description: The unique identifier for the autoscale configuration. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the autoscale configuration. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string nodeType: description: A node type that is managed by an autoscale configuration. The only supported types are WORKER and COMPUTE_ONLY_WORKER. type: string x-obmcs-enumref: '#/definitions/Node/nodeType' policy: $ref: '#/components/schemas/AutoScalePolicy' policyDetails: $ref: '#/components/schemas/AutoScalePolicyDetails' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the cluster was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: 'The time the autoscale configuration was updated, shown as an RFC 3339 formatted datetime string. ' example: 2020-04-29 09:36:42+00:00 format: date-time type: string required: - id - displayName - nodeType - policy - lifecycleState - timeCreated - timeUpdated type: object AddKafkaDetails: description: The information about the Kafka service to be added. properties: blockVolumeSizeInGBs: description: 'The size of block volme in GB to be attached to the given node. All details needed for attaching the block volume are managed by the service itself. ' format: int64 minimum: 150 type: integer clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string numberOfKafkaNodes: description: Number of Kafka nodes for the cluster. format: int32 maximum: 1024 minimum: 1 type: integer secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string shape: description: Shape of the Kafka broker node. maxLength: 255 minLength: 1 type: string shapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' required: - shape - numberOfKafkaNodes type: object Node: description: Details about a node. properties: attachedBlockVolumes: description: The list of block volumes attached to a given node. items: $ref: '#/components/schemas/VolumeAttachmentDetail' type: array availabilityDomain: description: The name of the availability domain in which the node is running. maxLength: 255 minLength: 1 type: string certificateConfigurationId: description: ID of the certificate configuration which is used to generate the certificate for the node. maxLength: 255 minLength: 1 type: string displayName: description: The name of the node. maxLength: 255 minLength: 1 type: string faultDomain: description: The name of the fault domain in which the node is running. maxLength: 255 minLength: 1 type: string hostname: description: The fully-qualified hostname (FQDN) of the node. maxLength: 255 minLength: 1 type: string imageId: description: The OCID of the image from which the node was created. maxLength: 255 minLength: 1 type: string instanceId: description: The OCID of the underlying Oracle Cloud Infrastructure Compute instance. maxLength: 255 minLength: 1 type: string ipAddress: description: IP address of the node. maxLength: 255 minLength: 1 type: string isRebootRequired: default: false description: Indicates if the node requires a reboot to either reflect the latest os kernel or take actions for maintenance reboot. type: boolean lifecycleState: description: The state of the node. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED - STOPPED - STOPPING - STARTING type: string localDisksTotalSizeInGBs: description: The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null. format: double type: number memoryInGBs: description: The total amount of memory available to the node, in gigabytes. type: integer nodeBackupId: description: The node back id that was used for replacing the node. type: string nodeType: description: Cluster node type. enum: - MASTER - EDGE - UTILITY - WORKER - COMPUTE_ONLY_WORKER - KAFKA_BROKER - BURSTING - CLOUD_SQL type: string nvmes: description: The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. type: integer ocpus: description: The total number of OCPUs available to the node. type: integer odhVersion: description: Version of the ODH (Oracle Distribution including Apache Hadoop) for the node. maxLength: 255 minLength: 1 type: string osVersion: default: OL7.9 description: BDS-assigned Operating System version for the node. maxLength: 255 minLength: 1 type: string shape: description: Shape of the node. maxLength: 255 minLength: 1 type: string sshFingerprint: description: The fingerprint of the SSH key used for node access. maxLength: 255 minLength: 1 type: string subnetId: description: The OCID of the subnet in which the node is to be created. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the node was created, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string timeMaintenanceRebootDue: description: The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. example: 2020-03-29 09:36:42+00:00 format: date-time type: string timeReplaced: description: The date and time the instance was replaced by a new vm with a node backup. example: 2020-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: The time the cluster was updated, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string required: - instanceId - displayName - lifecycleState - nodeType - shape - ipAddress - sshFingerprint - availabilityDomain - faultDomain - timeCreated - subnetId type: object ActivateUpstConfigurationDetails: description: Details for activating UPST config on the cluster properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string masterEncryptionKeyId: description: OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for creating UPST config maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string vaultId: description: OCID of the vault to store token exchange service principal keyta, required for creating UPST configb maxLength: 255 minLength: 1 type: string required: - vaultId - masterEncryptionKeyId type: object RestartNodeDetails: description: The information about restarted node. properties: nodeId: description: OCID of the node to be restarted. maxLength: 255 minLength: 1 type: string required: - nodeId type: object CreateBdsInstanceDetails: description: The information about the new cluster. properties: bdsClusterVersionSummary: $ref: '#/components/schemas/BdsClusterVersionSummary' bootstrapScriptUrl: description: Pre-authenticated URL of the script in Object Store that is downloaded and executed. maxLength: 1024 minLength: 1 type: string clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. Not required if the secretId is specified. format: password maxLength: 255 minLength: 1 type: string clusterProfile: default: HADOOP_EXTENDED description: Profile of the Big Data Service cluster. type: string x-obmcs-enumref: '#/definitions/BdsInstance/clusterProfile' clusterPublicKey: description: The SSH public key used to authenticate the cluster connection. maxLength: 1024 minLength: 1 type: string clusterVersion: description: Version of the Hadoop distribution. type: string x-obmcs-enumref: '#/definitions/BdsInstance/clusterVersion' compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. For example, `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: Name of the Big Data Service cluster. 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. For example, `{"bar-key": "value"}` ' type: object isHighAvailability: default: false description: Boolean flag specifying whether or not the cluster is highly available (HA). type: boolean isSecretReused: default: false description: Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations. type: boolean isSecure: default: true description: Boolean flag specifying whether or not the cluster should be set up as secure. type: boolean kmsKeyId: description: The OCID of the Key Management master encryption key. maxLength: 255 minLength: 1 type: string networkConfig: $ref: '#/components/schemas/NetworkConfig' nodes: description: The list of nodes in the Big Data Service cluster. items: $ref: '#/components/schemas/CreateNodeDetails' type: array secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName - clusterVersion - clusterPublicKey - isHighAvailability - isSecure - nodes type: object ResourcePrincipalConfigurationSummary: description: Resource Principal Session Token Details. properties: bdsInstanceId: description: the OCID of the bdsInstance which is the parent resource id. maxLength: 255 minLength: 1 type: string displayName: description: a user-friendly name. only ascii alphanumeric characters with no spaces allowed. the name does not have to be unique, and it may be changed. avoid entering confidential information. maxLength: 255 minLength: 8 type: string id: description: the ID of the ResourcePrincipalConfiguration defined under BDS resources, not OCID. maxLength: 255 minLength: 1 type: string lifecycleState: description: the state of the ResourcePrincipalConfiguration. type: string x-obmcs-enumref: '#/definitions/ResourcePrincipalConfiguration/lifecycleState' timeCreated: description: the time the ResourcePrincipalConfiguration was created, shown as an rfc 3339 formatted datetime string. example: 2020-03-29t09:36:42z format: date-time type: string timeTokenExpiry: description: the time the resource principal session token will expired, shown as an rfc 3339 formatted datetime string. example: 2020-03-29t09:36:42z format: date-time type: string timeTokenRefreshed: description: the time the resource principal session token was refreshed, shown as an rfc 3339 formatted datetime string. example: 2020-03-29t09:36:42z format: date-time type: string timeUpdated: description: 'the time the ResourcePrincipalConfiguration was updated, shown as an rfc 3339 formatted datetime string. ' example: 2020-04-29t09:36:42z format: date-time type: string required: - id - bdsInstanceId - displayName - lifecycleState - timeCreated - timeUpdated type: object VolumeAttachmentDetail: description: A detail of the attached block volume. properties: volumeAttachmentId: description: The OCID of the volume attachment. maxLength: 255 minLength: 1 type: string volumeSizeInGBs: description: The size of the volume in GBs. format: int64 type: integer required: - volumeAttachmentId - volumeSizeInGBs type: object StartBdsInstanceDetails: description: The request body for starting a BDS cluster. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string startClusterShapeConfigs: $ref: '#/components/schemas/StartClusterShapeConfigs' type: object AddCloudSqlDetails: description: The information about the added Cloud SQL. properties: blockVolumeSizeInGBs: description: 'The size of block volume in GB to be attached to the given node. All details needed for attaching the block volume are managed by the service itself. ' format: int64 minimum: 1000 type: integer clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 1 type: string shape: description: Shape of the node. maxLength: 255 minLength: 1 type: string shapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' required: - shape type: object AddMasterNodesDetails: description: The information about added master nodes. properties: blockVolumeSizeInGBs: description: 'The size of block volume in GB to be attached to the given node. It''s a read-only property. ' format: int64 minimum: 150 type: integer clusterAdminPassword: description: Base-64 encoded Cluster Admin Password for cluster admin user. format: password maxLength: 255 minLength: 1 type: string numberOfMasterNodes: description: Number of additional master nodes for the cluster. format: int32 maximum: 1024 minimum: 1 type: integer secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string shape: description: Shape of the node. It's a read-only property derived from existing Master node. maxLength: 255 minLength: 1 type: string shapeConfig: $ref: '#/components/schemas/ShapeConfigDetails' required: - numberOfMasterNodes type: object OdhPatchingConfig: description: Detailed configurations for defining the behavior when installing ODH patches. If not provided, nodes will be patched with down time. discriminator: propertyName: patchingConfigStrategy properties: patchingConfigStrategy: description: Type of strategy used for detailed patching configuration enum: - DOWNTIME_BASED - BATCHING_BASED - DOMAIN_BASED type: string required: - patchingConfigStrategy type: object UpdateNodeReplaceConfigurationDetails: description: The information about the NodeReplaceConfiguration properties: displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string durationInMinutes: description: This value is the pending duration time to wait for metric emission before triggering node replacement. The value is in minutes. minimum: 15 type: integer levelTypeDetails: $ref: '#/components/schemas/LevelTypeDetails' metricType: description: Type of compute instance health metric to use for node replacement type: string x-obmcs-enumref: '#/definitions/NodeReplaceConfiguration/metricType' type: object NodeBackupConfiguration: description: The information about the NodeBackupConfiguration. properties: backupType: description: Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created. type: string x-obmcs-enumref: '#/definitions/NodeBackup/backupType' bdsInstanceId: description: The OCID of the bdsInstance which is the parent resource id. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string id: description: The unique identifier for the NodeBackupConfiguration. maxLength: 255 minLength: 1 type: string levelTypeDetails: $ref: '#/components/schemas/LevelTypeDetails' lifecycleState: description: The state of the NodeBackupConfiguration. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string numberOfBackupsToRetain: default: 3 description: Number of backup copies to retain. maximum: 5 minimum: 1 type: integer schedule: description: 'Day/time recurrence (specified following RFC 5545) at which to trigger the backup process. Currently only DAILY, WEEKLY and MONTHLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR. Other fields are not supported. ' format: x-obmcs-recurring-time type: string x-example: 'FREQ=WEEKLY;BYDAY=MO,TU,WE;BYHOUR=10 - Triggers on every Monday, Tuesday and Wednesday of the week at 10:00 am FREQ=WEEKLY;BYDAY=FR;BYHOUR=18 - Triggers on every Friday of the week at 06:00 pm ' timeCreated: description: The time the NodeBackupConfiguration was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: 'The time the NodeBackupConfiguration was updated, shown as an RFC 3339 formatted datetime string. ' example: 2020-04-29 09:36:42+00:00 format: date-time type: string timezone: default: Etc/UTC description: The time zone of the execution schedule, in IANA time zone database name format example: America/Los_Angeles format: x-obmcs-time-zone type: string required: - id - bdsInstanceId - displayName - lifecycleState - timeCreated - timeUpdated - timezone - schedule - numberOfBackupsToRetain - levelTypeDetails type: object WorkRequestResource: description: A resource created or operated on 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 remains 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 - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionTypes' entityType: description: The resource type the work request affects. maxLength: 255 minLength: 1 type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata. maxLength: 1024 minLength: 1 type: string identifier: description: The OCID of the resource the work request affects. maxLength: 255 minLength: 1 type: string required: - actionType - entityType - identifier BdsApiKey: description: The API key information. properties: defaultRegion: description: The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 . maxLength: 16 minLength: 1 type: string domainOcid: description: Identity domain OCID ,where user is present. For default domain ,this field will be optional. maxLength: 255 minLength: 1 type: string fingerprint: description: The fingerprint that corresponds to the public API key requested. maxLength: 255 minLength: 1 type: string id: description: Identifier of the user's API key. maxLength: 255 minLength: 1 type: string keyAlias: description: 'User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the key. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED type: string pemfilepath: description: 'The full path and file name of the private key used for authentication. This location will be automatically selected on the BDS local file system. ' maxLength: 1024 minLength: 1 type: string tenantId: description: The OCID of your tenancy. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the API key was created, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string userId: description: The user OCID for which this API key was created. maxLength: 255 minLength: 1 type: string required: - id - userId - keyAlias - lifecycleState - defaultRegion - tenantId - fingerprint - pemfilepath type: object PasswordSummary: description: New password value for the target service. properties: adminPassword: description: Base-64 encoded new admin password for the requested service after the reset operation. maxLength: 255 minLength: 1 type: string required: - adminPassword type: object CreateResourcePrincipalConfigurationDetails: description: Details of creating a resource principal configuration for the cluster. properties: clusterAdminPassword: description: Base-64 encoded Cluster Admin Password for cluster admin user. format: password maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string sessionTokenLifeSpanDurationInHours: default: 6 description: Life span in hours for the resource principal session token. format: int32 maximum: 12 minimum: 1 type: integer required: - displayName type: object ActivateBdsMetastoreConfigurationDetails: description: The reqeust body when activating a BDS metastore configuration properties: bdsApiKeyPassphrase: description: Base-64 encoded passphrase of the BDS Api Key. Set only if metastore's type is EXTERNAL. format: password maxLength: 255 minLength: 1 type: string clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object BdsCapacityReport: description: 'A report of the host capacity within an availability domain that is available for you to create bds clusters. Host capacity is the physical infrastructure that resources such as compute instances run on. Use the capacity report to determine whether sufficient capacity is available for a shape before you create a bds cluster or change the shape of a bds cluster. ' properties: compartmentId: description: The OCID for the compartment. This should always be the root compartment. maxLength: 255 minLength: 1 type: string shapeAvailabilities: description: Information about the capacity of each requested shape. items: $ref: '#/components/schemas/CapacityReportShapeAvailability' maxItems: 10 type: array timeCreated: description: The time the report was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string required: - compartmentId - shapeAvailabilities - timeCreated WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occurred. Error codes are listed on (https://docs.oracle.com/en-us/iaas/Content/API/References/apierrors.htm). ' maxLength: 255 minLength: 1 type: string message: description: A human readable description of the issue encountered. maxLength: 1024 minLength: 1 type: string timestamp: description: The time the error occurred, shown as an RFC 3339 formatted datetime string. example: 2019-03-29 09:36:42+00:00 format: date-time type: string required: - code - message - timestamp ExecuteBootstrapScriptDetails: description: The information about the bootstrap script to be executed. properties: bootstrapScriptUrl: description: pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed. maxLength: 1024 minLength: 1 type: string clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object DisableCertificateDetails: description: The request body info about disable certificate service list. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string services: description: List of services for which certificate needs to be disabled. items: $ref: '#/components/schemas/Service' type: array required: - services type: object KerberosDetails: description: Details about the Kerberos principals. properties: keytabFile: description: Location of the keytab file maxLength: 1024 minLength: 1 type: string principalName: description: Name of the Kerberos principal. maxLength: 255 minLength: 1 type: string required: - principalName - keytabFile type: object HostCertDetails: description: Details about the host and corresponding certificate. properties: certificate: description: Certificate value in string format type: string hostName: description: Fully qualified domain name (FQDN) of the host example: host1-test-mn0.bmbdcsad1.bmbdcs.oraclevcn.com maxLength: 1024 minLength: 1 type: string privateKey: description: Private key of the provided certificate type: string required: - hostName - certificate - privateKey type: object BdsInstanceResetPasswordDetails: description: The request body for resetting the password of indicated component. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the cluster admin user. maxLength: 255 minLength: 1 type: string service: description: Target service to which this operation applies. enum: - AMBARI - HUE - RANGER - JUPYTERHUB type: string required: - service type: object RemoveNodeReplaceConfigurationDetails: description: The information about the NodeReplaceConfiguration that being removed. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 8 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object AddBlockStorageDetails: description: The information about added block volumes. properties: blockVolumeSizeInGBs: description: 'The size of block volume in GB to be added. For WORKER, COMPUTE_ONLY_WORKER, and KAFKA_BROKER nodes, the same size will be added to all nodes of that type. For EDGE nodes, this size can be different per node when nodeId is specified. All the details needed for attaching the block volume are managed by service itself. ' format: int64 minimum: 50 type: integer clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 1 type: string nodeIds: description: 'Optional. List of OCIDs of specific nodes to add storage to. Only supported for EDGE nodes. When omitted, storage is added to all nodes of the specified type. ' items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array nodeType: description: Worker node types. enum: - WORKER - COMPUTE_ONLY_WORKER - KAFKA_BROKER - EDGE type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - blockVolumeSizeInGBs - nodeType type: object BdsMetastoreConfigurationSummary: description: The summary of metastore configuration information. properties: bdsApiKeyId: description: The ID of BDS API Key used for metastore configuration. Set only if metastore's type is EXTERNAL. maxLength: 255 minLength: 1 type: string displayName: description: The display name of metastore configuration maxLength: 255 minLength: 1 type: string id: description: The ID of the metastore configuration maxLength: 255 minLength: 1 type: string lifecycleState: description: the lifecycle state of the metastore configuration. type: string x-obmcs-enumref: '#/definitions/BdsMetastoreConfiguration/lifecycleState' metastoreId: description: The OCID of the Data Catalog metastore. Set only if metastore's type is EXTERNAL. maxLength: 255 minLength: 1 type: string metastoreType: description: The type of the metastore in the metastore configuration. type: string x-obmcs-enumref: '#/definitions/BdsMetastoreConfiguration/metastoreType' timeCreated: description: The time when the configuration was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-28 09:36:42+00:00 format: date-time type: string timeUpdated: description: The time when the configuration was updated, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string required: - id - displayName - metastoreType - lifecycleState - timeCreated type: object AutoScalePolicyMetricRule: description: Metric and threshold details for triggering an autoscale action. properties: metricType: description: Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION. enum: - CPU_UTILIZATION - MEMORY_UTILIZATION type: string threshold: $ref: '#/components/schemas/MetricThresholdRule' required: - metricType - threshold type: object AutoScalingConfigurationSummary: description: The information about the autoscale configuration. properties: displayName: description: A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string id: description: The ID of the autoscale configuration defined under BDS resources, not OCID. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the autoscale configuration. type: string x-obmcs-enumref: '#/definitions/AutoScalingConfiguration/lifecycleState' nodeType: description: A node type that is managed by an autoscale configuration. The only supported types are WORKER and COMPUTE_ONLY_WORKER. type: string x-obmcs-enumref: '#/definitions/Node/nodeType' policy: $ref: '#/components/schemas/AutoScalePolicy' policyDetails: $ref: '#/components/schemas/AutoScalePolicyDetails' timeCreated: description: The time the cluster was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string timeUpdated: description: 'The time the autoscale configuration was updated, shown as an RFC 3339 formatted datetime string. ' example: 2020-04-29 09:36:42+00:00 format: date-time type: string required: - id - displayName - nodeType - policy - lifecycleState - timeCreated - timeUpdated type: object ChangeBdsInstanceCompartmentDetails: description: Move a Cluster to a Different Compartment properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object LevelTypeDetails: description: Details of the type of level used to trigger the creation of a new node backup configuration or node replacement configuration. discriminator: propertyName: levelType properties: levelType: description: Type of level used to trigger the creation of a new node backup configuration or node replacement configuration. enum: - NODE_LEVEL - NODE_TYPE_LEVEL type: string required: - levelType type: object UpdateIdentityConfigurationDetails: description: Details for updating identity config on the cluster properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string iamUserSyncConfigurationDetails: $ref: '#/components/schemas/iamUserSyncConfigurationDetails' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string upstConfigurationDetails: $ref: '#/components/schemas/upstConfigurationDetails' type: object RemoveAutoScalingConfigurationDetails: description: The information about the removed autoscale configuration. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 8 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object RenewCertificateDetails: description: The request body info about renew certificate service list. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string hostCertDetails: description: List of leaf certificates to use for services on each host. If custom host certificate is provided the root certificate becomes required. items: $ref: '#/components/schemas/HostCertDetails' type: array rootCertificate: description: Plain text certificate/s in order, separated by new line character. If not provided in request a self-signed root certificate is generated inside the cluster. In case hostCertDetails is provided, root certificate is mandatory. type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string serverKeyPassword: description: Base-64 encoded password for CA certificate's private key. This value can be empty. format: password type: string services: description: List of services for which certificate needs to be renewed. If no services provided renew will happen only for default services - AMBARI,RANGER,HUE,LIVY. items: $ref: '#/components/schemas/Service' type: array type: object SoftwareUpdateCollection: description: Results of a software update search. Contains both software update summaries and a summary of the search. properties: items: description: List of all the available software updates. items: $ref: '#/components/schemas/SoftwareUpdateSummary' type: array required: - items type: object CreateNodeBackupConfigurationDetails: description: The information about the NodeBackupConfiguration. properties: backupType: default: FULL description: Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created. type: string x-obmcs-enumref: '#/definitions/NodeBackup/backupType' displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string levelTypeDetails: $ref: '#/components/schemas/LevelTypeDetails' numberOfBackupsToRetain: default: 3 description: Number of backup copies to retain. maximum: 5 minimum: 1 type: integer schedule: description: 'Day/time recurrence (specified following RFC 5545) at which to trigger the backup process. Currently only DAILY, WEEKLY and MONTHLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR. Other fields are not supported. ' format: x-obmcs-recurring-time type: string x-example: 'FREQ=WEEKLY;BYDAY=FR;BYHOUR=18 - Triggers on every Friday of the week at 06:00 pm FREQ=DAILY;BYHOUR=18 - Triggers on everyday at 06:00 pm ' timezone: default: Etc/UTC description: The time zone of the execution schedule, in IANA time zone database name format example: America/Los_Angeles format: x-obmcs-time-zone type: string required: - levelTypeDetails - schedule type: object IdentityConfiguration: description: Details about the identity configuration properties: confidentialApplicationId: description: identity domain confidential application ID for the identity config maxLength: 255 minLength: 1 type: string displayName: description: the display name of the identity configuration maxLength: 255 minLength: 1 type: string iamUserSyncConfiguration: $ref: '#/components/schemas/IamUserSyncConfiguration' id: description: The id of the UPST config maxLength: 255 minLength: 1 type: string identityDomainId: description: Identity domain to use for identity config maxLength: 255 minLength: 1 type: string lifecycleState: description: Lifecycle state of the identity configuration enum: - ACTIVE - DELETED type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string timeCreated: description: Time when this identity configuration was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time minLength: 1 type: string timeUpdated: description: Time when this identity configuration config was updated, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time minLength: 1 type: string upstConfiguration: $ref: '#/components/schemas/UpstConfiguration' required: - id - displayName - confidentialApplicationId - identityDomainId - lifecycleState - timeCreated - timeUpdated type: object RemoveNodesDetails: description: The information about the list of nodes to be removed. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 1 type: string instanceIds: description: List of instance IDs to be removed. items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array isForceRemoveEnabled: default: false description: 'Boolean flag specifying whether or not to force remove nodes if graceful removal fails. ' type: boolean secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - instanceIds type: object PatchHistorySummary: description: Patch history of this cluster. properties: lifecycleState: description: The status of this patch. enum: - INSTALLING - INSTALLED - FAILED type: string patchType: description: 'The type of current patch history. DP - Data Plane patch(This history type is internal available only) ODH - Oracle Distribution of Hadoop update OS - Operating System update BDS - Big Data Service update ' enum: - ODH - OS - BDS type: string timeUpdated: description: The time when the patch history was last updated. example: 2020-03-29 09:36:42+00:00 format: date-time type: string version: description: The version of the patch. maxLength: 255 minLength: 1 type: string required: - version - lifecycleState - timeUpdated - patchType type: object CertificateServiceInfoSummary: description: List of TLS/SSL information of services properties: hostSpecificCertificateDetails: description: List of Host specific certificate details items: $ref: '#/components/schemas/HostSpecificCertificateDetails' type: array service: description: Name of the service enum: - ZOOKEEPER - AMS - HDFS - YARN - MAPREDUCE - OOZIE - HBASE - SPARK - HIVE - KAFKA - FLINK - REGISTRY type: string serviceCertificateStatus: description: Whether certificate is enabled or disabled enum: - ENABLED - DISABLED type: string required: - service - serviceCertificateStatus - hostSpecificCertificateDetails type: object NodeBackup: description: The information about the Node's backup. properties: backupTriggerType: description: type based on how backup action was initiated. enum: - MANUAL - SCHEDULED type: string backupType: description: Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created. enum: - FULL - INCREMENTAL type: string displayName: description: BDS generated name for the backup. Format is nodeHostName_timeCreated maxLength: 255 minLength: 8 type: string id: description: The id of the node backup. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the NodeBackup. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED - PARTIAL type: string nodeBackupConfigId: description: The ID of the nodeBackupConfiguration if the NodeBackup is automatically created by applying the configuration. maxLength: 255 minLength: 1 type: string nodeHostName: description: Host name of the node to which this backup belongs. maxLength: 255 minLength: 8 type: string nodeInstanceId: description: The instance OCID of the node, which is the resource from which the node backup was acquired. maxLength: 255 minLength: 1 type: string timeCreated: description: The time the cluster was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string required: - id - displayName - nodeInstanceId - nodeHostName - backupTriggerType - backupType - lifecycleState - timeCreated type: object SetDefaultBdsCertificateConfigurationDetails: description: The request body for configuring BDS certificate configuration as default configuration. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object CreateBdsCertificateConfigurationDetails: description: The request body for generating BDS certificate configuration. properties: certificateAuthorityId: description: The OCID of the certificate authority which is associated with this certificate configuration. maxLength: 255 minLength: 1 type: string certificateType: description: The type of the BDS certificate configuration, also the type of the BDS certificates which will be generated by the BDS certificate configuration. type: string x-obmcs-enumref: '#/definitions/BdsCertificateConfiguration/type' compartmentId: description: The OCID of the compartment of the certificate authority connecting to this certificate configuration. maxLength: 255 minLength: 1 type: string displayName: description: The display name of the BDS certificate configuration. maxLength: 50 minLength: 1 type: string required: - displayName - certificateType type: object CreateNodeReplaceConfigurationDetails: description: The information about the NodeReplaceConfiguration properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 8 type: string displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string durationInMinutes: description: This value is the minimum period of time to wait before triggering node replacement. The value is in minutes. minimum: 15 type: integer levelTypeDetails: $ref: '#/components/schemas/LevelTypeDetails' metricType: description: Type of compute instance health metric to use for node replacement type: string x-obmcs-enumref: '#/definitions/NodeReplaceConfiguration/metricType' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - levelTypeDetails - metricType - durationInMinutes type: object UpdateAutoScalingConfigurationDetails: description: The information about the autoscale configuration. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 8 type: string displayName: description: A user-friendly name. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string isEnabled: description: Whether the autoscale configuration is enabled. type: boolean policy: $ref: '#/components/schemas/AutoScalePolicy' policyDetails: $ref: '#/components/schemas/UpdateAutoScalePolicyDetails' secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string type: object OsPatchSummary: description: Summary of an available os patch to a cluster. properties: osPatchVersion: description: Patch version of the os patch. type: string releaseDate: description: The time when the OS patch was released. example: 2022-02-28 09:36:42+00:00 format: date-time type: string required: - osPatchVersion - releaseDate type: object RemoveNodeDetails: description: The information about node to be removed. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster (and Cloudera Manager) admin user. format: password maxLength: 255 minLength: 1 type: string isForceRemoveEnabled: default: false description: 'Boolean flag specifying whether or not to force remove node if graceful removal fails. ' type: boolean nodeId: description: OCID of the node to be removed. maxLength: 255 minLength: 1 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string required: - nodeId type: object ReplaceNodeDetails: description: The information about the node to be replaced. properties: clusterAdminPassword: description: Base-64 encoded password for the cluster admin user. format: password maxLength: 255 minLength: 1 type: string nodeBackupId: description: The id of the nodeBackup to use for replacing the node. maxLength: 255 minLength: 1 type: string nodeHostName: description: Host name of the node to replace. MASTER, UTILITY and EDGE node are only supported types maxLength: 255 minLength: 8 type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string shape: description: Shape of the new vm when replacing the node. If not provided, BDS will attempt to replace the node with the shape of current node. maxLength: 255 minLength: 1 type: string required: - nodeHostName - nodeBackupId type: object DomainTypeCapacityReport: description: Detailed information of the capacity under a domain. discriminator: propertyName: domainType properties: domainType: description: Type of domain level for the capacity report. enum: - MULTI_AD - SINGLE_AD type: string required: - domainType type: object ResourcePrincipalConfiguration: description: Resource Principal Session Token Details. properties: bdsInstanceId: description: The OCID of the bdsInstance which is the parent resource id. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information. maxLength: 255 minLength: 8 type: string id: description: The id of the ResourcePrincipalConfiguration defined under BDS resources, not OCID. maxLength: 255 minLength: 1 type: string lifecycleState: description: The state of the ResourcePrincipalConfiguration. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string secretId: description: The secretId for the clusterAdminPassword. maxLength: 255 minLength: 1 type: string sessionTokenLifeSpanDurationInHours: description: Life span in hours of each resource principal session token. format: int32 maximum: 12 minimum: 1 type: integer timeCreated: description: The time the ResourcePrincipalConfiguration was created, shown as an RFC 3339 formatted datetime string. example: 2020-03-29 09:36:42+00:00 format: date-time type: string timeTokenExpiry: description: the time the resource principal session token will expired, shown as an rfc 3339 formatted datetime string. example: 2020-03-29t09:36:42z format: date-time type: string timeTokenRefreshed: description: the time the resource principal session token was refreshed, shown as an rfc 3339 formatted datetime string. example: 2020-03-29t09:36:42z format: date-time type: string timeUpdated: description: 'The time the ResourcePrincipalConfiguration was updated, shown as an RFC 3339 formatted datetime string. ' example: 2020-04-29 09:36:42+00:00 format: date-time type: string required: - id - bdsInstanceId - displayName - lifecycleState - sessionTokenLifeSpanDurationInHours - timeCreated - timeUpdated type: object AutoScalePolicyDetails: description: 'Details of an autoscale policy. You can create following types of autoscaling policies: - **MetricBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered when a performance metric exceeds a threshold - **MetricBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered when a performance metric exceeds a threshold - **ScheduleBasedVerticalScalingPolicy:** Vertical autoscaling action is triggered at the specific times that you schedule. - **ScheduleBasedHorizontalScalingPolicy:** Horizontal autoscaling action is triggered at the specific times that you schedule. ' discriminator: propertyName: policyType properties: actionType: description: The type of autoscaling action to take. enum: - VERTICAL_SCALING - HORIZONTAL_SCALING type: string policyType: description: Type of autoscaling policy. enum: - METRIC_BASED_VERTICAL_SCALING_POLICY - METRIC_BASED_HORIZONTAL_SCALING_POLICY - SCHEDULE_BASED_VERTICAL_SCALING_POLICY - SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY type: string triggerType: description: The type of autoscaling trigger. enum: - METRIC_BASED - SCHEDULE_BASED type: string required: - policyType - triggerType - actionType type: object BdsClusterVersionSummary: description: Cluster version details including bds and odh version information. properties: bdsVersion: description: BDS version to be used for cluster creation type: string odhVersion: description: ODH version to be used for cluster creation type: string required: - bdsVersion type: object parameters: NodeBackupDisplayNameQueryParam: description: The display name belonged to the node backup. in: query name: displayName required: false x-default-description: Default will not filter by any node backup displayName. schema: type: string 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 LifecycleStateBdsMetastoreQueryParam: description: The lifecycle state of the metastore in the metastore configuration in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/BdsMetastoreConfiguration/lifecycleState' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-default-description: 'if no sort order is provided but sortBy is specified by displayName, then the selected order for listing Big Data Service instances will be ascending, in other cases it will be descending. If sortOrder is specified, then the selected option is honored during the listing of the instances. ' x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC PatchTypeQueryParam: description: The type of a BDS patch history entity. in: query name: patchType required: false x-default-description: Default will filter no patch type. x-obmcs-enumref: '#/definitions/PatchHistorySummary/patchType' schema: type: string BdsApiKeyIdPathParam: description: The API key identifier. in: path name: apiKeyId required: true schema: type: string maxLength: 255 minLength: 1 IfMatchBdsInstanceHeader: description: "This if-match is for the BdsInstance. For optimistic concurrency \ncontrol. In the PUT or DELETE call for a resource, set the `if-match` \nparameter to the value of the etag from a previous GET or POST response \nfor that resource. The resource will be updated or deleted only if \nthe etag you provide matches the resource's current etag value.\n" in: header name: if-match required: false schema: type: string AutoscaleLifecycleStateQueryParam: description: The state of the autoscale configuration. in: query name: lifecycleState required: false x-default-description: Default will not filter by any lifecycleState. x-obmcs-enumref: '#/definitions/AutoScalingConfiguration/lifecycleState' schema: type: string BdsMetastoreConfigurationIdPathParam: description: The metastore configuration ID in: path name: metastoreConfigId required: true schema: type: string maxLength: 255 minLength: 1 NodeReplaceConfigurationIdPathParam: description: Unique Oracle-assigned identifier of the NodeReplaceConfiguration. in: path name: nodeReplaceConfigurationId required: true schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id required: false schema: type: string maxLength: 255 minLength: 1 IdentityConfigLifecycleStateQueryParam: description: The state of the identity config in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/IdentityConfiguration/lifecycleState' schema: type: string LifecycleStateQueryParam: description: The state of the cluster. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/BdsInstance/lifecycleState' schema: type: string 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 WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string maxLength: 255 minLength: 1 NodeHostNameQueryParam: description: The node host name belonged to a node that has a node backup. in: query name: nodeHostName required: false x-default-description: Default will not filter by any nodeHostName. schema: type: string OsPatchVersionParam: description: The version of the OS patch. in: query name: osPatchVersion required: true schema: type: string maxLength: 255 minLength: 1 DefaultDescSortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-default-description: 'if no sort order is provided then the selected order for listing will be descending, in other cases it will be ascending. If sortOrder is specified, then the selected option is honored during the listing of the values. ' x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName schema: type: string maxLength: 255 minLength: 1 LifecycleStateBdsApiKeyQueryParam: description: The state of the API key. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/BdsApiKey/lifecycleState' schema: type: string NodeBackupConfigurationLifecycleStateQueryParam: description: The state of the NodeBackupConfiguration configuration. in: query name: lifecycleState required: false x-default-description: Default will not filter by any lifecycleState. x-obmcs-enumref: '#/definitions/NodeBackupConfiguration/lifecycleState' schema: type: string SortByBdsVersionQueryParam: description: 'The field to sort by. Only one sort order may be provided. If no value is specified bdsVersion is default. ' in: query name: sortBy schema: type: string enum: - bdsVersion default: bdsVersion NodeBackupLifecycleStateQueryParam: description: The state of the Node's Backup. in: query name: lifecycleState required: false x-default-description: Default will not filter by any lifecycleState. x-obmcs-enumref: '#/definitions/NodeBackup/lifecycleState' 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 x-default-description: Default will not provide any pagination token schema: type: string maxLength: 1024 minLength: 1 AutoScalingConfigurationIdPathParam: description: Unique Oracle-assigned identifier of the autoscale configuration. in: path name: autoScalingConfigurationId required: true schema: type: string maxLength: 255 minLength: 1 NodeBackupConfigurationIdPathParam: description: Unique Oracle-assigned identifier of the NodeBackupConfiguration. in: path name: nodeBackupConfigurationId required: true schema: type: string maxLength: 255 minLength: 1 ResourcePrincipalConfigurationIdPathParam: description: Unique Oracle-assigned identifier of the ResourcePrincipalConfiguration. in: path name: resourcePrincipalConfigurationId required: true schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParamSplat: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 100 minimum: 1 LifecycleStatePatchQueryParam: description: The status of the patch. in: query name: lifecycleState required: false x-default-description: The default does not get filtered by any lifecycleState. x-obmcs-enumref: '#/definitions/PatchHistorySummary/lifecycleState' schema: type: string BdsInstanceIdPathParam: description: The OCID of the cluster. in: path name: bdsInstanceId required: true schema: type: string maxLength: 255 minLength: 1 BdsCertificateConfigurationLifecycleStateQueryParam: description: The state of the BdsCertificateConfiguration. in: query name: lifecycleState required: false x-default-description: Default will not filter by any lifecycle status. x-obmcs-enumref: '#/definitions/BdsCertificateConfiguration/lifecycleState' 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 SoftwareUpdateKeyParam: description: The unique identifier of the software update. in: path name: softwareUpdateKey required: true schema: type: string maxLength: 255 minLength: 1 UserIdQueryParam: description: The OCID of the user for whom the API key belongs. in: query name: userId required: false schema: type: string maxLength: 255 minLength: 1 BdsCertificateConfigurationIdPathParam: description: Unique Oracle-assigned identifier of the BdsCertificateConfiguration. in: path name: bdsCertificateConfigurationId required: true schema: type: string maxLength: 255 minLength: 1 NodeBackupIdPathParam: description: Unique assigned identifier of the nodeBackupId. in: path name: nodeBackupId required: true schema: type: string maxLength: 255 minLength: 1 CompartmentIdQueryParam: description: The OCID of the compartment. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 BdsMetastoreTypeQueryParam: description: The type of the metastore in the metastore configuration in: query name: metastoreType required: false x-obmcs-enumref: '#/definitions/BdsMetastoreConfiguration/metastoreType' schema: type: string default: EXTERNAL BdsMetastoreIdQueryParam: description: The OCID of the Data Catalog metastore in the metastore configuration in: query name: metastoreId required: false schema: type: string maxLength: 255 minLength: 1 ResourceIdQueryParam: description: The OCID of the resource. in: query name: resourceId required: false x-default-description: The resource ID is used as a filter for list queries. schema: type: string maxLength: 255 minLength: 1 BdsMetastoreApiKeyIdQueryParam: description: The ID of the API key that is associated with the external metastore in the metastore configuration in: query name: bdsApiKeyId required: false schema: type: string maxLength: 255 minLength: 1 ResourcePrincipalConfigurationLifecycleStateQueryParam: description: The state of the ResourcePrincipalConfiguration. in: query name: lifecycleState required: false x-default-description: Default will not filter by any lifecycleState. x-obmcs-enumref: '#/definitions/ResourcePrincipalConfiguration/lifecycleState' schema: type: string PatchVersionQueryParam: description: The version of the patch in: query name: patchVersion required: false x-default-description: The default does not get filtered by any patchVersion. schema: type: string maxLength: 255 minLength: 1 IdentityConfigurationIdPathParam: description: The OCID of the identity configuration in: path name: identityConfigurationId required: true schema: type: string maxLength: 255 minLength: 1 NodeReplaceConfigurationLifecycleStateQueryParam: description: The state of the NodeReplaceConfiguration. in: query name: lifecycleState required: false x-default-description: Default will not filter by any lifecycleState. x-obmcs-enumref: '#/definitions/NodeReplaceConfiguration/lifecycleState' schema: type: string responses: DefaultError: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a request, provide this request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DefaultError' 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 request, provide this 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 non-negative integer number representing the number of seconds the client should wait before polling this endpoint again. ' format: int32 type: number x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. For example, `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For 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. For example, `{"bar-key": "value"}` ' type: object x-oracle-package: com.oracle.bds