Oracle Oci Cache Default Config Set API

openapi: 3.2.0
info:
  description: Use the OCI Cache API to create and manage clusters. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm).
  title: OCI Cache Oci Cache Default Config Set API
  version: '20220315'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/0c0709de34f2014ed9d1948ceeb3f59f7c24fee03209fa8269bdb6c37117b40d.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OCI Cache 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/0c0709de34f2014ed9d1948ceeb3f59f7c24fee03209fa8269bdb6c37117b40d.yaml
    what: the harvested document for OCI Cache API
servers:
- url: http://127.0.0.1/20220315
- url: https://127.0.0.1/20220315
tags:
- name: ociCacheDefaultConfigSet
paths:
  /ociCacheDefaultConfigSets:
    get:
      description: Lists the OCI Cache Default Config Sets in the specified compartment.
      operationId: ListOciCacheDefaultConfigSets
      parameters:
      - $ref: '#/components/parameters/CompartmentIdRequiredQueryParam'
      - $ref: '#/components/parameters/OciCacheDefaultConfigSetIdentifierQueryParam'
      - $ref: '#/components/parameters/OciCacheDefaultConfigSetLifecycleStateQueryParam'
      - $ref: '#/components/parameters/SoftwareVersionQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

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

                subsequent GET request to get the next batch of items.

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

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

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OciCacheDefaultConfigSetCollection'
        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: Return a list of OCI Cache Default Config Set.
      tags:
      - ociCacheDefaultConfigSet
      x-related-resource: '#/definitions/OciCacheDefaultConfigSetSummary'
  /ociCacheDefaultConfigSets/{ociCacheDefaultConfigSetId}:
    get:
      description: Retrieves the specified OCI Cache Default Config Set.
      operationId: GetOciCacheDefaultConfigSet
      parameters:
      - $ref: '#/components/parameters/CompartmentIdRequiredQueryParam'
      - $ref: '#/components/parameters/OciCacheDefaultConfigSetIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Successfully retrieved the OCI Cache Default Config Set.
          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/OciCacheDefaultConfigSet'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get a OCI Cache Default Config Set by OCID.
      tags:
      - ociCacheDefaultConfigSet
      x-related-resource: '#/definitions/OciCacheDefaultConfigSet'
components:
  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'
  parameters:
    OciCacheDefaultConfigSetIdentifierQueryParam:
      description: Unique OCI Cache Default Config Set identifier.
      in: query
      name: id
      x-default-description: 'null'
      schema:
        type: string
    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
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    DisplayNameQueryParam:
      description: A filter to return only resources that match the entire display name given.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    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
        - displayName
        default: timeCreated
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      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
    SoftwareVersionQueryParam:
      description: A filter to return the OCI Cache Config Set resources, whose software version matches with the given software version.
      in: query
      name: softwareVersion
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/OciCacheConfigSet/softwareVersion'
      schema:
        type: string
    OciCacheDefaultConfigSetIdentifierPathParam:
      description: Unique OCI Cache Default Config Set identifier.
      in: path
      name: ociCacheDefaultConfigSetId
      required: true
      schema:
        type: string
    OciCacheDefaultConfigSetLifecycleStateQueryParam:
      description: A filter to return the OCI Cache Default Config Set resources, whose lifecycle state matches with the given lifecycle state.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/OciCacheDefaultConfigSet/lifecycleState'
      schema:
        type: string
    CompartmentIdRequiredQueryParam:
      description: The unique identifier for the compartment.
      in: query
      name: compartmentId
      required: true
      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
  schemas:
    OciCacheDefaultConfigSet:
      description: Default configurations for OCI Cache to manage the behavior, performance, and functionality of the underlying cache engine.
      properties:
        defaultConfigurationDetails:
          $ref: '#/components/schemas/DefaultConfigurationDetails'
        description:
          description: Description of the OCI Cache Default Config Set.
          type: string
        displayName:
          description: A user-friendly name of the OCI Cache Default Config Set.
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the OCI Cache Default Config Set.
          type: string
        lifecycleState:
          description: The current state of the OCI Cache Default Config Set.
          enum:
          - ACTIVE
          - INACTIVE
          type: string
        softwareVersion:
          description: The engine version of the OCI Cache Default Config Set.
          type: string
          x-obmcs-enumref: '#/definitions/OciCacheConfigSet/softwareVersion'
        timeCreated:
          description: The date and time the OCI Cache Default Config Set was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - softwareVersion
      type: object
    OciCacheDefaultConfigSetCollection:
      description: A list of OCI Cache Default Config Sets.
      properties:
        items:
          description: List of OCI Cache Default Config Sets.
          items:
            $ref: '#/components/schemas/OciCacheDefaultConfigSetSummary'
          type: array
      required:
      - items
      type: object
    DefaultConfigurationDetails:
      description: List of OCI Cache Default Config Set Values.
      properties:
        items:
          description: List of DefaultConfigurationInfo objects.
          items:
            $ref: '#/components/schemas/DefaultConfigurationInfo'
          type: array
      required:
      - items
      type: object
    Error:
      description: Specifies details for an error.
      properties:
        code:
          description: A machine-usable code for the error that occured.
          type: string
        message:
          description: A human-readable error string for the error that occured.
          type: string
      required:
      - code
      - message
    DefaultConfigurationInfo:
      description: Details of a configuration setting in the OCI Cache Default Config Set.
      properties:
        allowedValues:
          description: Allowed values for the configuration setting.
          type: string
        configKey:
          description: The key of the configuration setting.
          type: string
        dataType:
          description: The data type of the configuration setting.
          type: string
        defaultConfigValue:
          description: The default value for the configuration setting.
          type: string
        description:
          description: Description of the configuration setting.
          type: string
        isModifiable:
          description: Indicates if the configuration is modifiable.
          type: boolean
      required:
      - configKey
      - defaultConfigValue
      - dataType
      - isModifiable
      type: object
    OciCacheDefaultConfigSetSummary:
      description: Summary of information about an OCI Cache Default Config Set.
      properties:
        displayName:
          description: A user-friendly name of the OCI Cache Default Config Set.
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the OCI Cache Default Config Set.
          type: string
        lifecycleState:
          description: The current state of the OCI Cache Default Config Set.
          type: string
          x-obmcs-enumref: '#/definitions/OciCacheDefaultConfigSet/lifecycleState'
        softwareVersion:
          description: The engine version of the OCI Cache Default Config Set.
          type: string
          x-obmcs-enumref: '#/definitions/OciCacheConfigSet/softwareVersion'
        timeCreated:
          description: The date and time the configuration was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - softwareVersion
      type: object
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

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

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

        subsequent GET request to get the next batch of items.

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

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

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

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

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

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

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

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

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

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

        '
      type: object
    securityAttributes:
      additionalProperties:
        additionalProperties:
          description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".

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


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

          '
        type: object
      description: 'Security attributes for redis cluster resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


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

        '
      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-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.pic.redisservice