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 Redis Cluster 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: redisCluster paths: /redisClusters: get: description: 'Lists the OCI Cache clusters in the specified compartment. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). ' operationId: ListRedisClusters parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RedisClusterIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RedisClusterCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all clusters in a compartment tags: - redisCluster x-related-resource: '#/definitions/RedisClusterSummary' post: description: 'Creates a new OCI Cache cluster. A cluster is a memory-based storage solution. You can optionally initialize the cluster data by restoring from an OCI Cache Backup (backupId) or by importing from Object Storage RDB file(s) (importFromObjectStorageDetails). For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). ' operationId: CreateRedisCluster parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted for creating a cluster. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a 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/RedisCluster' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new RedisCluster tags: - redisCluster x-related-resource: '#/definitions/RedisCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRedisClusterDetails' description: Details for the new cluster. required: true /redisClusters/{redisClusterId}: delete: description: Deletes the specified OCI Cache cluster. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). operationId: DeleteRedisCluster parameters: - $ref: '#/components/parameters/RedisClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted for deleting the cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned cluster tags: - redisCluster x-related-resource: '#/definitions/RedisCluster' get: description: Retrieves the specified OCI Cache cluster. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). operationId: GetRedisCluster parameters: - $ref: '#/components/parameters/RedisClusterIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the cluster. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RedisCluster' 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 RedisCluster tags: - redisCluster put: description: Updates the specified OCI Cache cluster. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). operationId: UpdateRedisCluster parameters: - $ref: '#/components/parameters/RedisClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted for updating the cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the RedisCluster identified by the id tags: - redisCluster x-related-resource: '#/definitions/RedisCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRedisClusterDetails' description: The information to be updated. required: true /redisClusters/{redisClusterId}/actions/attachOciCacheUsers: post: description: Attach existing OCI cache users to a redis cluster. operationId: AttachOciCacheUsers parameters: - $ref: '#/components/parameters/RedisClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted to attach OCI cache users to redis cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Attach existing OCI cache users to a redis cluster. tags: - redisCluster x-related-resource: '#/definitions/RedisCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachOciCacheUsersDetails' description: The parameter details to attach the OCI cache users to the redis cluster. required: true /redisClusters/{redisClusterId}/actions/changeCompartment: post: description: Moves an OCI Cache cluster into a different compartment within the same tenancy. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). operationId: ChangeRedisClusterCompartment parameters: - $ref: '#/components/parameters/RedisClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted for moving the cluster to a different compartment. 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 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' summary: Moves a resource into a different compartment. tags: - redisCluster x-related-resource: '#/definitions/RedisCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRedisClusterCompartmentDetails' description: The information to be updated. required: true /redisClusters/{redisClusterId}/actions/detachOciCacheUsers: post: description: Detach existing OCI cache users to a redis cluster. operationId: DetachOciCacheUsers parameters: - $ref: '#/components/parameters/RedisClusterIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted to detach OCI cache users to redis cluster. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Detach existing OCI cache users to a redis cluster. tags: - redisCluster x-related-resource: '#/definitions/RedisCluster' requestBody: content: application/json: schema: $ref: '#/components/schemas/DetachOciCacheUsersDetails' description: The parameter details to detach the OCI cache users to the redis cluster. required: true /redisClusters/{redisClusterId}/actions/getOciCacheUsers: post: description: Gets a list of associated OCI cache users for a redis cluster. operationId: ListAttachedOciCacheUsers parameters: - $ref: '#/components/parameters/RedisClusterIdentifierPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of AttachedOciCacheUser of the OciCacheCluster. 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/AttachedOciCacheUser' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List associated OCI cache users for a redis cluster. tags: - redisCluster x-related-resource: '#/definitions/AttachedOciCacheUser' /redisClusters/{redisClusterId}/nodes: get: description: 'Gets the list of all nodes in a cluster. ' operationId: ListRedisClusterNodes parameters: - $ref: '#/components/parameters/RedisClusterIdentifierPathParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of cluster nodes 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/RedisNodeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of nodes in a cluster tags: - redisCluster x-related-resource: '#/definitions/NodeSummary' /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' 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/WorkRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List Work Requests tags: - redisCluster x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancels the specified work request. operationId: CancelWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The work request will be cancelled. 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel the work request tags: - redisCluster x-related-resource: '#/definitions/WorkRequest' get: description: Gets the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: 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 retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GET Work Request Status tags: - redisCluster x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - redisCluster x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - redisCluster x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: ImportOciCacheFromObjectStorageObject: description: An object to import from the specified bucket. properties: objectName: description: The name of the object in the bucket (for example, 'customerA/exports/backup_ocid/dump.rdb'). maxLength: 1024 minLength: 1 type: string required: - objectName type: object NodeSummary: description: The details of each node in the cluster. properties: displayName: description: A user-friendly name of a cluster node. type: string privateEndpointFqdn: description: The fully qualified domain name (FQDN) of the API endpoint to access a specific node. type: string privateEndpointIpAddress: description: The private IP address of the API endpoint to access a specific node. type: string redisClusterId: description: The OCID of the cluster type: string shardNumber: description: The shard number to which the node belongs to. type: integer required: - privateEndpointFqdn - privateEndpointIpAddress - displayName - redisClusterId type: object AttachedOciCacheUser: description: OciCacheUser attached to the OciCacheCluster. properties: ociCacheUserId: description: 'OCID of the OciCacheUser ' maxLength: 255 minLength: 1 type: string required: - ociCacheUserId 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 AttachOciCacheUsersDetails: description: OCI cache user details to be attached with a cluster. properties: ociCacheUsers: description: List of OCI cache user unique IDs (OCIDs). items: type: string type: array required: - ociCacheUsers type: object Node: description: The details of each node in the cluster. properties: displayName: description: A user-friendly name of a cluster node. type: string privateEndpointFqdn: description: The fully qualified domain name (FQDN) of the API endpoint to access a specific node. type: string privateEndpointIpAddress: description: The private IP address of the API endpoint to access a specific node. type: string required: - privateEndpointFqdn - privateEndpointIpAddress - displayName type: object RedisClusterCollection: description: A list of clusters that match filter criteria, if any. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). properties: items: description: The list of clusters. items: $ref: '#/components/schemas/RedisClusterSummary' type: array required: - items type: object UpdateRedisClusterDetails: description: The configuration to update for an existing cluster. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object nodeCount: description: The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED. maximum: 5 minimum: 1 type: integer nodeMemoryInGBs: description: The amount of memory allocated to the cluster's nodes, in gigabytes. format: float maximum: 500 minimum: 2 type: number nsgIds: description: 'A list of Network Security Group (NSG) [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) associated with this cluster. For more information, see [Using an NSG for Clusters](/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array ociCacheConfigSetId: description: The ID of the corresponding OCI Cache Config Set for the cluster. type: string 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 shardCount: description: The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED. type: integer softwareVersion: description: The OCI Cache engine version that the cluster is running. example: VALKEY_7_2 type: string x-obmcs-enumref: '#/definitions/RedisCluster/softwareVersion' type: object RedisNodeCollection: description: A list of nodes in a cluster that match filter criteria, if any. properties: items: description: The list of nodes in a cluster. items: $ref: '#/components/schemas/NodeSummary' type: array required: - items type: object WorkRequestResource: description: The resources that are affected by the work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the `IN_PROGRESS` state until work is complete for that resource at which point it will transition to `CREATED`, `UPDATED`, or `DELETED`, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that you can use for a GET to access the resource metadata type: string identifier: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the resource the work request affects. type: string required: - actionType - entityType - identifier WorkRequestSummaryCollection: description: A list of work requests. properties: items: description: A collection of work requests. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object WorkRequestErrorCollection: description: A list of errors for a work request. properties: items: description: A collection of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object ChangeRedisClusterCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment into which the cluster should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object RedisCluster: description: An OCI Cache cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). properties: backupId: description: The ID of the OCI Cache Backup from which this cluster was created. type: string clusterMode: description: Specifies whether the cluster is sharded or non-sharded. enum: - SHARDED - NONSHARDED type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the cluster. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. 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 discoveryEndpointIpAddress: description: The private IP address of the API endpoint for sharded cluster discovery. type: string discoveryFqdn: description: The fully qualified domain name (FQDN) of the API endpoint for sharded cluster discovery. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. type: string importFromObjectStorageDetails: $ref: '#/components/schemas/ImportOciCacheFromObjectStorageDetails' lifecycleDetails: description: A message describing the current state in more detail. For example, the message might provide actionable information for a resource in `FAILED` state. type: string lifecycleState: description: The current state of the cluster. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string nodeCollection: $ref: '#/components/schemas/NodeCollection' nodeCount: description: The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED. maximum: 5 minimum: 1 type: integer nodeMemoryInGBs: description: The amount of memory allocated to the cluster's nodes, in gigabytes. format: float maximum: 500 minimum: 2 type: number nsgIds: description: 'A list of Network Security Group (NSG) [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) associated with this cluster. For more information, see [Using an NSG for Clusters](/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array ociCacheConfigSetId: description: The ID of the corresponding OCI Cache Config Set for the cluster. type: string primaryEndpointIpAddress: description: The private IP address of the API endpoint for the cluster's primary node. type: string primaryFqdn: description: The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node. type: string replicasEndpointIpAddress: description: The private IP address of the API endpoint for the cluster's replica nodes. type: string replicasFqdn: description: The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes. type: string 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 shardCount: description: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED. type: integer softwareVersion: description: The OCI Cache engine version that the cluster is running. enum: - V7_0_5 - VALKEY_7_2 type: string subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the cluster was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. format: date-time type: string timeUpdated: description: The date and time the cluster was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. format: date-time type: string required: - id - displayName - compartmentId - nodeCount - softwareVersion - nodeMemoryInGBs - nodeCollection - subnetId - primaryFqdn - primaryEndpointIpAddress - replicasFqdn - replicasEndpointIpAddress type: object WorkRequestSummary: description: A description of the work request status. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. ' 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 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](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the work request. type: string operationType: description: The type of operation that spawned the work request. enum: - CREATE_REDIS_CLUSTER - UPDATE_REDIS_CLUSTER - DELETE_REDIS_CLUSTER - MOVE_REDIS_CLUSTER - FAILOVER_REDIS_CLUSTER - CREATE_REDIS_CONFIG_SET - UPDATE_REDIS_CONFIG_SET - DELETE_REDIS_CONFIG_SET - MOVE_REDIS_CONFIG_SET - MIGRATE_CLUSTER - CLUSTER_ROLLBACK - ATTACH_OCI_CACHE_USERS - DETACH_OCI_CACHE_USERS - CREATE_OCI_CACHE_USER - UPDATE_OCI_CACHE_USER - DELETE_OCI_CACHE_USER - CREATE_OCI_CACHE_CONFIG_SET - UPDATE_OCI_CACHE_CONFIG_SET - DELETE_OCI_CACHE_CONFIG_SET - CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT - CHANGE_OCI_CACHE_USER_COMPARTMENT - CREATE_OCI_CACHE_BACKUP - UPDATE_OCI_CACHE_BACKUP - DELETE_OCI_CACHE_BACKUP - MOVE_OCI_CACHE_BACKUP - EXPORT_OCI_CACHE_BACKUP_TO_OS - PATCH_OCI_CACHE_CLUSTER - REPLACE_OCI_CACHE_NODE type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request completed, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted WorkRequestError: description: An error encountered while executing an operation that is tracked by a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed at [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string for the error that occured. type: string timestamp: description: The time and time the error occured. format: date-time type: string required: - code - message - timestamp RedisClusterSummary: description: 'Summary of information about a cluster. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). ' properties: backupId: description: The ID of the OCI Cache Backup from which this cluster was created. type: string clusterMode: description: Specifies whether the cluster is sharded or non-sharded. type: string x-obmcs-enumref: '#/definitions/RedisCluster/clusterMode' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the cluster. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. 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 discoveryEndpointIpAddress: description: The private IP address of the API endpoint for shareded cluster discovery. type: string discoveryFqdn: description: The fully qualified domain name (FQDN) of the API endpoint for sharded cluster discovery. type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, the message might provide actionable information for a resource in `FAILED` state. type: string lifecycleState: description: The current state of the cluster. type: string x-obmcs-enumref: '#/definitions/RedisCluster/lifecycleState' nodeCount: description: The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED. maximum: 5 minimum: 1 type: integer nodeMemoryInGBs: description: The amount of memory allocated to the cluster's nodes, in gigabytes. format: float maximum: 500 minimum: 2 type: number nsgIds: description: 'A list of Network Security Group (NSG) [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) associated with this cluster. For more information, see [Using an NSG for Clusters](/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array ociCacheConfigSetId: description: The ID of the corresponding OCI Cache Config Set for the cluster. type: string primaryEndpointIpAddress: description: The private IP address of the API endpoint for the cluster's primary node. type: string primaryFqdn: description: The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node. type: string replicasEndpointIpAddress: description: The private IP address of the API endpoint for the cluster's replica nodes. type: string replicasFqdn: description: The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes. type: string 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 shardCount: description: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED. type: integer softwareVersion: description: The OCI Cache engine version that the cluster is running. type: string x-obmcs-enumref: '#/definitions/RedisCluster/softwareVersion' subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the cluster was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. format: date-time type: string timeUpdated: description: The date and time the cluster was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. format: date-time type: string required: - id - compartmentId - nodeCount - displayName - softwareVersion - nodeMemoryInGBs - subnetId - primaryFqdn - primaryEndpointIpAddress - replicasFqdn - replicasEndpointIpAddress type: object DetachOciCacheUsersDetails: description: OCI cache user details to be detached with a cluster. properties: ociCacheUsers: description: List of OCI cache user unique IDs (OCIDs). items: type: string type: array required: - ociCacheUsers type: object WorkRequestLogEntry: description: A log message from executing an operation that is tracked by a work request. properties: message: description: A human-readable log message. type: string timestamp: description: The date and time the log message was written. format: date-time type: string required: - message - timestamp ImportOciCacheFromObjectStorageDetails: description: Details for importing OCI Cache data from Object Storage RDB file(s) during cluster creation. properties: bucketName: description: The Object Storage bucket name. maxLength: 256 minLength: 1 type: string namespaceName: description: The Object Storage namespace name. maxLength: 256 minLength: 1 type: string objects: description: The list of objects to import from the specified bucket. items: $ref: '#/components/schemas/ImportOciCacheFromObjectStorageObject' maxItems: 1024 minItems: 1 type: array required: - namespaceName - bucketName - objects type: object NodeCollection: description: The collection of cluster nodes. properties: items: description: Collection of node objects. items: $ref: '#/components/schemas/Node' type: array required: - items type: object CreateRedisClusterDetails: description: The configuration details for a new OCI Cache cluster. An OCI Cache cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). properties: backupId: description: The ID of the OCI Cache Backup from which this cluster was created.Mutually exclusive with 'importFromObjectStorageDetails'. type: string clusterMode: description: Specifies whether the cluster is sharded or non-sharded. example: NONSHARDED type: string x-obmcs-enumref: '#/definitions/RedisCluster/clusterMode' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the cluster. 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 displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object importFromObjectStorageDetails: $ref: '#/components/schemas/ImportOciCacheFromObjectStorageDetails' nodeCount: description: The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED. maximum: 5 minimum: 1 type: integer nodeMemoryInGBs: description: The amount of memory allocated to the cluster's nodes, in gigabytes. format: float maximum: 500 minimum: 2 type: number nsgIds: description: 'A list of Network Security Group (NSG) [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) associated with this cluster. For more information, see [Using an NSG for Clusters](/iaas/Content/ocicache/connecttocluster.htm#connecttocluster__networksecuritygroup). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array ociCacheConfigSetId: description: The ID of the corresponding OCI Cache Config Set for the cluster. type: string 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 shardCount: description: The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED. type: integer softwareVersion: description: The OCI Cache engine version that the cluster is running. example: REDIS_7_0 type: string x-obmcs-enumref: '#/definitions/RedisCluster/softwareVersion' subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster's subnet. type: string required: - displayName - compartmentId - nodeCount - nodeMemoryInGBs - subnetId - softwareVersion type: object WorkRequestLogEntryCollection: description: A list of logs for the specified work request. properties: items: description: A collection of work request logs. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object WorkRequest: description: An asynchronous work request. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the work request. type: string operationType: description: The type of operation that spawned the work request. enum: - CREATE_REDIS_CLUSTER - UPDATE_REDIS_CLUSTER - DELETE_REDIS_CLUSTER - MOVE_REDIS_CLUSTER - FAILOVER_REDIS_CLUSTER - CREATE_REDIS_CONFIG_SET - UPDATE_REDIS_CONFIG_SET - DELETE_REDIS_CONFIG_SET - MOVE_REDIS_CONFIG_SET - MIGRATE_CLUSTER - CLUSTER_ROLLBACK - ATTACH_OCI_CACHE_USERS - DETACH_OCI_CACHE_USERS - CREATE_OCI_CACHE_USER - UPDATE_OCI_CACHE_USER - DELETE_OCI_CACHE_USER - CREATE_OCI_CACHE_CONFIG_SET - UPDATE_OCI_CACHE_CONFIG_SET - DELETE_OCI_CACHE_CONFIG_SET - CHANGE_OCI_CACHE_CONFIG_SET_COMPARTMENT - CHANGE_OCI_CACHE_USER_COMPARTMENT - CREATE_OCI_CACHE_BACKUP - UPDATE_OCI_CACHE_BACKUP - DELETE_OCI_CACHE_BACKUP - MOVE_OCI_CACHE_BACKUP - EXPORT_OCI_CACHE_BACKUP_TO_OS - PATCH_OCI_CACHE_CLUSTER - REPLACE_OCI_CACHE_NODE type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: The percentage complete of the operation tracked by the work request. format: float type: number resources: description: The resources that are affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request completed, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted 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 x-default-description: 'null' 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 - displayName default: timeCreated RedisClusterIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. in: path name: redisClusterId required: true schema: type: string ResourceIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' 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 WorkRequestStatusQueryParam: description: A filter to return only resources their lifecycleState matches the given OperationStatus. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 LifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/RedisCluster/lifecycleState' schema: type: string WorkRequestIdPathParam: description: The the asynchronous request ID. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-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 WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' 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 RedisClusterIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the cluster. in: query name: id x-default-description: 'null' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object 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