Oracle Replicas API

The replicas API from Oracle — 2 operation(s) for replicas.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-replicas-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: The API for the MySQL Database Service
  license:
    name: Oracle Corporation
  title: MySQL Database Service Replicas API
  version: '20190415'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the MySQL Database 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/c21bc5da8ceddf436da4e56b2328b97fa65fa6675d07108e7a0447de3e832a0a.yaml
    what: the harvested document for MySQL Database Service API
servers:
- url: http://mysql.{region}.ocp.oraclecloud.com/20190415
tags:
- name: replicas
paths:
  /replicas:
    get:
      description: Lists all the read replicas that match the specified filters.
      operationId: ListReplicas
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
      - $ref: '#/components/parameters/FilterByDbSystemIdQueryParam'
      - $ref: '#/components/parameters/FilterByCompartmentIdQueryParam'
      - $ref: '#/components/parameters/FilterByReplicaLifecycleStateQueryParam'
      - $ref: '#/components/parameters/FilterByReplicaIdQueryParam'
      - $ref: '#/components/parameters/FilterByConfigurationIdQueryParam'
      - $ref: '#/components/parameters/FilterByConfigurationUpToDateQueryParam'
      - $ref: '#/components/parameters/SortByReplicaFieldQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: 'The list of read replicas that match the specified filters. A summary

            of the properties of the replica is shown for each replica listed.

            '
          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:
                items:
                  $ref: '#/components/schemas/ReplicaSummary'
                type: array
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists Read Replicas.
      tags:
      - replicas
      x-obmcs-client-retries-enabled: true
    post:
      description: Creates a DB System read replica.
      operationId: CreateReplica
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/OpcRetryTokenHeader'
      responses:
        201:
          description: The read replica create operation has been accepted for processing.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: The URI for the entity being described in the response body.
              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 request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Replica'
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        409:
          $ref: '#/components/responses/409-Conflict'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Creates a DB System Read Replica.
      tags:
      - replicas
      x-obmcs-client-retries-enabled: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReplicaDetails'
        description: The parameters of the request to create the read replica.
        required: true
  /replicas/{replicaId}:
    delete:
      description: Deletes the specified read replica.
      operationId: DeleteReplica
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/ReplicaIdPathParam'
      responses:
        202:
          description: The read replica delete action has been accepted for processing.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

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

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        409:
          $ref: '#/components/responses/409-Conflict'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Deletes a Read Replica.
      tags:
      - replicas
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Replica'
    get:
      description: Gets the full details of the specified read replica.
      operationId: GetReplica
      parameters:
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/IfNoneMatchHeader'
      - $ref: '#/components/parameters/ReplicaIdPathParam'
      responses:
        200:
          description: A detailed view of the read replica showing all its properties.
          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/Replica'
        304:
          $ref: '#/components/responses/304-NotModified'
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Gets a Read Replica.
      tags:
      - replicas
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the properties of the specified read replica.
      operationId: UpdateReplica
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      - $ref: '#/components/parameters/ReplicaIdPathParam'
      responses:
        202:
          description: The read replica update operation has been accepted for processing.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

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

                '
              schema:
                type: string
        304:
          $ref: '#/components/responses/304-NotModified'
        400:
          $ref: '#/components/responses/400-BadRequest'
        401:
          $ref: '#/components/responses/401-Unauthorized'
        404:
          $ref: '#/components/responses/404-NotFound'
        409:
          $ref: '#/components/responses/409-Conflict'
        412:
          $ref: '#/components/responses/412-PreconditionFailed'
        429:
          $ref: '#/components/responses/429-TooManyRequests'
        500:
          $ref: '#/components/responses/500-ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Updates a Replica.
      tags:
      - replicas
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Replica'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReplicaDetails'
        description: The parameters of the request to update the read replica.
        required: true
