openapi: 3.2.0
info:
  description: Use the Globally Distributed Database service APIs to create and manage the Globally distributed databases.
  title: Globally Distributed Database Distributed Db Private Endpoint Service API
  version: '20250101'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/7768559c5720cb1b8396abdb1463b1ad39f9b837f25af9d8852377ad772e93bf.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Globally Distributed Database 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/7768559c5720cb1b8396abdb1463b1ad39f9b837f25af9d8852377ad772e93bf.yaml
    what: the harvested document for Globally Distributed Database
servers:
- url: https://127.0.0.1/20250101
tags:
- name: DistributedDbPrivateEndpointService
paths:
  /distributedDatabasePrivateEndpoints:
    get:
      description: 'List of DistributedDatabasePrivateEndpoints.

        '
      operationId: ListDistributedDatabasePrivateEndpoints
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DistributedDatabasePrivateEndpointLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DistributedDatabasePrivateEndpointDisplayNameQueryParam'
      responses:
        200:
          description: A page of DistributedDatabasePrivateEndpoint objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedDatabasePrivateEndpointCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List of DistributedDatabasePrivateEndpoints.
      tags:
      - DistributedDbPrivateEndpointService
      x-example: 'GET /20250101/distributedDatabasePrivateEndpoints?compartmentId=<compartmentId>

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    post:
      description: 'Creates a DistributedDatabasePrivateEndpoint.

        '
      operationId: CreateDistributedDatabasePrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: The DistributedDatabasePrivateEndpoint resource creation request is accepted and being processed.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedDatabasePrivateEndpoint'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a DistributedDatabasePrivateEndpoint.
      tags:
      - DistributedDbPrivateEndpointService
      x-example: "POST /20250101/distributedDatabasePrivateEndpoints\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n  \"displayName\": \"pe0001\",\n  \"subnetId\": \"ocid1.subnet.oc1.iad.<unique_ID>\",\n  \"freeformTags\" : {\n    \"tagKey\" : \"value\"\n  },\n  \"definedTags\" : {\n    \"namespace\" : {\n      \"key\" : \"value\"\n    }\n  }\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDistributedDatabasePrivateEndpointDetails'
        description: Details of DistributedDatabasePrivateEndpoint to be created.
        required: true
  /distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}:
    delete:
      description: 'Deletes the given DistributedDatabasePrivateEndpoint.

        '
      operationId: DeleteDistributedDatabasePrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/DistributedDatabasePrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: No Content
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes the DistributedDatabasePrivateEndpoint identified by the identifier.
      tags:
      - DistributedDbPrivateEndpointService
      x-example: 'DELETE /20250101/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/DistributedDatabasePrivateEndpoint'
    get:
      description: 'Get the DistributedDatabasePrivateEndpoint resource.

        '
      operationId: GetDistributedDatabasePrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/DistributedDatabasePrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/IfNoneMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Details of DistributedDatabasePrivateEndpoint identified by the given ocid.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedDatabasePrivateEndpoint'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets details of the DistributedDatabasePrivateEndpoint.
      tags:
      - DistributedDbPrivateEndpointService
      x-example: 'GET /20250101/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: 'Updates the configuration of DistributedDatabasePrivateEndpoint.

        '
      operationId: UpdateDistributedDatabasePrivateEndpoint
      parameters:
      - $ref: '#/components/parameters/DistributedDatabasePrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: Update private endpoint request is processed.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedDatabasePrivateEndpoint'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the configuration of DistributedDatabasePrivateEndpoint.
      tags:
      - DistributedDbPrivateEndpointService
      x-example: "PUT /20250101/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\nNOTE: Below is the payload for update private endpoint.\n{\n  \"displayName\": \"<new-display-name>\",\n  \"freeformTags\" : {\n    \"tagKey\" : \"value\"\n  },\n  \"definedTags\" : {\n    \"namespace\" : {\n      \"key\" : \"value\"\n    }\n  }\n}\n"
      x-related-resource: '#/definitions/DistributedDatabasePrivateEndpoint'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDistributedDatabasePrivateEndpointDetails'
        description: The configuration of private endpoint to be updated.
        required: true
  /distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}/actions/changeCompartment:
    post:
      description: 'Moves the DistributedDatabasePrivateEndpoint to the specified compartment.

        '
      operationId: ChangeDistributedDatabasePrivateEndpointCompartment
      parameters:
      - $ref: '#/components/parameters/DistributedDatabasePrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: The request was successfully received and the change compartment action for private endpoint is being performed.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Changes the compartment of DistributedDatabasePrivateEndpoint.
      tags:
      - DistributedDbPrivateEndpointService
      x-example: "POST /20250101/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}/actions/changeCompartment\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
      x-related-resource: '#/definitions/DistributedDatabasePrivateEndpoint'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDistributedDatabasePrivateEndpointCompartmentDetails'
        description: Request to move the private endpoint to a different compartment.
        required: true
  /distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}/actions/reinstateProxyInstance:
    post:
      description: 'Reinstates the proxy instance associated with the DistributedDatabasePrivateEndpoint.

        '
      operationId: ReinstateProxyInstance
      parameters:
      - $ref: '#/components/parameters/DistributedDatabasePrivateEndpointIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: The request was successfully received and the reinstate proxy instance action for private endpoint is being performed.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Reinstate the Proxy Instance associated with the DistributedDatabasePrivateEndpoint.
      tags:
      - DistributedDbPrivateEndpointService
      x-example: 'POST /20250101/distributedDatabasePrivateEndpoints/{distributedDatabasePrivateEndpointId}/actions/reinstateProxyInstance

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabasePrivateEndpoint'
components:
  schemas:
    DistributedDatabasePrivateEndpointCollection:
      description: Collection of private endpoints.
      properties:
        items:
          description: Array of private endpoint summaries.
          items:
            $ref: '#/components/schemas/DistributedDatabasePrivateEndpointSummary'
          type: array
      required:
      - items
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    DistributedDatabasePrivateEndpointSummary:
      description: DistributedDatabasePrivateEndpoint resource summary.
      properties:
        compartmentId:
          description: Identifier of the compartment where private endpoint exists.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: DistributedDatabasePrivateEndpoint description.
          maxLength: 1024
          minLength: 0
          type: string
        displayName:
          description: Private endpoint display name.
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_]((?!.*[-]{2})[a-zA-Z0-9_-]{0,254})$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: DistributedDatabasePrivateEndpoint identifier
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: Detailed message for the lifecycle state.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of private endpoint.
          type: string
          x-obmcs-enumref: '#/definitions/DistributedDatabasePrivateEndpoint/lifecycleState'
        nsgIds:
          description: 'The OCIDs of the network security groups that the private endpoint belongs to.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 250
          type: array
          uniqueItems: true
        subnetId:
          description: Identifier of the customer subnet against which private endpoint is created.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time the the private endpoint was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the private endpoint was last updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
        vcnId:
          description: Identifier of the VCN in which subnet exists.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - compartmentId
      - subnetId
      - vcnId
      - displayName
      - timeCreated
      - timeUpdated
      - lifecycleState
    UpdateDistributedDatabasePrivateEndpointDetails:
      description: The details of private endpoint to be updated.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: DistributedDatabasePrivateEndpoint description.
          maxLength: 1024
          minLength: 0
          type: string
        displayName:
          description: Display name for DistributedDatabasePrivateEndpoint
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_]((?!.*[-]{2})[a-zA-Z0-9_-]{0,254})$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        nsgIds:
          description: 'The OCIDs of the network security groups that the private endpoint belongs to.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 250
          type: array
          uniqueItems: true
      type: object
    CreateDistributedDatabasePrivateEndpointDetails:
      description: Details required for private endpoint creation.
      properties:
        compartmentId:
          description: Identifier of the compartment where private endpoint is to be created.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: DistributedDatabasePrivateEndpoint description.
          maxLength: 1024
          minLength: 0
          type: string
        displayName:
          description: Private endpoint display name.
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_]((?!.*[-]{2})[a-zA-Z0-9_-]{0,254})$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        nsgIds:
          description: 'The OCIDs of the network security groups that the private endpoint belongs to.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 250
          type: array
          uniqueItems: true
        subnetId:
          description: Identifier of the customer subnet against which private endpoint is to be created.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      - displayName
      - subnetId
      type: object
    DistributedDatabaseAssociatedWithPrivateEndpoint:
      description: 'This field is deprecated. Support for this field will be removed after Mon, 1 Mar 2027 00:00:00 GMT.

        '
      properties:
        dbDeploymentType:
          description: The dbDeploymentType associated with the distributed database.
          type: string
          x-obmcs-enumref: '#/definitions/DistributedDatabase/dbDeploymentType'
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the distributed database.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - dbDeploymentType
    DistributedAutonomousDatabaseAssociatedWithPrivateEndpoint:
      description: 'This field is deprecated. Support for this field will be removed after Mon, 1 Mar 2027 00:00:00 GMT.

        '
      properties:
        dbDeploymentType:
          description: The dbDeploymentType associated with the distributed autonomous database.
          type: string
          x-obmcs-enumref: '#/definitions/DistributedAutonomousDatabase/dbDeploymentType'
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the distributed database.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - dbDeploymentType
    DistributedDatabasePrivateEndpoint:
      description: DistributedDatabasePrivateEndpoint resource.
      properties:
        compartmentId:
          description: Identifier of the compartment in which private endpoint exists.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: DistributedDatabasePrivateEndpoint description.
          maxLength: 1024
          minLength: 0
          type: string
        displayName:
          description: DistributedDatabasePrivateEndpoint display name.
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_]((?!.*[-]{2})[a-zA-Z0-9_-]{0,254})$
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        globallyDistributedAutonomousDatabases:
          description: 'This field is deprecated. Support for this field will be removed after Mon, 1 Mar 2027 00:00:00 GMT.

            '
          items:
            $ref: '#/components/schemas/DistributedAutonomousDatabaseAssociatedWithPrivateEndpoint'
          maxItems: 250
          type: array
        globallyDistributedDatabases:
          description: 'This field is deprecated. Support for this field will be removed after Mon, 1 Mar 2027 00:00:00 GMT.

            '
          items:
            $ref: '#/components/schemas/DistributedDatabaseAssociatedWithPrivateEndpoint'
          maxItems: 250
          type: array
        id:
          description: The identifier of the Private Endpoint.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: Detailed message for the lifecycle state.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle states for private endpoint.
          enum:
          - ACTIVE
          - FAILED
          - INACTIVE
          - DELETING
          - DELETED
          - UPDATING
          - CREATING
          type: string
        nsgIds:
          description: 'The OCIDs of the network security groups that the private endpoint belongs to.

            '
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 250
          type: array
          uniqueItems: true
        privateIp:
          description: IP address of the Private Endpoint.
          maxLength: 20
          minLength: 1
          type: string
        proxyComputeInstanceId:
          description: The identifier of the proxy compute instance.
          maxLength: 255
          minLength: 1
          type: string
        subnetId:
          description: Identifier of the subnet in which private endpoint exists.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time the DistributedDatabasePrivateEndpoint was first created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
        vcnId:
          description: Identifier of the VCN in which subnet exists.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - compartmentId
      - subnetId
      - vcnId
      - displayName
      - timeCreated
      - timeUpdated
      - lifecycleState
    ChangeDistributedDatabasePrivateEndpointCompartmentDetails:
      description: 'The configuration details for moving the resource for private endpoint to other compartment.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
  parameters:
    PaginationTokenQueryParam:
      description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - timeUpdated
        default: timeCreated
    IfNoneMatchHeader:
      description: 'For conditional requests. In the GET call for a resource, set the

        `If-None-Match` header to the value of the ETag from a previous GET (or

        POST or PUT) response for that resource. The server will return with

        either a 304 Not Modified response if the resource has not changed, or a

        200 OK response with the updated representation.

        '
      in: header
      name: if-none-match
      required: false
      x-default-description: 'null'
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      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
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    DistributedDatabasePrivateEndpointDisplayNameQueryParam:
      description: A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
      in: query
      name: displayName
      required: false
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'ASC' or 'DESC'.
      in: query
      name: sortOrder
      x-default-description: 'The default value depends upon `sortBy`, and

        in general is ''DESC'' when sorting by time and ''ASC'' otherwise.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    DistributedDatabasePrivateEndpointIdentifierPathParam:
      description: Distributed Database PrivateEndpoint identifier
      in: path
      name: distributedDatabasePrivateEndpointId
      required: true
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    DistributedDatabasePrivateEndpointLifecycleStateQueryParam:
      description: A filter to return only resources their lifecycleState matches the given lifecycleState.
      in: query
      name: lifecycleState
      required: false
      x-obmcs-enumref: '#/definitions/DistributedDatabasePrivateEndpoint/lifecycleState'
      schema:
        type: string
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  distributedAutonomousDbDeploymentType:
    description: 'The distributed autonomous database deployment type.

      '
    enum:
    - ADB_D
    type: string
  distributedAutonomousDbLifecycleState:
    description: Lifecycle states for the Globally distributed autonomous database.
    enum:
    - ACTIVE
    - FAILED
    - NEEDS_ATTENTION
    - INACTIVE
    - DELETING
    - DELETED
    - UPDATING
    - CREATING
    type: string
  distributedAutonomousDbSource:
    description: 'The source of Globally distributed autonomous database type: Use ADB_D for the Globally distributed autonomous database with

      autonomous dedicated cloudautonomousvmclusters.

      '
    enum:
    - ADB_D
    type: string
  distributedDbDeploymentType:
    description: 'The distributed database deployment type.

      '
    enum:
    - EXADB_XS
    type: string
  distributedDbLifecycleState:
    description: Lifecycle states for the Globally distributed database.
    enum:
    - ACTIVE
    - FAILED
    - NEEDS_ATTENTION
    - INACTIVE
    - DELETING
    - DELETED
    - UPDATING
    - CREATING
    type: string
  distributedDbSource:
    description: 'Type of Globally distributed database Shard or Catalog.

      Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch.

      Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters.

      EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle.

      '
    enum:
    - EXADB_XS
    - NEW_VAULT_AND_CLUSTER
    - EXISTING_CLUSTER
    type: string
  freeformTags:
    additionalProperties:
      type: string
    description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

      Example: `{"bar-key": "value"}`

      '
    type: object
  systemTags:
    additionalProperties:
      additionalProperties:
        description: 'The value of the tag. Only string, integer and boolean types are supported.

          '
        type: object
      description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

        Example: `{"bar-key": "value"}`

        '
      type: object
    description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

      Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

      '
    type: object
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string type is supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.distributeddb