components:
  parameters:
    FilterByReplicaIdQueryParam:
      description: The read replica [OCID](/Content/General/Concepts/identifiers.htm).
      in: query
      name: replicaId
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationTokenQueryParam:
      description: 'The value of the `opc-next-page` or `opc-prev-page` response header from

        the previous list call. For information about pagination, see [List

        Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination).

        '
      in: query
      name: page
      schema:
        type: string
        maxLength: 4096
        minLength: 1
    FilterByConfigurationUpToDateQueryParam:
      description: 'Filter instances if they are using the latest revision of the

        Configuration they are associated with.

        '
      in: query
      name: isUpToDate
      required: false
      schema:
        type: boolean
        default: false
    FilterByReplicaLifecycleStateQueryParam:
      description: The LifecycleState of the read replica.
      in: query
      name: lifecycleState
      required: false
      x-obmcs-enumref: '#/definitions/ReplicaSummary/lifecycleState'
      schema:
        type: string
    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
      x-default-description: No conditional request is made.
      schema:
        type: string
    OpcRetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case

        of a timeout or server error without risk of executing that same action

        again. Retry tokens expire after 24 hours, but can be invalidated before

        then due to conflicting operations (for example, if a resource has been

        deleted and purged from the system, then a retry of the original

        creation request may be rejected).

        '
      in: header
      name: opc-retry-token
      schema:
        type: string
        maxLength: 64
        minLength: 1
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call for a

        resource, set the `If-Match` header 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
      schema:
        type: string
    FilterByCompartmentIdQueryParam:
      description: The compartment [OCID](/Content/General/Concepts/identifiers.htm).
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    FilterByDisplayNameQueryParam:
      description: A filter to return only the resource matching the given display name exactly.
      in: query
      name: displayName
      required: false
      schema:
        type: string
        maxLength: 255
    PaginationLimitQueryParam:
      description: 'The maximum number of items to return in a paginated list call. For information about pagination, see

        [List Pagination](../../../#API/Concepts/usingapi.htm#List_Pagination).

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    SortOrderQueryParam:
      description: The sort order to use (ASC or DESC).
      in: query
      name: sortOrder
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    FilterByConfigurationIdQueryParam:
      description: The requested Configuration instance.
      in: query
      name: configurationId
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    ReplicaIdPathParam:
      description: The Replica [OCID](/Content/General/Concepts/identifiers.htm).
      in: path
      name: replicaId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OpcRequestIdHeader:
      description: 'Customer-defined unique identifier for the request. If you need to

        contact Oracle about a specific request, please provide the request

        ID that you supplied in this header with the request.

        '
      in: header
      name: opc-request-id
      required: false
      schema:
        type: string
    FilterByDbSystemIdQueryParam:
      description: The DB System [OCID](/Content/General/Concepts/identifiers.htm).
      in: query
      name: dbSystemId
      required: false
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SortByReplicaFieldQueryParam:
      description: 'The field to sort by. You can sort by one field only. By default, the Time field is sorted in descending order and the Display Name field in ascending order.

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
  responses:
    409-Conflict:
      description: Conflict
      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'
    404-NotFound:
      description: Not Found
      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'
    400-BadRequest:
      description: Bad Request
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    500-ServerError:
      description: Internal Server 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'
    DefaultError:
      description: An error has occurred.
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    412-PreconditionFailed:
      description: Precondition Failed
      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'
    401-Unauthorized:
      description: Unauthorized
      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'
    304-NotModified:
      description: The resource with the given ETag has not changed.
      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
    429-TooManyRequests:
      description: Too Many Requests
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

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

            '
          schema:
            type: string
        retry-after:
          description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    SecureConnectionDetails:
      description: 'Secure connection configuration details.

        '
      properties:
        certificateGenerationType:
          default: SYSTEM
          description: 'Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).

            '
          enum:
          - SYSTEM
          - BYOC
          type: string
          x-obmcs-top-level-enum: '#/definitions/CertificateGenerationType'
        certificateId:
          description: The OCID of the certificate to use.
          maxLength: 255
          type: string
      required:
      - certificateGenerationType
    TelemetryConfigurationDetails:
      description: 'Telemetry configuration details of a DB System or a read replica.

        '
      properties:
        logs:
          description: Telemetry configuration details for logging.
          items:
            $ref: '#/components/schemas/LoggingDestinationConfiguration'
          maxItems: 10
          minItems: 1
          type: array
    EncryptDataDetails:
      description: 'Encrypt data details.

        '
      properties:
        keyGenerationType:
          default: SYSTEM
          description: Select whether to use Oracle-managed key (SYSTEM) or your own key (BYOK).
          enum:
          - SYSTEM
          - BYOK
          type: string
          x-obmcs-top-level-enum: '#/definitions/KeyGenerationType'
        keyId:
          description: The OCID of the key to use.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - keyGenerationType
    Error:
      description: Sorry.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    ReplicaOverrides:
      description: "By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. \nIf you want to override any of these, provide values in the properties, mysqlVersion, shapeName, \nand configurationId. If you set a property value to \"\", then the value is inherited from its \nsource DB system.\n"
      properties:
        configurationId:
          description: The OCID of the Configuration to be used by the read replica.
          maxLength: 255
          type: string
          x-default-description: 'If not specified by the user it will assume the value of the configurationId of

            the target DB System.

            '
        mysqlVersion:
          description: The MySQL version to be used by the read replica.
          type: string
          x-default-description: 'If not specified by the user it will assume the value of the mysqlVersion of

            the target DB System.

            '
        nsgIds:
          description: Network Security Group OCIDs used for the VNIC attachment.
          items:
            type: string
          maxItems: 5
          minItems: 0
          type: array
          uniqueItems: true
          x-default-description: "If not specified by the user it will assume the NSGs of the target \nDB System.\n"
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)

                '
              type: object
            description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.

              Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`

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

            For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).

            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`

            '
          type: object
        shapeName:
          description: "The shape to be used by the read replica. The shape determines the resources allocated: \nCPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. \nTo get a list of shapes, use the [ListShapes](#/en/mysql/20190415/ShapeSummary/ListShapes) operation.\n"
          maxLength: 255
          type: string
          x-default-description: 'If not specified by the user it will assume the value of the shape of

            the target DB System.

            '
        telemetryConfiguration:
          $ref: '#/components/schemas/TelemetryConfigurationDetails'
    ReplicaSummary:
      description: Summary of the read replica.
      properties:
        availabilityDomain:
          description: The name of the Availability Domain the read replica is located in.
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: The OCID of the compartment that contains the read replica.
          maxLength: 255
          minLength: 1
          type: string
          x-default-description: 'If not specified by the user it will assume the value of the compartment of

            the target DB System.

            '
        configurationId:
          description: The OCID of the Configuration currently in use by the read replica.
          maxLength: 255
          minLength: 1
          type: string
        dbSystemId:
          description: The OCID of the DB System the read replica is associated with.
          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.

              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: User provided description of the read replica.
          maxLength: 400
          minLength: 1
          type: string
        displayName:
          description: The user-friendly name for the read replica. It does not have to be unique.
          maxLength: 255
          minLength: 1
          type: string
        faultDomain:
          description: The name of the Fault Domain the read replica is located in.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

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

            '
          type: object
        id:
          description: The OCID of the read replica.
          maxLength: 255
          minLength: 1
          type: string
        ipAddress:
          description: 'The IP address the read replica is configured to listen on.

            '
          type: string
          x-default-description: "If you don't specify a value, Oracle automatically assigns a private IPv4 address from the subnet. The \nsubnet is choosen from the DB System.\n"
        ipv6Address:
          description: The IPv6 address the read replica is configured to listen on.
          maxLength: 45
          minLength: 1
          type: string
        isDeleteProtected:
          default: false
          description: "Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow.\nNote that if a read replica is delete protected it also prevents the entire DB System from being deleted. If\nthe DB System is delete protected, read replicas can still be deleted individually if they are not delete \nprotected themselves.\n"
          type: boolean
        lifecycleDetails:
          description: A message describing the state of the read replica.
          type: string
        lifecycleState:
          description: The state of the read replica.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - NEEDS_ATTENTION
          - FAILED
          type: string
        mysqlVersion:
          description: The MySQL version currently in use by the read replica.
          type: string
        nsgIds:
          description: Network Security Group OCIDs used for the VNIC attachment.
          items:
            type: string
          maxItems: 5
          minItems: 0
          type: array
          uniqueItems: true
        port:
          default: 3306
          description: The port the read replica is configured to listen on.
          maximum: 65535
          minimum: 1024
          type: integer
        portX:
          default: 33060
          description: 'The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.

            '
          maximum: 65535
          minimum: 1024
          type: integer
        replicaOverrides:
          $ref: '#/components/schemas/ReplicaOverrides'
        securityAttributes:
          additionalProperties:
            additionalProperties:
              description: 'Security Attribute value and mode. Only the String type is supported for value. (Mode is reserved and “enforce” in this release)

                '
              type: object
            description: 'Key-value pair representing a ZPR tag key and value, scoped to a namespace.

              Example: `{"MaxEgressCount": {"value": "42", "mode": "audit"}}`

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

            For more information, see [ZPR Artifacts](https://docs.oracle.com/en-us/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm).

            Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "audit"}}}`

            '
          type: object
        shapeName:
          description: "The shape currently in use by the read replica. The shape determines the resources allocated: \nCPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. \nTo get a list of shapes, use the [ListShapes](#/en/mysql/20190415/ShapeSummary/ListShapes) operation.\n"
          maxLength: 255
          minLength: 1
          type: string
        telemetryConfiguration:
          $ref: '#/components/schemas/TelemetryConfigurationDetails'
        timeCreated:
          description: 'The date and time the read replica was created, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The time the read replica was last updated, as described by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
      required:
      - id
      - dbSystemId
      - compartmentId
      - displayName
      - mysqlVersion
      - lifecycleState
      - timeCreated
      - ipAddress

# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-replicas-api-openapi.yml