openapi: 3.2.0
info:
description: 'Use the File Storage service API to manage file systems, mount targets, and snapshots.
For more information, see [Overview of File Storage](/iaas/Content/File/Concepts/filestorageoverview.htm).
'
license:
name: Oracle Corporation
title: File Storage API
version: '20171215'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/03910bbbf4069eae795fb5379eac310de31b96fcdda714cbe4aa8c55b597c9ae.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the File Storage 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/03910bbbf4069eae795fb5379eac310de31b96fcdda714cbe4aa8c55b597c9ae.yaml
what: the harvested document for File Storage API
servers:
- url: /20171215
tags:
- name: fileStorage
paths:
/exportSets:
get:
description: 'Lists the export set resources in the specified compartment.
'
operationId: ListExportSets
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/OcidQueryParam'
- $ref: '#/components/parameters/ExportSetSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/ExportSetSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListExportSets
tags:
- fileStorage
x-example: 'GET /20171215/exportSets?compartmentId=<compartmentId>&availabilityDomain=<availabilityDomain>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
/exportSets/{exportSetId}:
get:
description: Gets the specified export set's information.
operationId: GetExportSet
parameters:
- $ref: '#/components/parameters/ExportSetIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The export set was retrieved.
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/ExportSet'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetExportSet
tags:
- fileStorage
x-example: 'GET /20171215/exportSets/<exportSetId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
put:
description: Updates the specified export set's information.
operationId: UpdateExportSet
parameters:
- $ref: '#/components/parameters/ExportSetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The export set was updated.
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/ExportSet'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateExportSet
tags:
- fileStorage
x-example: "PUT /20171215/exportSets/<exportSetId>\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"mount-target-5-new-exportset\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateExportSetDetails'
description: Details object for updating an export set.
required: true
/exports:
get:
description: 'Lists export resources by compartment, file system, or export
set. You must specify an export set ID, a file system ID, and
/ or a compartment ID.
'
operationId: ListExports
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/ExportSetOptionalQueryParam'
- $ref: '#/components/parameters/FileSystemOptionalQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/OcidQueryParam'
- $ref: '#/components/parameters/ExportSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/ExportSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListExports
tags:
- fileStorage
x-example: "GET /20171215/exports?compartmentId=<compartmentId>\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"exportSetId\" : \"ocid1.exportset.oc1..<unique_ID>\"\n}\n"
post:
description: 'Creates a new export in the specified export set, path, and
file system.
'
operationId: CreateExport
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The export was created.
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/Export'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateExport
tags:
- fileStorage
x-example: "POST /20171215/exports\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"exportOptions\": [\n {\n \"source\": \"10.0.0.0/16\",\n \"requirePrivilegedSourcePort\": true,\n \"access\": \"READ_WRITE\",\n \"identitySquash\": \"NONE\",\n \"anonymousUid\": 0,\n \"anonymousGid\": 0\n }\n ]\n \"exportSetId\" : \"ocid1.exportset.oc1..<unique_ID>\",\n \"fileSystemId\" : \"ocid1.filesystem.oc1..<unique_ID>\",\n \"path\" : \"/files-5\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateExportDetails'
description: Details for creating a new export.
required: true
/exports/{exportId}:
delete:
description: 'Deletes the specified export.
'
operationId: DeleteExport
parameters:
- $ref: '#/components/parameters/ExportIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The export is being deleted.
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
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteExport
tags:
- fileStorage
x-example: 'DELETE /20171215/exports/<exportId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Export'
get:
description: Gets the specified export's information.
operationId: GetExport
parameters:
- $ref: '#/components/parameters/ExportIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The export was retrieved.
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/Export'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetExport
tags:
- fileStorage
x-example: 'GET /20171215/exports/<exportSetId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
put:
description: Updates the specified export's information.
operationId: UpdateExport
parameters:
- $ref: '#/components/parameters/ExportIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: The export was updated.
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/Export'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateExport
tags:
- fileStorage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateExportDetails'
description: Details object for updating an export.
required: true
/exports/{exportId}/actions/addLock:
post:
description: Adds a lock to a resource.
operationId: AddExportLock
parameters:
- $ref: '#/components/parameters/ExportIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is added.
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/Export'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/Export'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the AddLock.
required: true
/exports/{exportId}/actions/removeLock:
post:
description: Removes a lock to a resource.
operationId: RemoveExportLock
parameters:
- $ref: '#/components/parameters/ExportIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is removed.
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/Export'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/Export'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the RemoveLock.
required: true
/fileSystems:
get:
description: 'Lists the file system resources in the specified compartment, or by the specified compartment and
file system snapshot policy.
'
operationId: ListFileSystems
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/OcidQueryParam'
- $ref: '#/components/parameters/sourceSnapshotIdQueryParam'
- $ref: '#/components/parameters/parentFileSystemIdQueryParam'
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdListFsOptionalQueryParam'
- $ref: '#/components/parameters/FileSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/FileSystemSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListFileSystems
tags:
- fileStorage
x-example: 'GET /20171215/fileSystems?compartmentId=<compartmentId>&availabilityDomain=<availabilityDomain>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
post:
description: 'Creates a new file system in the specified compartment and
availability domain. Instances can mount file systems in
another availability domain, but doing so might increase
latency when compared to mounting instances in the same
availability domain.
After you create a file system, you can associate it with a mount
target. Instances can then mount the file system by connecting to the
mount target''s IP address. You can associate a file system with
more than one mount target at a time.
For information about access control and compartments, see
[Overview of the IAM Service](/Content/Identity/Concepts/overview.htm).
For information about Network Security Groups access control, see
[Network Security Groups](/Content/Network/Concepts/networksecuritygroups.htm).
For information about availability domains, see [Regions and
Availability Domains](/Content/General/Concepts/regions.htm).
To get a list of availability domains, use the
`ListAvailabilityDomains` operation in the Identity and Access
Management Service API.
All Oracle Cloud Infrastructure resources, including
file systems, get an Oracle-assigned, unique ID called an Oracle
Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)).
When you create a resource, you can find its OCID in the response.
You can also retrieve a resource''s OCID by using a List API operation on that resource
type or by viewing the resource in the Console.
'
operationId: CreateFileSystem
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The file system was created.
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/FileSystem'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateFileSystem
tags:
- fileStorage
x-example: "POST /20171215/fileSystems\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"availabilityDomain\" : \"pWEh:PHX-AD-2\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"media-files-1\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFileSystemDetails'
description: Details for creating a new file system.
required: true
/fileSystems/{fileSystemId}:
delete:
description: 'Deletes the specified file system. Before you delete the file system,
verify that no remaining export resources still reference it. Deleting a
file system also deletes all of its snapshots.
'
operationId: DeleteFileSystem
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
- $ref: '#/components/parameters/CanDetachChildFileSystemQueryParam'
responses:
204:
description: The file system is being deleted.
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
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteFileSystem
tags:
- fileStorage
x-example: 'DELETE /20171215/fileSystems/<fileSystemId>
&canDetachChildFileSystem=<canDetachChildFileSystem>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/FileSystem'
get:
description: Gets the specified file system's information.
operationId: GetFileSystem
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The file system was retrieved.
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/FileSystem'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetFileSystem
tags:
- fileStorage
x-example: 'GET /20171215/fileSystems/<fileSystemId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
put:
description: 'Updates the specified file system''s information.
You can use this operation to rename a file system.
'
operationId: UpdateFileSystem
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: The file system was updated.
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/FileSystem'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateFileSystem
tags:
- fileStorage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFileSystemDetails'
description: Details object for updating a file system.
required: true
/fileSystems/{fileSystemId}/actions/addLock:
post:
description: Adds a lock to a resource.
operationId: AddFileSystemLock
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is added.
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/FileSystem'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/FileSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the AddLock.
required: true
/fileSystems/{fileSystemId}/actions/changeCompartment:
post:
description: 'Moves a file system and its associated snapshots into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)
'
operationId: ChangeFileSystemCompartment
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: 'The compartment was changed for the file system.
'
headers:
opc-request-id:
description: Unique Oracle-assigned identifier for the request.
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeFileSystemCompartment
tags:
- fileStorage
x-example: "POST /20171215/fileSystems/<fileSystemId>/actions/changeCompartment\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-related-resource: '#/definitions/FileSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeFileSystemCompartmentDetails'
description: Details for changing the compartment.
required: true
/fileSystems/{fileSystemId}/actions/detachClone:
post:
description: 'Detaches the file system from its parent file system
'
operationId: DetachClone
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: 'The file system is detaching/detached from its parent file system
'
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'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DetachClone
tags:
- fileStorage
x-obmcs-terraform:
actionType: SPECIAL_UPDATE
x-related-resource: '#/definitions/FileSystem'
/fileSystems/{fileSystemId}/actions/estimateReplication:
post:
description: 'Provides estimates for replication created using specific file system.
'
operationId: EstimateReplication
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ReplicationEstimateChangeRateQueryParam'
responses:
200:
description: 'An estimate for replication setup has been provided.
'
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/ReplicationEstimate'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: EstimateReplication
tags:
- fileStorage
x-related-resource: '#/definitions/FileSystem'
/fileSystems/{fileSystemId}/actions/removeLock:
post:
description: Removes a lock to a resource.
operationId: RemoveFileSystemLock
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is removed.
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/FileSystem'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/FileSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the RemoveLock.
required: true
/fileSystems/{fileSystemId}/actions/toggleQuotaRules:
post:
description: 'Enable or disable quota enforcement for the file system.
If `areQuotaRulesEnabled` = `true`, then the quota enforcement will be enabled.
If `areQuotaRulesEnabled` = `false`, then the quota enforcement will be disabled.
'
operationId: ToggleQuotaRules
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: 'The request is accepted and being processed. For progress, please check the `quotaEnforcementState`
of this file system.
'
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'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Toggles quota enforcement for a file system
tags:
- fileStorage
x-obmcs-terraform:
actionType: UPDATE_FIELD
x-related-resource: '#/definitions/FileSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ToggleQuotaRulesDetails'
description: Details for toggling quota enforcement in the file system.
required: true
/fileSystems/{fileSystemId}/quotaRules:
get:
description: 'List user or group usages and their quota rules by certain principal type.
'
operationId: ListQuotaRules
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PrincipalTypeQueryParam'
- $ref: '#/components/parameters/PrincipalIdQueryParam'
- $ref: '#/components/parameters/AreViolatorsOnlyQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/QuotaRuleSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: List user or group usages and their quota rules.
tags:
- fileStorage
x-related-resource: '#/definitions/FileSystem'
post:
description: 'Create a file system, user, or group quota rule given the `fileSystemId`, `principalId`, `principalType` and
`isHardQuota` parameters.
'
operationId: CreateQuotaRule
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The quota rule was created.
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/QuotaRule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Create an FS level, user or group quota rule.
tags:
- fileStorage
x-related-resource: '#/definitions/FileSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateQuotaRuleDetails'
description: Details for adding a new quota rule.
required: true
/fileSystems/{fileSystemId}/quotaRules/{quotaRuleId}:
delete:
description: 'Remove a file system, user, or group quota rule given the `fileSystemId` and `quotaRuleId` parameters.
'
operationId: DeleteQuotaRule
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/QuotaRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: 'The quota rule is being deleted.
'
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'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Remove an FS level, user or group quota rule.
tags:
- fileStorage
x-related-resource: '#/definitions/FileSystem'
get:
description: 'Get a file system, user, or group quota rule given the `fileSystemId` and `quotaRuleId` parameters.
'
operationId: GetQuotaRule
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/QuotaRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The quota rule was retrieved.
'
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/QuotaRule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Get an FS level, user or group quota rule.
tags:
- fileStorage
x-related-resource: '#/definitions/FileSystem'
put:
description: 'Edit a file system, user, or group quota rule given the `fileSystemId` and `quotaRuleId` parameters.
'
operationId: UpdateQuotaRule
parameters:
- $ref: '#/components/parameters/FileSystemIdPathParam'
- $ref: '#/components/parameters/QuotaRuleIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The quota rule was updated.
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/QuotaRule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Edit an FS level, user or group quota rule.
tags:
- fileStorage
x-related-resource: '#/definitions/FileSystem'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateQuotaRuleDetails'
description: Details for editing a quota rule.
required: true
/filesystemSnapshotPolicies:
get:
description: 'Lists file system snapshot policies in the specified compartment.
'
operationId: ListFilesystemSnapshotPolicies
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/FilesystemSnapshotPolicyLifecycleStateQueryParam'
- $ref: '#/components/parameters/OcidQueryParam'
- $ref: '#/components/parameters/FilesystemSnapshotPolicySortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/FilesystemSnapshotPolicySummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListFilesystemSnapshotPolicies
tags:
- fileStorage
x-example: 'GET /20171215/filesystemSnapshotPolicies?compartmentId=<compartmentId>&availabilityDomain=<availabilityDomain>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
post:
description: 'Creates a new file system snapshot policy in the specified compartment and
availability domain.
After you create a file system snapshot policy, you can associate it with
file systems.
'
operationId: CreateFilesystemSnapshotPolicy
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The file system snapshot policy was created.
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/FilesystemSnapshotPolicy'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateFilesystemSnapshotPolicy
tags:
- fileStorage
x-example: "POST /20171215/filesystemSnapshotPolicies\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"availabilityDomain\" : \"pWEh:PHX-AD-2\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"media-policy-1\",\n \"policyPrefix\": \"mp1\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFilesystemSnapshotPolicyDetails'
description: Details for creating a new file system snapshot policy.
required: true
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}:
delete:
description: 'Deletes the specified file system snapshot policy.
'
operationId: DeleteFilesystemSnapshotPolicy
parameters:
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The file system snapshot policy is being deleted.
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
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteFilesystemSnapshotPolicy
tags:
- fileStorage
x-example: 'DELETE /20171215/filesystemSnapshotPolicies/<filesystemSnapshotPolicyIdId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/FilesystemSnapshotPolicy'
get:
description: Gets the specified file system snapshot policy's information.
operationId: GetFilesystemSnapshotPolicy
parameters:
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The file system snapshot policy was retrieved.
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/FilesystemSnapshotPolicy'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetFilesystemSnapshotPolicy
tags:
- fileStorage
x-example: 'GET /20171215/filesystemSnapshotPolicies/<filesystemSnapshotPolicyId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
put:
description: Updates the specified file system snapshot policy's information.
operationId: UpdateFilesystemSnapshotPolicy
parameters:
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: The file system snapshot policy was updated.
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/FilesystemSnapshotPolicy'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateFilesystemSnapshotPolicy
tags:
- fileStorage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFilesystemSnapshotPolicyDetails'
description: Details object for updating a file system snapshot policy.
required: true
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/addLock:
post:
description: Adds a lock to a resource.
operationId: AddFilesystemSnapshotPolicyLock
parameters:
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is added.
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/FilesystemSnapshotPolicy'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/FilesystemSnapshotPolicy'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the AddLock.
required: true
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/changeCompartment:
post:
description: 'Moves a file system snapshot policy into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeFilesystemSnapshotPolicyCompartment
parameters:
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: 'The compartment was changed for the file system snapshot policy.
'
headers:
opc-request-id:
description: Unique Oracle-assigned identifier for the request.
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeFilesystemSnapshotPolicyCompartment
tags:
- fileStorage
x-example: "POST /20171215/filesystemSnapshotPolicies/<filesystemSnapshotPolicyId>/actions/changeCompartment\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-related-resource: '#/definitions/FilesystemSnapshotPolicy'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeFilesystemSnapshotPolicyCompartmentDetails'
description: Details for changing the compartment of a file system snapshot policy.
required: true
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/pause:
post:
description: 'This operation pauses the scheduled snapshot creation and snapshot deletion of the policy and updates the lifecycle state of the file system
snapshot policy from ACTIVE to INACTIVE. When a file system snapshot policy is paused, file systems that are associated with the
policy will not have scheduled snapshots created or deleted.
If the policy is already paused, or in the INACTIVE state, you cannot pause it again. You can''t pause a policy
that is in a DELETING, DELETED, FAILED, CREATING or INACTIVE state; attempts to pause a policy in these states result in a 409 conflict error.
'
operationId: PauseFilesystemSnapshotPolicy
parameters:
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: 'The request was accepted and the file system snapshot policy''s lifecycle state is updated to INACTIVE.
'
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/FilesystemSnapshotPolicy'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Pauses an active filesystem snapshot policy.
tags:
- fileStorage
x-example: 'POST /20171215/filesystemSnapshotPolicies/<filesystemSnapshotPolicyId>/actions/pause
Host: filestorage.us-phoenix-1.oraclecloud.com
'
x-obmcs-terraform:
actionType: STOP
x-related-resource: '#/definitions/FilesystemSnapshotPolicy'
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/removeLock:
post:
description: Removes a lock to a resource.
operationId: RemoveFilesystemSnapshotPolicyLock
parameters:
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is Removed.
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/FilesystemSnapshotPolicy'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/FilesystemSnapshotPolicy'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the RemoveLock.
required: true
/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/unpause:
post:
description: 'This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from
INACTIVE to ACTIVE. By default, file system snapshot policies are in the ACTIVE state. When a file system snapshot policy is not paused, or in the ACTIVE state, file systems that are associated with the
policy will have snapshots created and deleted according to the schedules defined in the policy.
If the policy is already in the ACTIVE state, you cannot unpause it. You can''t unpause a policy that is in a DELETING, DELETED, FAILED, CREATING, or ACTIVE state; attempts to unpause a policy in these states result in a 409 conflict error.
'
operationId: UnpauseFilesystemSnapshotPolicy
parameters:
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: 'The request was accepted and the file system snapshot policy''s lifecycle state is updated to ACTIVE.
'
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/FilesystemSnapshotPolicy'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Unpauses a paused (inactive) filesystem snapshot policy.
tags:
- fileStorage
x-example: 'POST /20171215/filesystemSnapshotPolicies/<filesystemSnapshotPolicyId>/actions/unpause
Host: filestorage.us-phoenix-1.oraclecloud.com
'
x-obmcs-terraform:
actionType: START
x-related-resource: '#/definitions/FilesystemSnapshotPolicy'
/mountTargets:
get:
description: 'Lists the mount target resources in the specified compartment.
'
operationId: ListMountTargets
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/ExportSetOptionalQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/OcidQueryParam'
- $ref: '#/components/parameters/MountTargetSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/MountTargetSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListMountTargets
tags:
- fileStorage
x-example: 'GET /20171215/mountTargets?compartmentId=<compartmentId>&availabilityDomain=<availabilityDomain>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
post:
description: 'Creates a new mount target in the specified compartment and
subnet. You can associate a file system with a mount
target only when they exist in the same availability domain. Instances
can connect to mount targets in another availablity domain, but
you might see higher latency than with instances in the same
availability domain as the mount target.
Mount targets have one or more private IP addresses that you can
provide as the host portion of remote target parameters in
client mount commands. These private IP addresses are listed
in the privateIpIds property of the mount target and are highly available. Mount
targets also consume additional IP addresses in their subnet.
Do not use /30 or smaller subnets for mount target creation because they
do not have sufficient available IP addresses.
Allow at least three IP addresses for each mount target.
For information about access control and compartments, see
[Overview of the IAM
Service](/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and
Availability Domains](/Content/General/Concepts/regions.htm).
To get a list of availability domains, use the
`ListAvailabilityDomains` operation in the Identity and Access
Management Service API.
All Oracle Cloud Infrastructure Services resources, including
mount targets, get an Oracle-assigned, unique ID called an
Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)).
When you create a resource, you can find its OCID in the response.
You can also retrieve a resource''s OCID by using a List API operation on that resource
type, or by viewing the resource in the Console.
'
operationId: CreateMountTarget
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: The mount target was created.
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/MountTarget'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateMountTarget
tags:
- fileStorage
x-example: "POST /20171215/mountTargets\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"availabilityDomain\" : \"pWEh:PHX-AD-2\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"mount-target-5\",\n \"subnetId\" : \"ocid1.subnet.oc1..<unique_ID>\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMountTargetDetails'
description: Details for creating a new mount target.
required: true
/mountTargets/actions/validateKeyTabs:
post:
description: 'Validates keytab contents for the secret details passed on the request or validte keytab contents associated with
the mount target passed in the request. The keytabs are deserialized, the contents are validated for compatibility
and the principal, key version number and encryption type of each entry is provided as part of the response.
'
operationId: ValidateKeyTabs
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Keytab(s) validated successfully for the given mount target or given keytab secret details.
headers:
opc-request-id:
description: Unique Oracle-assigned identifier for the request.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateKeyTabsResponseDetails'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ValidateKeytabs
tags:
- fileStorage
x-example: "POST /20171215/mountTargets/actions/validateKeytabs\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"mountTargetId\": \"ocid1.mounttarget.oc1..<unique_ID>\"\n}\n"
x-related-resource: '#/definitions/MountTarget'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ValidateKeyTabsDetails'
description: Keytab secret details or mount target ID for validating keytabs.
required: true
/mountTargets/{mountTargetId}:
delete:
description: 'Deletes the specified mount target. This operation also deletes the
mount target''s VNICs.
'
operationId: DeleteMountTarget
parameters:
- $ref: '#/components/parameters/MountTargetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The mount target is being deleted.
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
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteMountTarget
tags:
- fileStorage
x-example: 'DELETE /20171215/mountTargets/<mountTargetId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/MountTarget'
get:
description: Gets the specified mount target's information.
operationId: GetMountTarget
parameters:
- $ref: '#/components/parameters/MountTargetIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The mount target was retrieved.
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/MountTarget'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetMountTarget
tags:
- fileStorage
x-example: 'GET /20171215/mountTargets/<mountTargetId>?compartmentId=<compartmentId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
put:
description: Updates the specified mount target's information.
operationId: UpdateMountTarget
parameters:
- $ref: '#/components/parameters/MountTargetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: The mount target was updated.
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/MountTarget'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateMountTarget
tags:
- fileStorage
x-example: "PUT /20171215/mountTargets/<mountTargetId>\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"mount-target-1\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMountTargetDetails'
description: Details object for updating a mount target.
required: true
/mountTargets/{mountTargetId}/actions/addLock:
post:
description: Adds a lock to a resource.
operationId: AddMountTargetLock
parameters:
- $ref: '#/components/parameters/MountTargetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is added.
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/MountTarget'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/MountTarget'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the AddLock.
required: true
/mountTargets/{mountTargetId}/actions/cancelShapeDowngrade:
post:
description: 'Cancel scheduled downgrade shape request for mount target.
'
operationId: CancelDowngradeShapeMountTarget
parameters:
- $ref: '#/components/parameters/MountTargetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'Scheduled downgrade shape request for mount target was cancelled.
'
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/MountTarget'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CancelDowngradeShapeMountTarget
tags:
- fileStorage
x-example: 'POST /20171215/mountTargets/<mountTargetId>/actions/cancelShapeDowngrade
Host: filestorage.us-phoenix-1.oraclecloud.com
'
x-obmcs-terraform:
actionType: UPDATE_FIELD
x-related-resource: '#/definitions/MountTarget'
/mountTargets/{mountTargetId}/actions/changeCompartment:
post:
description: 'Moves a mount target and its associated export set or share set into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)
'
operationId: ChangeMountTargetCompartment
parameters:
- $ref: '#/components/parameters/MountTargetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: 'The compartment was changed for the mount target and its associated export set.
'
headers:
opc-request-id:
description: Unique Oracle-assigned identifier for the request.
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeMountTargetCompartment
tags:
- fileStorage
x-example: "POST /20171215/mountTargets/<mountTargetId>/actions/changeCompartment\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-related-resource: '#/definitions/MountTarget'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeMountTargetCompartmentDetails'
description: Details for changing the compartment.
required: true
/mountTargets/{mountTargetId}/actions/removeLock:
post:
description: Removes a lock to a resource.
operationId: RemoveMountTargetLock
parameters:
- $ref: '#/components/parameters/MountTargetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is removed.
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/MountTarget'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/MountTarget'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the RemoveLock.
required: true
/mountTargets/{mountTargetId}/actions/scheduleShapeDowngrade:
post:
description: 'Schedule a downgrade shape of the mount target.
'
operationId: ScheduleDowngradeShapeMountTarget
parameters:
- $ref: '#/components/parameters/MountTargetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'The mount target was scheduled to downgrade shape after end of current billing cycle.
'
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/MountTarget'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ScheduleDowngradeShapeMountTarget
tags:
- fileStorage
x-example: "POST /20171215/mountTargets/<mountTargetId>/actions/scheduleShapeDowngrade\nHost: filestorage.us-phoenix-1.oraclecloud.com\n{\n \"throughput\": 20\n}\n"
x-obmcs-terraform:
actionType: UPDATE_FIELD
x-related-resource: '#/definitions/MountTarget'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleDowngradeShapeMountTargetDetails'
description: Details for changing the shape of mount target.
required: true
/mountTargets/{mountTargetId}/actions/upgradeShape:
post:
description: 'Upgrade shape request for mount target.
'
operationId: UpgradeShapeMountTarget
parameters:
- $ref: '#/components/parameters/MountTargetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: 'Upgrade shape request for mount target was applied.
'
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/MountTarget'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpgradeShapeMountTarget
tags:
- fileStorage
x-example: "POST /20171215/mountTargets/<mountTargetId>/actions/upgradeShape\nHost: filestorage.us-phoenix-1.oraclecloud.com\n{\n \"throughput\": 40\n}\n"
x-obmcs-terraform:
actionType: UPDATE_FIELD
x-related-resource: '#/definitions/MountTarget'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpgradeShapeMountTargetDetails'
description: Details for changing the shape of mount target.
required: true
/outboundConnectors:
get:
description: 'Lists the outbound connector resources in the specified compartment.
'
operationId: ListOutboundConnectors
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/OcidQueryParam'
- $ref: '#/components/parameters/OutboundConnectorSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/OutboundConnectorSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListOutboundConnectors
tags:
- fileStorage
x-example: 'GET /20171215/outboundConnectors?compartmentId=<compartmentId>&availabilityDomain=<availabilityDomain>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
post:
description: 'Creates a new outbound connector in the specified compartment.
You can associate an outbound connector with a mount target only when
they exist in the same availability domain.
For information about access control and compartments, see
[Overview of the IAM
Service](/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and
Availability Domains](/Content/General/Concepts/regions.htm).
To get a list of availability domains, use the
`ListAvailabilityDomains` operation in the Identity and Access
Management Service API.
All Oracle Cloud Infrastructure Services resources, including
outbound connectors, get an Oracle-assigned, unique ID called an
Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)).
When you create a resource, you can find its OCID in the response.
You can also retrieve a resource''s OCID by using a List API operation on that resource
type, or by viewing the resource in the Console.
'
operationId: CreateOutboundConnector
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The outbound connector was created.
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/OutboundConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateOutboundConnector
tags:
- fileStorage
x-example: "POST /20171215/outboundConnectors\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"availabilityDomain\" : \"pWEh:PHX-AD-2\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"outbound-connector-4\",\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOutboundConnectorDetails'
description: Details for creating a new outbound connector.
required: true
/outboundConnectors/{outboundConnectorId}:
delete:
description: 'Deletes the specified outbound connector.
'
operationId: DeleteOutboundConnector
parameters:
- $ref: '#/components/parameters/OutboundConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The outbound connector is being deleted.
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
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteOutboundConnector
tags:
- fileStorage
x-example: 'DELETE /20171215/outboundConnectors/<outboundConnectorId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OutboundConnector'
get:
description: Gets the specified outbound connector's information.
operationId: GetOutboundConnector
parameters:
- $ref: '#/components/parameters/OutboundConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The outbound connector was retrieved.
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/OutboundConnector'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetOutboundConnector
tags:
- fileStorage
x-example: 'GET /20171215/outboundConnectors/<outboundConnectorId>?compartmentId=<compartmentId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
put:
description: Updates the specified outbound connector's information.
operationId: UpdateOutboundConnector
parameters:
- $ref: '#/components/parameters/OutboundConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: The outbound connector was updated.
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/OutboundConnector'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateOutboundConnector
tags:
- fileStorage
x-example: "PUT /20171215/outboundConnectors/<outboundConnectorId>\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"outbound-connector-1\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOutboundConnectorDetails'
description: Details object for updating a outbound connector.
required: true
/outboundConnectors/{outboundConnectorId}/actions/addLock:
post:
description: Adds a lock to a resource.
operationId: AddOutboundConnectorLock
parameters:
- $ref: '#/components/parameters/OutboundConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is added.
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/OutboundConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/OutboundConnector'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the AddLock.
required: true
/outboundConnectors/{outboundConnectorId}/actions/changeCompartment:
post:
description: 'Moves an outbound connector into a different compartment within the same tenancy.
For information about moving resources between compartments, see
[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes)
'
operationId: ChangeOutboundConnectorCompartment
parameters:
- $ref: '#/components/parameters/OutboundConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: 'The compartment was changed for the outbound connector.
'
headers:
opc-request-id:
description: Unique Oracle-assigned identifier for the request.
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeOutboundConnectorCompartment
tags:
- fileStorage
x-example: "POST /20171215/outboundConnectors/<outboundConnectorId>/actions/changeCompartment\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-related-resource: '#/definitions/OutboundConnector'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeOutboundConnectorCompartmentDetails'
description: Details for changing the compartment.
required: true
/outboundConnectors/{outboundConnectorId}/actions/removeLock:
post:
description: Removes a lock to a resource.
operationId: RemoveOutboundConnectorLock
parameters:
- $ref: '#/components/parameters/OutboundConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is removed.
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/OutboundConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/OutboundConnector'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the RemoveLock.
required: true
/replicationTargets:
get:
description: 'Lists the replication target resources in the specified compartment.
'
operationId: ListReplicationTargets
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/OcidQueryParam'
- $ref: '#/components/parameters/ReplicationTargetSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/ReplicationTargetSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListReplicationTargets
tags:
- fileStorage
x-example: 'GET /20171215/replicationTargets?compartmentId=<compartmentId>&availabilityDomain=<availabilityDomain>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
/replicationTargets/{replicationTargetId}:
delete:
description: 'Deletes the specified replication target.
This operation causes the immediate release of the target file system if there are currently no delta application operations.
If there is any current delta being applied the delete operation is blocked until the current
delta has been completely applied.
'
operationId: DeleteReplicationTarget
parameters:
- $ref: '#/components/parameters/ReplicationTargetIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The ReplicationTarget is being deleted.
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
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteReplicationTarget
tags:
- fileStorage
x-example: 'DELETE /20171215/replication/<replicationId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ReplicationTarget'
get:
description: Gets the specified replication target's information.
operationId: GetReplicationTarget
parameters:
- $ref: '#/components/parameters/ReplicationTargetIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The replication target was retrieved.
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/ReplicationTarget'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetReplicationTarget
tags:
- fileStorage
x-example: 'GET /20171215/replicationTargets/<replicationTargetId>?compartmentId=<compartmentId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
/replications:
get:
description: 'Lists the replication resources in the specified compartment.
'
operationId: ListReplications
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/OcidQueryParam'
- $ref: '#/components/parameters/ReplicationSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SourceFileSystemQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/ReplicationSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListReplications
tags:
- fileStorage
x-example: 'GET /20171215/replications?compartmentId=<compartmentId>&availabilityDomain=<availabilityDomain>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
post:
description: 'Creates a new replication in the specified compartment.
Replications are the primary resource that governs the policy of cross-region replication between source
and target file systems. Replications are associated with a secondary resource called a [`ReplicationTarget`](#/en/iaas/latest/ReplicationTarget)
located in another availability domain.
The associated replication target resource is automatically created along with the replication resource.
The replication retrieves the delta of data between two snapshots of a source file system
and sends it to the associated `ReplicationTarget`, which retrieves the delta and applies it to the target
file system.
Only unexported file systems can be used as target file systems.
For more information, see [Using Replication](/iaas/Content/File/Tasks/FSreplication.htm).
For information about access control and compartments, see
[Overview of the IAM
Service](/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and
Availability Domains](/Content/General/Concepts/regions.htm).
To get a list of availability domains, use the
`ListAvailabilityDomains` operation in the Identity and Access
Management Service API.
All Oracle Cloud Infrastructure Services resources, including
replications, get an Oracle-assigned, unique ID called an
Oracle Cloud Identifier ([OCID](/Content/General/Concepts/identifiers.htm)).
When you create a resource, you can find its OCID in the response.
You can also retrieve a resource''s OCID by using a List API operation on that resource
type, or by viewing the resource in the Console.
'
operationId: CreateReplication
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The replication was created.
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/Replication'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateReplication
tags:
- fileStorage
x-example: "POST /20171215/replication\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"availabilityDomain\" : \"pWEh:PHX-AD-2\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"replication-policy-1\",\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReplicationDetails'
description: Details for creating a new replication.
required: true
/replications/{replicationId}:
delete:
description: 'Deletes the specified replication and the the associated replication target.
'
operationId: DeleteReplication
parameters:
- $ref: '#/components/parameters/ReplicationIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ReplicationDeleteModeQueryParam'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The replication is being deleted.
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
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteReplication
tags:
- fileStorage
x-example: 'DELETE /20171215/replication/<replicationId>
&deleteMode=<deleteMode>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Replication'
get:
description: Gets the specified replication's information.
operationId: GetReplication
parameters:
- $ref: '#/components/parameters/ReplicationIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The replication was retrieved.
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/Replication'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetReplication
tags:
- fileStorage
x-example: 'GET /20171215/replications/<replicationId>?compartmentId=<compartmentId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
put:
description: 'Updates the information for the specified replication and its associated replication target.
'
operationId: UpdateReplication
parameters:
- $ref: '#/components/parameters/ReplicationIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: The replication was updated.
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/Replication'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateReplication
tags:
- fileStorage
x-example: "PUT /20171215/replication/<replicationId>\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"replication-policy-5\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateReplicationDetails'
description: Details object for updating a replication.
required: true
/replications/{replicationId}/actions/addLock:
post:
description: Adds a lock to a resource.
operationId: AddReplicationLock
parameters:
- $ref: '#/components/parameters/ReplicationIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is added.
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/Replication'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/Replication'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the AddLock.
required: true
/replications/{replicationId}/actions/changeCompartment:
post:
description: 'Moves a replication and its replication target into a different compartment within the same tenancy.
For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeReplicationCompartment
parameters:
- $ref: '#/components/parameters/ReplicationIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: 'The compartment was changed for the replication and its associated replication target.
'
headers:
opc-request-id:
description: Unique Oracle-assigned identifier for the request.
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeReplicationCompartment
tags:
- fileStorage
x-example: "POST /20171215/replications/<replicationId>/actions/changeCompartment\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-related-resource: '#/definitions/Replication'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeReplicationCompartmentDetails'
description: Details for changing the compartment.
required: true
/replications/{replicationId}/actions/removeLock:
post:
description: Removes a lock to a resource.
operationId: RemoveReplicationLock
parameters:
- $ref: '#/components/parameters/ReplicationIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is removed.
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/Replication'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/Replication'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the RemoveLock.
required: true
/snapshots:
get:
description: 'Lists snapshots of the specified file system, or by file system snapshot policy and compartment,
or by file system snapshot policy and file system.
If file system ID is not specified, a file system snapshot policy ID and compartment ID must be specified.
Users can only sort by time created when listing snapshots by file system snapshot policy ID and compartment ID
(sort by name is NOT supported for listing snapshots by policy and compartment).
'
operationId: ListSnapshots
parameters:
- $ref: '#/components/parameters/SnapshotPaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/OcidQueryParam'
- $ref: '#/components/parameters/FilesystemSnapshotPolicyIdListStOptionalQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/FileSystemOptionalQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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/SnapshotSummary'
type: array
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListSnapshots
tags:
- fileStorage
x-example: 'GET /20171215/snapshots?fileSystemId=<fileSystemId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
post:
description: 'Creates a new snapshot of the specified file system. You
can access the snapshot at `.snapshot/`.
'
operationId: CreateSnapshot
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The snapshot was created.
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/Snapshot'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateSnapshot
tags:
- fileStorage
x-example: "POST /20171215/snapshots\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"snapshot-1\",\n \"fileSystemId\": \"ocid1.filesystem.oc1..<unique_ID>\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSnapshotDetails'
description: Details for creating a new snapshot.
required: true
/snapshots/{snapshotId}:
delete:
description: 'Deletes the specified snapshot.
'
operationId: DeleteSnapshot
parameters:
- $ref: '#/components/parameters/SnapshotIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
204:
description: The snapshot is being deleted.
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
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteSnapshot
tags:
- fileStorage
x-example: "DELETE /20171215/snapshots\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"snapshotId\": \"string\"\n}\n"
x-related-resource: '#/definitions/Snapshot'
get:
description: Gets the specified snapshot's information.
operationId: GetSnapshot
parameters:
- $ref: '#/components/parameters/SnapshotIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The snapshot was retrieved.
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/Snapshot'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetSnapshot
tags:
- fileStorage
x-example: 'GET /20171215/snapshots/<snapshotId>
Host: filestorage.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
put:
description: Updates the specified snapshot's information.
operationId: UpdateSnapshot
parameters:
- $ref: '#/components/parameters/SnapshotIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OverrideLocksQueryParameter'
responses:
200:
description: The snapshot was updated.
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/Snapshot'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateSnapshot
tags:
- fileStorage
x-example: "POST /20171215/snapshots/<snapshotId>\nHost: filestorage.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"snapshot-1-new\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSnapshotDetails'
description: Details object for updating a snapshot.
required: true
/snapshots/{snapshotId}/actions/addLock:
post:
description: Adds a lock to a resource.
operationId: AddSnapshotLock
parameters:
- $ref: '#/components/parameters/SnapshotIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is added.
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/Snapshot'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Adds a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/Snapshot'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the AddLock.
required: true
/snapshots/{snapshotId}/actions/removeLock:
post:
description: Removes a lock to a resource.
operationId: RemoveSnapshotLock
parameters:
- $ref: '#/components/parameters/SnapshotIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Lock is removed.
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/Snapshot'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: Removes a lock to a resource.
tags:
- fileStorage
x-related-resource: '#/definitions/Snapshot'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLock'
description: The details to be updated for the RemoveLock.
required: true
components:
schemas:
CreateExportDetails:
description: Details for creating the export.
properties:
exportOptions:
description: "Export options for the new export. For exports of mount targets with\nIPv4 address, if client options are left unspecified, client options\nwould default to:\n\n [\n {\n \"source\" : \"0.0.0.0/0\",\n \"requirePrivilegedSourcePort\" : false,\n \"access\": \"READ_WRITE\",\n \"identitySquash\": \"NONE\",\n \"anonymousUid\": 65534,\n \"anonymousGid\": 65534,\n \"isAnonymousAccessAllowed\": false,\n \"allowedAuth\": [\"SYS\"]\n }\n ]\n\n For exports of mount targets with IPv6 address, if client options are\n left unspecified, client options would be an empty array, i.e. export\n would not be visible to any clients.\n\n **Note:** Mount targets do not have Internet-routable IP\n addresses. Therefore they will not be reachable from the\n Internet, even if an associated `ClientOptions` item has\n a source of `0.0.0.0/0`.\n\n **If set to the empty array then the export will not be\n visible to any clients.**\n\n The export's `exportOptions` can be changed after creation\n using the `UpdateExport` operation.\n"
items:
$ref: '#/components/schemas/ClientOptions'
maxItems: 100
minItems: 0
type: array
exportSetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of this export's export set.
maxLength: 255
minLength: 1
type: string
fileSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of this export's file system.
maxLength: 255
minLength: 1
type: string
isIdmapGroupsForSysAuth:
description: Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
type: boolean
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
path:
description: 'Path used to access the associated file system.
Avoid entering confidential information.
Example: `/mediafiles`
'
maxLength: 1024
minLength: 1
type: string
required:
- exportSetId
- fileSystemId
- path
OutboundConnectorSummary:
description: 'Summary information for an outbound connector.
'
discriminator:
propertyName: connectorType
properties:
availabilityDomain:
description: 'The availability domain the outbound connector is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector.
maxLength: 255
minLength: 1
type: string
connectorType:
description: The account type of this outbound connector.
type: string
x-obmcs-enumref: '#/definitions/OutboundConnector/connectorType'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My outbound connector`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the outbound connector.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of this outbound connector.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time the outbound connector was created
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- compartmentId
- displayName
- id
- lifecycleState
- timeCreated
- connectorType
x-example: ''
Error:
description: Details about an error that occurred.
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
CreateReplicationDetails:
description: Details for creating the replication and replication target.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
An associated replication target will also created with the same `displayName`.
Example: `My replication`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
replicationInterval:
default: 60
description: Duration in minutes between replication snapshots.
format: int64
type: integer
sourceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the source file system.
'
maxLength: 255
minLength: 1
type: string
targetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target file system.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
- sourceId
- targetId
UpdateExportDetails:
description: Details for updating the export.
properties:
exportOptions:
description: 'New export options for the export.
**Setting to the empty array will make the export invisible to all clients.**
Leaving unset will leave the `exportOptions` unchanged.
'
items:
$ref: '#/components/schemas/ClientOptions'
maxItems: 100
minItems: 0
type: array
isIdmapGroupsForSysAuth:
description: Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
type: boolean
ChangeReplicationCompartmentDetails:
description: Details for changing the compartment of both replication and replication target.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the replication to. Also changes the replication target''s compartment in the target region.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
QuotaRule:
description: 'A rule that can restrict the logical space that a user or group can consume in a file system.
'
properties:
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `UserXYZ''s quota`
'
type: string
fileSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file System.
maxLength: 255
minLength: 1
type: string
id:
description: The identifier of the quota rule. It is the base64 encoded string of the tuple .
maxLength: 255
minLength: 1
type: string
isHardQuota:
description: 'Whether the quota rule will be enforced.
If `isHardQuota` is true, the quota rule is enforced so that the write is blocked if usage
exceeds the hard quota limit.
If `isHardQuota` is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated.
'
type: boolean
principalId:
description: 'An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
identify a user or group to manage access control.
'
type: integer
principalType:
description: 'The type of the owner of this quota rule and usage.
'
enum:
- FILE_SYSTEM_LEVEL
- DEFAULT_GROUP
- DEFAULT_USER
- INDIVIDUAL_GROUP
- INDIVIDUAL_USER
type: string
quotaLimitInGigabytes:
description: 'The value of the quota rule in gigabytes.
'
type: integer
timeCreated:
description: 'The date and time the quota rule was created, expressed in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the quota rule was last updated, expressed in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- fileSystemId
- isHardQuota
- displayName
- quotaLimitInGigabytes
- timeCreated
- timeUpdated
type: object
CreateKerberosDetails:
description: 'Kerberos details needed to create configuration.
'
properties:
backupKeyTabSecretVersion:
description: Version of the keytab Secret in the Vault to use as a backup.
type: integer
currentKeyTabSecretVersion:
description: Version of the keytab Secret in the Vault to use.
type: integer
isKerberosEnabled:
description: Specifies whether to enable or disable Kerberos.
type: boolean
kerberosRealm:
description: The Kerberos realm that the mount target will join.
maxLength: 255
minLength: 1
type: string
keyTabSecretId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the keytab Secret in the Vault.
maxLength: 255
minLength: 1
type: string
required:
- kerberosRealm
ToggleQuotaRulesDetails:
description: Details for enabling or disabling quota enforcement in the file system.
properties:
areQuotaRulesEnabled:
default: false
description: Specifies the enforcement of quota rules on the file system.
type: boolean
required:
- areQuotaRulesEnabled
type: object
LockDurationDetails:
description: Details for setting a retention date or legal hold.
properties:
coolOffDuration:
default: 14
description: 'For snapshots in compliance mode, a cooling-off period (measured in days) begins.
During this time, you can still edit or remove the lock. Once this period ends,
the snapshot becomes immutable until the specified retention date expires, permanently
preventing any deletion or modification. The cool off duration can be set for a minimum of
0 days and a maximum of 365. It defaults to 14 days if not set.
'
maximum: 365
minimum: 0
type: integer
lockDuration:
description: 'The retention period (measured in days) defines how long a snapshot remains locked,
preventing user modifications or deletions. In governance mode this period can be adjusted,
but in compliance mode it becomes permanent after a cool-off period.
Snapshots can be locked for a minimum of 0 days and a maximum of 36,500 days.
A value of 0 days stands for an indefinite retention period and it is used for a legal hold.
'
maximum: 36500
minimum: 0
type: integer
lockMode:
default: GOVERNANCE
description: 'Can be GOVERNANCE or COMPLIANCE.
GOVERNANCE MODE: locks snapshots based on either a retention period or a legal hold.
COMPLIANCE MODE: the customer can only remove the snapshot during its cooling-off period.
Once that time ends, the snapshot becomes immutable; customers cannot delete or modify it
until its set retention date passes. After the snapshot is locked, customers can only
increase its retention period.
'
enum:
- GOVERNANCE
- COMPLIANCE
type: string
required:
- lockDuration
- lockMode
CreateMountTargetDetails:
description: Details for creating the mount target.
properties:
availabilityDomain:
description: 'The availability domain in which to create the mount target.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to create the mount target.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My mount target`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
hostnameLabel:
description: 'The hostname for the mount target''s IP address, used for
DNS resolution. The value is the hostname portion of the private IP
address''s fully qualified domain name (FQDN). For example,
`files-1` in the FQDN `files-1.subnet123.vcn1.oraclevcn.com`.
Must be unique across all VNICs in the subnet and comply
with [RFC 952](https://tools.ietf.org/html/rfc952)
and [RFC 1123](https://tools.ietf.org/html/rfc1123).
Note:
If the IP address is IPv4, this attribute value is stored in the
[PrivateIp](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/PrivateIp/) resource,
not in the `mountTarget` resource.
To update the `hostnameLabel`, use `GetMountTarget` to obtain the
[OCIDs](/Content/General/Concepts/identifiers.htm) of the mount target''s
private IPs (`privateIpIds`). Then, you can use
[UpdatePrivateIp](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/PrivateIp/UpdatePrivateIp)
to update the `hostnameLabel` value.
If the IP address is IPv6, it is stored in the
[Ipv6] (https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Ipv6) resource
To update the `hostnameLabel`, use `GetMountTarget` to obtain the
[OCIDs](/Content/General/Concepts/identifiers.htm) of the mount target''s
IPv6 address (`mountTargetIpv6Ids`). Then, you can use
[UpdateIpv6](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Ipv6/UpdateIpv6)
to update the `hostnameLabel` value.
For more information, see
[DNS in Your Virtual Cloud Network](/Content/Network/Concepts/dns.htm).
Example: `files-1`
'
maxLength: 63
minLength: 1
type: string
idmapType:
description: The method used to map a Unix UID to secondary groups, if any.
type: string
x-obmcs-enumref: '#/definitions/MountTarget/idmapType'
ipAddress:
description: 'A private IP address of your choice. Must be an available IP address within
the subnet''s CIDR. If you don''t specify a value, Oracle automatically
assigns a private IP address from the subnet.
Example: `10.0.3.3`
'
maxLength: 46
minLength: 1
type: string
kerberos:
$ref: '#/components/schemas/CreateKerberosDetails'
ldapIdmap:
$ref: '#/components/schemas/CreateLdapIdmapDetails'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
nsgIds:
description: 'A list of Network Security Group [OCIDs](/Content/General/Concepts/identifiers.htm) associated with this mount target.
A maximum of 5 is allowed.
Setting this to an empty array after the list is created removes the mount target from all NSGs.
For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm).
'
items:
maxLength: 255
minLength: 1
type: string
maxItems: 5
type: array
uniqueItems: true
requestedThroughput:
description: 'Throughput for mount target in Gbps. Currently only 1 Gbps of requestedThroughput is supported during create MountTarget.
Available shapes and corresponding throughput are listed at [Mount Target Performance](https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
'
format: int64
type: integer
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](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
type: object
subnetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet in which to create the mount target.
'
maxLength: 255
minLength: 1
type: string
required:
- availabilityDomain
- compartmentId
- subnetId
CreateLdapIdmapDetails:
description: 'Mount target details about the LDAP ID mapping configuration.
'
properties:
cacheLifetimeSeconds:
default: 300
description: The maximum amount of time the mount target is allowed to use a cached entry.
maximum: 1000
minimum: 300
type: integer
cacheRefreshIntervalSeconds:
default: 300
description: The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry.
maximum: 1000
minimum: 300
type: integer
groupSearchBase:
description: 'All LDAP searches are recursive starting at this group.
Example: `CN=Group,DC=domain,DC=com`
'
maxLength: 255
minLength: 1
type: string
negativeCacheLifetimeSeconds:
default: 300
description: The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration.
maximum: 1000
minimum: 300
type: integer
outboundConnector1Id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server.
maxLength: 255
minLength: 1
type: string
outboundConnector2Id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server.
maxLength: 255
minLength: 1
type: string
schemaType:
default: RFC2307
description: Schema type of the LDAP account.
enum:
- RFC2307
- RFC2307BIS
type: string
userSearchBase:
description: 'All LDAP searches are recursive starting at this user.
Example: `CN=User,DC=domain,DC=com`
'
maxLength: 255
minLength: 1
type: string
ChangeMountTargetCompartmentDetails:
description: Details for changing the compartment.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the mount target to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
ClientOptions:
description: 'NFS export options applied to a specified set of
clients. Only governs access through the associated
export. Access to the same file system through a different
export (on the same or different mount target) will be governed
by that export''s export options.
'
properties:
access:
description: 'Type of access to grant clients using the file system
through this export. If unspecified defaults to `READ_WRITE`.
'
enum:
- READ_WRITE
- READ_ONLY
type: string
allowedAuth:
description: Array of allowed NFS authentication types.
items:
enum:
- SYS
- KRB5
- KRB5I
- KRB5P
type: string
type: array
uniqueItems: true
anonymousGid:
description: 'GID value to remap to when squashing a client GID (see
identitySquash for more details.) If unspecified defaults
to `65534`.
'
format: int64
minimum: 0
type: integer
anonymousUid:
description: 'UID value to remap to when squashing a client UID (see
identitySquash for more details.) If unspecified, defaults
to `65534`.
'
format: int64
minimum: 0
type: integer
identitySquash:
description: 'Used when clients accessing the file system through this export
have their UID and GID remapped to ''anonymousUid'' and
''anonymousGid''. If `ALL`, all users and groups are remapped;
if `ROOT`, only the root user and group (UID/GID 0) are
remapped; if `NONE`, no remapping is done. If unspecified,
defaults to `ROOT`.
'
enum:
- NONE
- ROOT
- ALL
type: string
isAnonymousAccessAllowed:
description: 'Whether or not to enable anonymous access to the file system through this export in cases where a user isn''t found in the LDAP server used for ID mapping.
If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.
'
type: boolean
requirePrivilegedSourcePort:
description: 'If `true`, clients accessing the file system through this
export must connect from a privileged source port. If
unspecified, defaults to `true`.
'
type: boolean
source:
description: 'Clients these options should apply to. Must be a either
single IPv4/IPv6 address or single IPv4/IPv6 CIDR block.
**Note:** Access will also be limited by any applicable VCN
security rules and the ability to route IP packets to the
mount target. Mount targets do not have Internet-routable IP addresses.
'
type: string
required:
- source
ChangeFileSystemCompartmentDetails:
description: Details for changing the compartment.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the file system to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
OutboundConnector:
description: "Outbound connectors are used to help File Storage communicate with an external server, such as an LDAP server. \nAn outbound connector contains all the information needed to connect, authenticate, and gain authorization to perform the account's required functions. \n"
discriminator:
propertyName: connectorType
properties:
availabilityDomain:
description: 'The availability domain the outbound connector is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector.
maxLength: 255
minLength: 1
type: string
connectorType:
description: The account type of this outbound connector.
enum:
- LDAPBIND
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My outbound connector`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the outbound connector.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of this outbound connector.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time the outbound connector was created
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- compartmentId
- displayName
- id
- lifecycleState
- timeCreated
- connectorType
x-example: "{\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"id\": \"string\",\n \"lifecycleState\": \"ACTIVE\",\n \"name\": \"outboundConnector-1\",\n \"timeCreated\": \"2017-12-10T22:37:23.706Z\"\n \"connectorType\": \"LDAPBIND\"\n}\n"
ReplicationTargetSummary:
description: 'Summary information for replication target.
'
properties:
availabilityDomain:
description: 'The availability domain the replication target is in. Must be in the same availability domain as the target file system.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. This name is the same as the associated replication name.
Example: `My replication`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the replication target.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: Additional information about the current 'lifecycleState'.
type: string
lifecycleState:
description: The current state of this replication.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
recoveryPointTime:
description: 'The snapshotTime of the most recent recoverable replication snapshot
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2021-04-04T20:01:29.100Z`
'
format: date-time
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time the replication was created
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2021-02-02T21:10:29.600Z`
'
format: date-time
type: string
required:
- displayName
- id
- lifecycleState
- timeCreated
x-example: "[\n {\n \"id\": \"string\",\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"name\": \"replication-1\",\n \"timeCreated\": \"2021-01-10T22:37:23.706Z\",\n \"freeformTags\" : {\n \"tag1\" : \"value1\",\n \"tag2\" : \"value2\"\n },\n \"definedTags\" : {\n \"tagGroup\" : {\n \"tag001\" : \"tag4\",\n \"tag002\" : \"tag8\",\n \"tag003\" : \"tag9\"\n }\n }\n }\n]\n"
UpdateQuotaRuleDetails:
description: Details for updating a quota rule in the file system.
properties:
displayName:
description: 'A user-friendly name that the quota rule will be renamed to. It does not have to be unique.
Avoid entering confidential information.
Example: `UserXYZ''s quota`
'
maxLength: 255
minLength: 1
type: string
quotaLimitInGigabytes:
description: 'An updated value of the quota rule in gigabytes.
'
type: integer
type: object
MountTargetSummary:
description: 'Summary information for the specified mount target.
'
properties:
availabilityDomain:
description: 'The availability domain the mount target is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the mount target.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My mount target`
'
maxLength: 255
minLength: 1
type: string
exportSetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the associated export set. Controls what file
systems will be exported using Network File System (NFS) protocol on
this mount target.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the mount target.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- UPDATING
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
mountTargetIpv6Ids:
description: The OCIDs of the IPv6 addresses associated with this mount target.
items:
maxLength: 255
minLength: 0
type: string
type: array
nsgIds:
description: 'A list of Network Security Group [OCIDs](/Content/General/Concepts/identifiers.htm) associated with this mount target.
A maximum of 5 is allowed.
Setting this to an empty array after the list is created removes the mount target from all NSGs.
For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm).
'
items:
maxLength: 255
minLength: 1
type: string
maxItems: 5
type: array
uniqueItems: true
observedThroughput:
description: 'Current billed throughput for mount target in Gbps. This corresponds to shape of mount target.
Available shapes and corresponding throughput are listed at [Mount Target Performance](https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
'
format: int64
type: integer
privateIpIds:
description: The OCIDs of the private IP addresses associated with this mount target.
items:
maxLength: 255
minLength: 0
type: string
type: array
requestedThroughput:
description: '- New throughput for mount target at the end of billing cycle in Gbps.
'
format: int64
type: integer
reservedStorageCapacity:
description: '- Reserved capacity (GB) associated with this mount target. Reserved capacity depends on observedThroughput value
of mount target. Value is listed at [Mount Target Performance](https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
'
format: int64
type: integer
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](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
type: object
subnetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the mount target is in.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeBillingCycleEnd:
description: "The date and time the mount target current billing cycle will end, expressed in\n[RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Once a cycle ends, it is updated\nautomatically to next timestamp which is after 30 days.\n\n Example: `2016-08-25T21:10:29.600Z`\n"
format: date-time
type: string
timeCreated:
description: 'The date and time the mount target was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- compartmentId
- displayName
- id
- lifecycleState
- privateIpIds
- subnetId
- timeCreated
x-example: "[\n {\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"mount-target-5\",\n \"exportSetId\": \"ocid1.exportset.oc1..<unique_ID>\",\n \"id\": \"ocid1.mounttarget.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"privateIpIds\": [\n \"ocid1.privateip.oc1..<unique_ID>\"\n ],\n \"mountTargetIpv6Ids\": [],\n \"subnetId\": \"ocid1.subnet.oc1..<unique_ID>\",\n \"nsgIds\": [\n \"ocid1.networksecuritygroup.oc1..<unique_ID>\"\n ],\n \"timeCreated\": \"2017-12-01T22:13:22.534Z\",\n \"freeformTags\" : {\n \"tag1\" : \"value1\",\n \"tag2\" : \"value2\"\n },\n \"definedTags\" : {\n \"tagGroup\" : {\n \"tag001\" : \"tag4\",\n \"tag002\" : \"tag5\",\n \"tag003\" : \"tag6\"\n }\n }\n },\n {\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"mount-target-6\",\n \"exportSetId\": \"ocid1.exportset.oc1..<unique_ID>\",\n \"id\": \"ocid1.mounttarget.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"privateIpIds\": [\n \"ocid1.privateip.oc1..<unique_ID>\"\n ],\n \"mountTargetIpv6Ids\": [],\n \"subnetId\": \"ocid1.subnet.oc1..<unique_ID>\",\n \"nsgIds\": [\n \"ocid1.networksecuritygroup.oc1..<unique_ID>\"\n ],\n \"timeCreated\": \"2017-12-01T22:15:20.264Z\",\n \"freeformTags\" : {\n \"tag10\" : \"value10\",\n \"tag20\" : \"value20\"\n },\n \"definedTags\" : {\n \"tagGroup\" : {\n \"tag0010\" : \"tag40\",\n \"tag0020\" : \"tag50\",\n \"tag0030\" : \"tag60\"\n }\n }\n }\n]\n"
UpdateReplicationDetails:
description: Details for updating the replication and replication target.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it is changeable.
Avoid entering confidential information.
A replication target will also updated with the same `displayName`.
Example: `My replication`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
replicationInterval:
description: Duration in minutes between replication snapshots.
format: int64
type: integer
UpdateExportSetDetails:
description: Details for updating the export set.
properties:
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My export set`
'
maxLength: 255
minLength: 1
type: string
maxFsStatBytes:
description: 'Controls the maximum `tbytes`, `fbytes`, and `abytes`
values reported by `NFS FSSTAT` calls through any associated
mount targets. This is an advanced feature. For most
applications, use the default value. The
`tbytes` value reported by `FSSTAT` will be
`maxFsStatBytes`. The value of `fbytes` and `abytes` will be
`maxFsStatBytes` minus the metered size of the file
system. If the metered size is larger than `maxFsStatBytes`,
then `fbytes` and `abytes` will both be ''0''.
'
format: int64
type: integer
maxFsStatFiles:
description: 'Controls the maximum `ffiles`, `ffiles`, and `afiles`
values reported by `NFS FSSTAT` calls through any associated
mount targets. This is an advanced feature. For most
applications, use the default value. The
`tfiles` value reported by `FSSTAT` will be
`maxFsStatFiles`. The value of `ffiles` and `afiles` will be
`maxFsStatFiles` minus the metered size of the file
system. If the metered size is larger than `maxFsStatFiles`,
then `ffiles` and `afiles` will both be ''0''.
'
format: int64
type: integer
UpdateMountTargetDetails:
description: Details for updating the mount target.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My mount target`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
idmapType:
description: The method used to map a Unix UID to secondary groups, if any.
type: string
x-obmcs-enumref: '#/definitions/MountTarget/idmapType'
kerberos:
$ref: '#/components/schemas/UpdateKerberosDetails'
ldapIdmap:
$ref: '#/components/schemas/UpdateLdapIdmapDetails'
nsgIds:
description: 'A list of Network Security Group [OCIDs](/Content/General/Concepts/identifiers.htm) associated with this mount target.
A maximum of 5 is allowed.
Setting this to an empty array after the list is created removes the mount target from all NSGs.
For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm).
'
items:
maxLength: 255
minLength: 1
type: string
maxItems: 5
type: array
uniqueItems: true
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](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
type: object
UpdateFileSystemDetails:
description: Details for updating the file system.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My file system`
'
maxLength: 255
minLength: 1
type: string
filesystemSnapshotPolicyId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the associated file system snapshot policy, which
controls the frequency of snapshot creation and retention period of the taken snapshots.
If string is empty, the policy reference (if any) would be removed.
'
maxLength: 255
minLength: 0
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
kmsKeyId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Key Management master encryption key to associate with the specified file system.
If this value is empty, the Update operation will remove the associated key, if there is one, from the file system.
(The file system will continue to be encrypted, but with an encryption key managed by Oracle.)
If updating to a new Key Management key, the old key must remain enabled so that files previously encrypted continue
to be accessible. For more information, see [Overview of Key Management](/Content/KeyManagement/Concepts/keyoverview.htm).
'
maxLength: 255
minLength: 1
type: string
FileSystemSummary:
description: 'Summary information for a file system.
'
properties:
availabilityDomain:
description: 'The availability domain the file system is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
cloneAttachStatus:
description: Specifies whether the file system is attached to its parent file system.
enum:
- ATTACHED
- DETACHING
- DETACHED
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My file system`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system.
maxLength: 255
minLength: 1
type: string
isCloneParent:
description: 'Specifies whether the file system has been cloned.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
'
type: boolean
isHydrated:
description: 'Specifies whether the data has finished copying from the source to the clone.
Hydration can take up to several hours to complete depending on the size of the source.
The source and clone remain available during hydration, but there may be some performance impact.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm#hydration).
'
type: boolean
kmsKeyId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system.
'
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: Additional information about the current 'lifecycleState'.
type: string
lifecycleState:
description: The current state of the file system.
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
meteredBytes:
description: 'The number of bytes consumed by the file system, including
any snapshots. This number reflects the metered size of the file
system and is updated asynchronously with respect to
updates to the file system.
'
format: int64
type: integer
quotaEnforcementState:
description: Displays the state of enforcement of quota rules on the file system.
enum:
- ENABLING
- ENABLED
- DISABLING
- DISABLED
- SYNCING
- FAILED
type: string
replicationSourceCount:
description: Specifies the total number of replications for which this file system is a source.
type: integer
sourceDetails:
$ref: '#/components/schemas/SourceDetails'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time the file system was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- meteredBytes
- compartmentId
- displayName
- id
- lifecycleState
- timeCreated
x-example: "[\n {\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"meteredBytes\": 0,\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"media-files-1\",\n \"id\": \"ocid1.filesystem.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\": \"2017-11-25T21:14:50.024Z\",\n \"freeformTags\" : {\n \"tag1\" : \"value1\",\n \"tag2\" : \"value2\"\n },\n \"definedTags\" : {\n \"tagGroup\" : {\n \"tag001\" : \"tag4\",\n \"tag002\" : \"tag5\",\n \"tag003\" : \"tag6\"\n }\n }\n },\n{\n \"availabilityDomain\": \"pWEh:PHX-AD-1\",\n \"meteredBytes\": 0,\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"vmdk-repo-1\",\n \"id\": \"ocid1.filesystem.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\": \"2017-11-29T21:04:12.622Z\",\n \"freeformTags\" : {\n \"tag10\" : \"value10\",\n \"tag20\" : \"value20\"\n },\n \"definedTags\" : {\n \"tagGroup\" : {\n \"tag0010\" : \"tag40\",\n \"tag0020\" : \"tag50\",\n \"tag0030\" : \"tag60\"\n }\n }\n }\n]\n"
FilesystemSnapshotPolicy:
description: 'A file system snapshot policy is used to automate snapshot creation and deletion.
It contains a list of snapshot schedules that define the frequency of
snapshot creation for the associated file systems and the retention period of snapshots taken on schedule.
For more information, see [Snapshot Scheduling](/iaas/Content/File/Tasks/snapshot-policies-and-schedules.htm).
To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).
'
properties:
availabilityDomain:
description: 'The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value.
Example: `Uocm:PHX-AD-2`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `policy1`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the file system snapshot policy.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- INACTIVE
- FAILED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
policyPrefix:
description: 'The prefix to apply to all snapshots created by this policy.
Example: `acme`
'
maxLength: 100
minLength: 1
type: string
schedules:
description: 'The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.
'
items:
$ref: '#/components/schemas/SnapshotSchedule'
maxItems: 10
type: array
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time the file system snapshot policy was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- availabilityDomain
- compartmentId
- id
- lifecycleState
- timeCreated
x-example: "{\n \"availabilityDomain\": \"pWEh:PHX-AD-1\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"policy1\",\n \"id\" : \"ocid1.filesystemsnapshotpolicy.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\": \"2021-01-10T22:37:23.706Z\"\n \"schedules\":[\n {\n \"schedulePrefix\": \"compliance1\",\n \"retentionDurationInSeconds\": \"6000\",\n \"period\": \"MONTHLY\",\n \"timeZone\": \"REGIONAL_DATA_CENTER_TIME\",\n \"hourOfDay\": 0,\n \"dayOfMonth\": 1\n },\n {\n \"schedulePrefix\": \"compliance2\",\n \"retentionDurationInSeconds\": \"60000\",\n \"period\": \"YEARLY\",\n \"timeZone\": \"UTC\",\n \"hourOfDay\": 0,\n \"dayOfMonth\": 30,\n \"month\": \"OCTOBER\"\n }],\n \"policyPrefix\": \"marketing\"\n}\n"
ValidateKeyTabsDetails:
description: Validate keytabs request details.
properties:
keyTabSecretDetails:
$ref: '#/components/schemas/KeyTabSecretDetails'
mountTargetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target whose keytabs are to be validated.
maxLength: 255
minLength: 1
type: string
UpdateLdapIdmapDetails:
description: 'Mount target details about the LDAP ID mapping configuration.
'
properties:
cacheLifetimeSeconds:
default: 300
description: The maximum amount of time the mount target is allowed to use a cached entry.
maximum: 1000
minimum: 300
type: integer
cacheRefreshIntervalSeconds:
default: 300
description: The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry.
maximum: 1000
minimum: 300
type: integer
groupSearchBase:
description: 'All LDAP searches are recursive starting at this group.
Example: `CN=Group,DC=domain,DC=com`
'
maxLength: 255
minLength: 1
type: string
negativeCacheLifetimeSeconds:
default: 300
description: The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration.
maximum: 1000
minimum: 300
type: integer
outboundConnector1Id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server.
maxLength: 255
minLength: 1
type: string
outboundConnector2Id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server.
maxLength: 255
minLength: 1
type: string
schemaType:
description: Schema type of the LDAP account.
enum:
- RFC2307
- RFC2307BIS
type: string
userSearchBase:
description: 'All LDAP searches are recursive starting at this user.
Example: `CN=User,DC=domain,DC=com`
'
maxLength: 255
minLength: 1
type: string
ExportSummary:
description: 'Summary information for an export.
'
properties:
exportSetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of this export's export set.
maxLength: 255
minLength: 1
type: string
fileSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of this export's file system.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of this export.
maxLength: 255
minLength: 1
type: string
isIdmapGroupsForSysAuth:
description: Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
type: boolean
lifecycleState:
description: The current state of this export.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
path:
description: 'Path used to access the associated file system.
Avoid entering confidential information.
Example: `/mediafiles`
'
maxLength: 1024
minLength: 1
type: string
timeCreated:
description: 'The date and time the export was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- exportSetId
- fileSystemId
- id
- lifecycleState
- path
- timeCreated
x-example: "[\n {\n \"exportSetId\": \"ocid1.exportset.oc1..<unique_ID>\",\n \"fileSystemId\": \"ocid1.filesystem.oc1..<unique_ID>\",\n \"id\": \"ocid1.export.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"path\": \"/mediafiles\",\n \"timeCreated\": \"2017-12-01T22:31:12.303Z\"\n },\n {\n \"exportSetId\": \"ocid1.exportset..<unique_ID>\",\n \"fileSystemId\": \"ocid1.filesystem.oc1..<unique_ID>\",\n \"id\": \"ocid1.export.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"path\": \"/files-5\",\n \"timeCreated\": \"2017-12-01T22:13:22.534Z\"\n }\n]\n"
UpdateSnapshotDetails:
description: Details for updating the snapshot.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
expirationTime:
description: 'The UTC time when this snapshot will be deleted. To remove the expiration time, set this field to the minimum date-time value using Date(0).
Example: `Thu Jan 01 01:00:00 GMT 1970`
'
format: date-time
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
lockDurationDetails:
$ref: '#/components/schemas/LockDurationDetails'
SnapshotSchedule:
description: 'The snapshot schedule is a structure within a parent file system snapshot policy. It contains data about
the frequency of snapshot creation and the retention time of the taken snapshots.
'
properties:
dayOfMonth:
description: 'The day of the month to create a scheduled snapshot.
If the day does not exist for the month, snapshot creation will be skipped.
Used for MONTHLY and YEARLY snapshot schedules.
If not set, the system chooses a value at creation time.
'
format: int32
maximum: 31
minimum: 1
type: integer
dayOfWeek:
description: 'The day of the week to create a scheduled snapshot.
Used for WEEKLY snapshot schedules.
If not set, the system chooses a value at creation time.
'
enum:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
type: string
hourOfDay:
description: 'The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot.
If not set, the system chooses a value at creation time.
'
format: int32
maximum: 23
minimum: 0
type: integer
lockDurationDetails:
$ref: '#/components/schemas/LockDurationDetails'
month:
description: 'The month to create a scheduled snapshot.
Used only for YEARLY snapshot schedules.
If not set, the system chooses a value at creation time.
'
enum:
- JANUARY
- FEBRUARY
- MARCH
- APRIL
- MAY
- JUNE
- JULY
- AUGUST
- SEPTEMBER
- OCTOBER
- NOVEMBER
- DECEMBER
type: string
period:
description: The frequency of scheduled snapshots.
enum:
- HOURLY
- DAILY
- WEEKLY
- MONTHLY
- YEARLY
type: string
retentionDurationInSeconds:
description: 'The number of seconds to retain snapshots created with this schedule.
Snapshot expiration time will not be set if this value is empty.
'
format: int64
minimum: 3600
type: integer
schedulePrefix:
description: 'A name prefix to be applied to snapshots created by this schedule.
Example: `compliance1`
'
maxLength: 100
minLength: 1
type: string
timeScheduleStart:
description: 'The starting point used to begin the scheduling of the snapshots based upon recurrence string
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
If no `timeScheduleStart` is provided, the value will be set to the time when the schedule was created.
'
format: date-time
type: string
timeZone:
description: Time zone used for scheduling the snapshot.
enum:
- UTC
- REGIONAL_DATA_CENTER_TIME
format: x-obmcs-time-zone
type: string
required:
- period
- timeZone
x-example: "{\n \"schedulePrefix\": \"compliance1\",\n \"retentionDurationInSeconds\": \"6000\",\n \"period\": \"MONTHLY\",\n \"timeZone\": \"REGIONAL_DATA_CENTER_TIME\",\n \"hourOfDay\": 0,\n \"dayOfMonth\": 1\n}\n"
ReplicationEstimate:
description: Details for response from replication estimation.
properties:
allowedTargetRegions:
description: Array of allowed target region names which can be paired with source file system.
items:
type: string
type: array
uniqueItems: true
changeRateInMBps:
description: The rate of change on source filesystem which was used to provide the estimate in MegaBytes per second.
type: integer
estimatedBaseCopyTimeInMinutes:
description: The approximate time required for the base sync between source and target to finish.
type: integer
isReplicationSupported:
description: Specifies whether replication can be enabled on the file system.
type: boolean
minimumSupportedIntervalInMinutes:
description: The minimum supported replication interval for specified file system in minutes.
type: integer
required:
- changeRateInMBps
- isReplicationSupported
- minimumSupportedIntervalInMinutes
- estimatedBaseCopyTimeInMinutes
- allowedTargetRegions
type: object
UpdateOutboundConnectorDetails:
description: Details for updating the outbound connector.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My Outbound Connector`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
ExportSetSummary:
description: 'Summary information for an export set.
'
properties:
availabilityDomain:
description: 'The availability domain the export set is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the export set.
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My export set`
'
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the export set.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the export set.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
type: string
timeCreated:
description: 'The date and time the export set was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
vcnId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual cloud network (VCN) the export set is in.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
- displayName
- id
- lifecycleState
- timeCreated
- vcnId
x-example: "[\n {\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"mount-target-5 - export set\",\n \"id\": \"ocid1.exportset.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\": \"2017-12-01T22:13:22.534Z\",\n \"vcnId\": \"ocid1.vcn.oc1..<unique_ID>\"\n },\n {\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"mount-target-6 - export set\",\n \"id\": \"ocid1.exportset.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\": \"2017-12-01T22:15:20.264Z\",\n \"vcnId\": \"ocid1.vcn.oc1..<unique_ID>\"\n }\n]\n"
CreateQuotaRuleDetails:
description: Details for creating a quota rule in the file system.
properties:
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `UserXYZ''s quota`
'
maxLength: 255
minLength: 1
type: string
isHardQuota:
description: 'Whether the quota rule will be enforced.
If `isHardQuota` is true, the quota rule is enforced so that the write is blocked if usage
exceeds the hard quota limit.
If `isHardQuota` is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated.
'
type: boolean
principalId:
description: 'An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
identify a user or group to manage access control.
'
type: integer
principalType:
description: 'The type of the owner of this quota rule and usage.
'
enum:
- FILE_SYSTEM_LEVEL
- DEFAULT_GROUP
- DEFAULT_USER
- INDIVIDUAL_GROUP
- INDIVIDUAL_USER
type: string
quotaLimitInGigabytes:
description: 'The value of the quota rule in gigabytes.
'
type: integer
required:
- principalType
- isHardQuota
- quotaLimitInGigabytes
type: object
UpdateFilesystemSnapshotPolicyDetails:
description: Details for updating the file system snapshot policy.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `policy1`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
policyPrefix:
description: 'The prefix to apply to all snapshots created by this policy.
Example: `acme`
'
maxLength: 100
minLength: 1
type: string
schedules:
description: "The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.\n\nIf using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in\nquotation marks, i.e.\n```\n --schedules '[{\"timeZone\":\"UTC\",\"period\":\"DAILY\",\"hourOfDay\":18},{\"timeZone\":\"UTC\",\"period\":\"HOURLY\"}]'\n```\n"
items:
$ref: '#/components/schemas/SnapshotSchedule'
maxItems: 10
type: array
UpgradeShapeMountTargetDetails:
description: 'Shape details about the Mount Target.
'
properties:
requestedThroughput:
description: 'New throughput for mount target in Gbps. Available shapes and corresponding throughput are listed at
[Mount Target Performance](https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
'
format: int64
type: integer
ScheduleDowngradeShapeMountTargetDetails:
description: 'Shape details about the Mount Target.
'
properties:
requestedThroughput:
description: 'New throughput for mount target in Gbps. Available shapes and corresponding throughput are listed at
[Mount Target Performance](https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
'
format: int64
type: integer
ValidateKeyTabsResponseDetails:
description: Validate keytabs response details.
properties:
backupKerberosKeytabEntries:
description: An array of keytab entries (principal, encryptionType, keyVersionNumber).
items:
$ref: '#/components/schemas/KerberosKeytabEntry'
type: array
currentKerberosKeytabEntries:
description: An array of keytab entries (principal, encryptionType, keyVersionNumber).
items:
$ref: '#/components/schemas/KerberosKeytabEntry'
type: array
required:
- currentKerberosKeytabEntries
CreateOutboundConnectorDetails:
description: Details for creating the outbound connector.
discriminator:
propertyName: connectorType
properties:
availabilityDomain:
description: 'The availability domain the outbound connector is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the outbound connector.
maxLength: 255
minLength: 1
type: string
connectorType:
description: The account type of this outbound connector.
type: string
x-obmcs-enumref: '#/definitions/OutboundConnector/connectorType'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My outbound connector`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
required:
- availabilityDomain
- compartmentId
- connectorType
ChangeFilesystemSnapshotPolicyCompartmentDetails:
description: Details for changing the compartment of a file system snapshot policy.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the file system snapshot policy to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
KerberosKeytabEntry:
description: 'Details of each keytab entry read from the keytab file.
'
properties:
encryptionType:
description: 'Encryption type with with keytab was generated.
Secure: aes128-cts-hmac-sha256-128
Secure: aes256-cts-hmac-sha384-192
Less Secure: aes128-cts-hmac-sha1-96
Less Secure: aes256-cts-hmac-sha1-96
'
enum:
- AES128_CTS_HMAC_SHA256_128
- AES256_CTS_HMAC_SHA384_192
- AES128_CTS_HMAC_SHA1_96
- AES256_CTS_HMAC_SHA1_96
type: string
keyVersionNumber:
description: Kerberos KVNO (key version number) for key in keytab entry.
format: int64
type: integer
principal:
description: Keytab principal.
maxLength: 255
minLength: 1
type: string
required:
- principal
- encryptionType
- keyVersionNumber
FileSystem:
description: 'An NFS file system. To allow access to a file system, add it
to an export set and associate the export set with a mount
target. The same file system can be in multiple export sets and
associated with multiple mount targets.
To use any of the API operations, you must be authorized in an
IAM policy. If you''re not authorized, talk to an
administrator. If you''re an administrator who needs to write
policies to give users access, see [Getting Started with
Policies](/Content/Identity/Concepts/policygetstarted.htm).
'
properties:
areQuotaRulesEnabled:
default: false
description: Specifies the enforcement of quota rules on the file system.
type: boolean
availabilityDomain:
description: 'The availability domain the file system is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
cloneAttachStatus:
description: Specifies whether the file system is attached to its parent file system.
enum:
- ATTACHED
- DETACHING
- DETACHED
type: string
cloneCount:
description: Specifies the total number of children of a file system.
type: integer
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My file system`
'
maxLength: 255
minLength: 1
type: string
filesystemSnapshotPolicyId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the associated file system snapshot policy, which
controls the frequency of snapshot creation and retention period of the taken snapshots.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system.
maxLength: 255
minLength: 1
type: string
isCloneParent:
description: 'Specifies whether the file system has been cloned.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
'
type: boolean
isHydrated:
description: 'Specifies whether the data has finished copying from the source to the clone.
Hydration can take up to several hours to complete depending on the size of the source.
The source and clone remain available during hydration, but there may be some performance impact.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm#hydration).
'
type: boolean
isTargetable:
description: 'Specifies whether the file system can be used as a target file system for replication. The system sets this value to `true` if the file system is unexported, hasn''t yet been specified as a target file system in any replication resource, and has no user snapshots. After the file system has been specified as a target in a replication, or if the file system contains user snapshots, the system sets this value to `false`.
For more information, see [Using Replication](/iaas/Content/File/Tasks/using-replication.htm).
'
type: boolean
kmsKeyId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the KMS key which is the master encryption key for the file system.
'
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: Additional information about the current 'lifecycleState'.
type: string
lifecycleState:
description: The current state of the file system.
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
meteredBytes:
description: 'The number of bytes consumed by the file system, including
any snapshots. This number reflects the metered size of the file
system and is updated asynchronously with respect to
updates to the file system.
For more information, see [File System Usage and Metering](/Content/File/Concepts/FSutilization.htm).
'
format: int64
type: integer
quotaEnforcementState:
description: Displays the state of enforcement of quota rules on the file system.
enum:
- ENABLING
- ENABLED
- DISABLING
- DISABLED
- SYNCING
- FAILED
type: string
replicationSourceCount:
description: Specifies the total number of replications for which this file system is a source.
type: integer
replicationTargetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the replication target associated with the file system.
Empty if the file system is not being used as target in a replication.
'
maxLength: 255
minLength: 1
type: string
sourceDetails:
$ref: '#/components/schemas/SourceDetails'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time the file system was created, expressed in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- meteredBytes
- compartmentId
- displayName
- id
- lifecycleState
- timeCreated
x-example: "{\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"meteredBytes\": 0,\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"media-files-1\",\n \"id\": \"ocid1.filesystem.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"timeCreated\": \"2017-11-25T21:14:50.024Z\"\n}\n"
ChangeOutboundConnectorCompartmentDetails:
description: Details for changing the compartment of the outbound connector.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
to move the outbound connector to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
CreateSnapshotDetails:
description: Details for creating the snapshot.
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
expirationTime:
description: The time when this snapshot will be deleted.
format: date-time
type: string
fileSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system to take a snapshot of.
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
lockDurationDetails:
$ref: '#/components/schemas/LockDurationDetails'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
name:
description: 'Name of the snapshot. This value is immutable. It must also be unique with respect
to all other non-DELETED snapshots on the associated file
system.
Avoid entering confidential information.
Example: `Sunday`
'
maxLength: 255
minLength: 1
type: string
required:
- fileSystemId
- name
MountTarget:
description: 'Provides access to a collection of file systems through one or more VNICs on a
specified subnet. The set of file systems is controlled through the
referenced export set.
'
properties:
availabilityDomain:
description: 'The availability domain the mount target is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the mount target.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My mount target`
'
maxLength: 255
minLength: 1
type: string
exportSetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the associated export set. Controls what file
systems will be exported through Network File System (NFS) protocol on this
mount target.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target.
maxLength: 255
minLength: 1
type: string
idmapType:
description: The method used to map a Unix UID to secondary groups. If NONE, the mount target will not use the Unix UID for ID mapping.
enum:
- LDAP
- NONE
type: string
kerberos:
$ref: '#/components/schemas/Kerberos'
ldapIdmap:
$ref: '#/components/schemas/LdapIdmap'
lifecycleDetails:
description: Additional information about the current 'lifecycleState'.
type: string
lifecycleState:
description: The current state of the mount target.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- UPDATING
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
mountTargetIpv6Ids:
description: The OCIDs of the IPv6 addresses associated with this mount target.
items:
maxLength: 255
minLength: 0
type: string
type: array
nsgIds:
description: 'A list of Network Security Group [OCIDs](/Content/General/Concepts/identifiers.htm) associated with this mount target.
A maximum of 5 is allowed.
Setting this to an empty array after the list is created removes the mount target from all NSGs.
For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm).
'
items:
maxLength: 255
minLength: 1
type: string
maxItems: 5
type: array
uniqueItems: true
observedThroughput:
description: 'Current billed throughput for mount target in Gbps. This corresponds to shape of mount target.
Available shapes and corresponding throughput are listed at [Mount Target Performance](https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
'
format: int64
type: integer
privateIpIds:
description: The OCIDs of the private IP addresses associated with this mount target.
items:
maxLength: 255
minLength: 0
type: string
type: array
requestedThroughput:
description: '- New throughput for mount target at the end of billing cycle in Gbps.
'
format: int64
type: integer
reservedStorageCapacity:
description: '- Reserved capacity (GB) associated with this mount target. Reserved capacity depends on observedThroughput value
of mount target. Value is listed at [Mount Target Performance](https://docs.oracle.com/iaas/Content/File/Tasks/managingmounttargets.htm#performance).
'
format: int64
type: integer
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](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
type: object
subnetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet the mount target is in.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeBillingCycleEnd:
description: "The date and time the mount target current billing cycle will end and next one starts, expressed\n in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.\n\n Example: `2016-08-25T21:10:29.600Z`\n"
format: date-time
type: string
timeCreated:
description: 'The date and time the mount target was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- compartmentId
- displayName
- id
- lifecycleState
- lifecycleDetails
- subnetId
- timeCreated
- privateIpIds
x-example: "{\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"mount-target-5\",\n \"exportSetId\": \"ocid1.exportset.oc1..<unique_ID>\",\n \"id\": \"ocid1.mounttarget.oc1..<unique_ID>\",\n \"lifecycleDetails\": \"\",\n \"lifecycleState\": \"ACTIVE\",\n \"privateIpIds\": [\n \"ocid1.privateip.oc1..<unique_ID>\"\n ],\n \"mountTargetIpv6Ids\":[],\n \"subnetId\": \"ocid1.subnet.oc1..<unique_ID>\",\n \"nsgIds\": [\n \"ocid1.networksecuritygroup.oc1..<unique_ID>\"\n ],\n \"timeCreated\": \"2017-12-01T22:13:22.534Z\"\n }\n"
KeyTabSecretDetails:
description: Secret details of keytabs in Vault.
properties:
backupKeyTabSecretVersion:
description: Version of the keytab secret in the Vault to use as a backup.
type: integer
currentKeyTabSecretVersion:
description: Version of the keytab secret in the Vault to use.
type: integer
keyTabSecretId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the keytab secret in the Vault.
maxLength: 255
minLength: 1
type: string
required:
- keyTabSecretId
- currentKeyTabSecretVersion
Kerberos:
description: 'Allows administrator to configure a mount target to interact with the administrator''s Kerberos infrastructure.
'
properties:
backupKeyTabSecretVersion:
description: Version of the keytab secert in the Vault to use as a backup.
type: integer
currentKeyTabSecretVersion:
description: Version of the keytab secret in the Vault to use.
type: integer
isKerberosEnabled:
description: Specifies whether to enable or disable Kerberos.
type: boolean
kerberosRealm:
description: The Kerberos realm that the mount target will join.
maxLength: 255
minLength: 1
type: string
keyTabSecretId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the keytab secret in the Vault.
maxLength: 255
minLength: 1
type: string
required:
- kerberosRealm
FilesystemSnapshotPolicySummary:
description: 'Summary information for a file system snapshot policy.
'
properties:
availabilityDomain:
description: 'The availability domain that the file system snapshot policy is in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My Filesystem Snapshot Policy`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: 'The current state of this file system snapshot policy.
'
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- INACTIVE
- FAILED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
policyPrefix:
description: 'The prefix to apply to all snapshots created by this policy.
Example: `acme`
'
maxLength: 100
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time that the file system snapshot policy was created
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2020-02-04T21:10:29.600Z`
'
format: date-time
type: string
required:
- availabilityDomain
- compartmentId
- id
- lifecycleState
- timeCreated
x-example: "[\n {\n \"id\": \"string\",\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"displayName\": \"policy-1\",\n \"timeCreated\": \"2021-01-10T22:37:23.706Z\",\n \"policyPrefix\": \"acme\",\n \"freeformTags\" : {\n \"tag1\" : \"value1\",\n \"tag2\" : \"value2\"\n },\n \"definedTags\" : {\n \"tagGroup\" : {\n \"tag001\" : \"tag4\",\n \"tag002\" : \"tag5\",\n \"tag003\" : \"tag6\"\n }\n }\n }\n]\n"
LdapIdmap:
description: 'Mount target details about the LDAP ID mapping configuration.
'
properties:
cacheLifetimeSeconds:
default: 300
description: The maximum amount of time the mount target is allowed to use a cached entry.
maximum: 1000
minimum: 300
type: integer
cacheRefreshIntervalSeconds:
default: 300
description: The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry.
maximum: 1000
minimum: 300
type: integer
groupSearchBase:
description: 'All LDAP searches are recursive starting at this group.
Example: `CN=Group,DC=domain,DC=com`
'
maxLength: 255
minLength: 1
type: string
negativeCacheLifetimeSeconds:
default: 300
description: The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration.
maximum: 1000
minimum: 300
type: integer
outboundConnector1Id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the first connector to use to communicate with the LDAP server.
maxLength: 255
minLength: 1
type: string
outboundConnector2Id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the second connector to use to communicate with the LDAP server.
maxLength: 255
minLength: 1
type: string
schemaType:
default: RFC2307
description: Schema type of the LDAP account.
enum:
- RFC2307
- RFC2307BIS
type: string
userSearchBase:
description: 'All LDAP searches are recursive starting at this user.
Example: `CN=User,DC=domain,DC=com`
'
maxLength: 255
minLength: 1
type: string
Export:
description: "A file system and the path that you can use to mount it. Each export\nresource belongs to exactly one export set.\n\nThe export's path attribute is not a path in the\nreferenced file system, but the value used by clients for the path\ncomponent of the remotetarget argument when mounting the file\nsystem.\n\nThe path must start with a slash (/) followed by a sequence of zero or more\nslash-separated path elements. For any two export resources associated with\nthe same export set, except those in a 'DELETED' state, the path element\nsequence for the first export resource can't contain the\ncomplete path element sequence of the second export resource.\n\n\nFor example, the following are acceptable:\n\n * /example and /path\n * /example1 and /example2\n * /example and /example1\n\nThe following examples are not acceptable:\n * /example and /example/path\n * / and /example\n\nPaths may not end in a slash (/). No path element can be a period (.)\nor two periods in sequence (..). All path elements must be 255 bytes or less.\n\nNo two non-'DELETED' export resources in the same export set can\nreference the same file system.\n\nUse `exportOptions` to control access to an export. For more information, see\n[Export Options](/Content/File/Tasks/exportoptions.htm).\n"
properties:
exportOptions:
description: 'Policies that apply to NFS requests made through this
export. `exportOptions` contains a sequential list of
`ClientOptions`. Each `ClientOptions` item defines the
export options that are applied to a specified
set of clients.
For each NFS request, the first `ClientOptions` option
in the list whose `source` attribute matches the source
IP address of the request is applied.
If a client source IP address does not match the `source`
property of any `ClientOptions` in the list, then the
export will be invisible to that client. This export will
not be returned by `MOUNTPROC_EXPORT` calls made by the client
and any attempt to mount or access the file system through
this export will result in an error.
**Exports without defined `ClientOptions` are invisible to all clients.**
If one export is invisible to a particular client, associated file
systems may still be accessible through other exports on the same
or different mount targets.
To completely deny client access to a file system, be sure that the client
source IP address is not included in any export for any mount target
associated with the file system.
'
items:
$ref: '#/components/schemas/ClientOptions'
maxItems: 100
minItems: 0
type: array
exportSetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of this export's export set.
maxLength: 255
minLength: 1
type: string
fileSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of this export's file system.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of this export.
maxLength: 255
minLength: 1
type: string
isIdmapGroupsForSysAuth:
description: Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
type: boolean
lifecycleState:
description: The current state of this export.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
path:
description: 'Path used to access the associated file system.
Avoid entering confidential information.
Example: `/accounting`
'
maxLength: 1024
minLength: 1
type: string
timeCreated:
description: 'The date and time the export was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- exportOptions
- exportSetId
- fileSystemId
- id
- lifecycleState
- path
- timeCreated
x-example: "{\n \"exportOptions\": [\n {\n \"source\": \"10.0.0.0/16\",\n \"requirePrivilegedSourcePort\": true,\n \"access\": \"READ_WRITE\",\n \"identitySquash\": \"NONE\",\n \"anonymousUid\": 0,\n \"anonymousGid\": 0\n }\n ],\n \"exportSetId\": \"ocid1.exportset.oc1..<unique_ID>\",\n \"fileSystemId\": \"ocid1.filesystem.oc1..<unique_ID>\",\n \"id\": \"ocid1.export.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"path\": \"/files-5\",\n \"timeCreated\": \"2017-12-01T22:13:22.534Z\"\n}\n"
ResourceLock:
description: 'Resource locks are used to prevent certain APIs from being called for the resource.
A full lock prevents both updating the resource and deleting the resource. A delete
lock prevents deleting the resource.
'
properties:
message:
description: 'A message added by the creator of the lock. This is typically used to give an
indication of why the resource is locked.
'
type: string
relatedResourceId:
description: 'The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
'
type: string
timeCreated:
description: When the lock was created.
format: date-time
type: string
type:
description: Type of the lock.
enum:
- FULL
- DELETE
type: string
required:
- type
type: object
CreateFileSystemDetails:
description: Details for creating the file system.
properties:
areQuotaRulesEnabled:
default: false
description: Specifies the enforcement of quota rules on the file system.
type: boolean
availabilityDomain:
description: 'The availability domain to create the file system in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
cloneAttachStatus:
description: 'Specifies whether the clone file system is attached to its parent file system.
If the value is set to ''DETACH'', then the file system will be created, which is deep copied from the snapshot
specified by sourceSnapshotId, else will remain attached to its parent.
'
enum:
- DETACH
- ATTACH
maxLength: 255
minLength: 0
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to create the file system in.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My file system`
'
maxLength: 255
minLength: 1
type: string
filesystemSnapshotPolicyId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the associated file system snapshot policy, which
controls the frequency of snapshot creation and retention period of the taken snapshots.
May be unset as a blank value.
'
maxLength: 255
minLength: 0
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
kmsKeyId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the KMS key used to encrypt the encryption keys associated with this file system.
'
maxLength: 255
minLength: 1
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
sourceSnapshotId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
'
maxLength: 255
minLength: 1
type: string
required:
- availabilityDomain
- compartmentId
UpdateKerberosDetails:
description: 'Kerberos details needed to update configuration.
'
properties:
backupKeyTabSecretVersion:
description: Version of the keytab secert in the Vault to use as a backup.
type: integer
currentKeyTabSecretVersion:
description: Version of the keytab secret in the Vault to use.
type: integer
isKerberosEnabled:
description: Specifies whether to enable or disable Kerberos.
type: boolean
kerberosRealm:
description: Kerberos realm that this mount target will join.
maxLength: 255
minLength: 1
type: string
keyTabSecretId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the keytab secret in the Vault.
maxLength: 255
minLength: 1
type: string
SourceDetails:
description: 'Source information for the file system.
'
properties:
parentFileSystemId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
'
maxLength: 255
minLength: 1
type: string
sourceSnapshotId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the source snapshot used to create a cloned file system.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
'
maxLength: 255
minLength: 1
type: string
ExportSet:
description: 'A set of file systems to export through one or more mount
targets. Composed of zero or more export resources.
'
properties:
availabilityDomain:
description: 'The availability domain the export set is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the export set.
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My export set`
'
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the export set.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the export set.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
type: string
maxFsStatBytes:
description: 'Controls the maximum `tbytes`, `fbytes`, and `abytes`,
values reported by `NFS FSSTAT` calls through any associated
mount targets. This is an advanced feature. For most
applications, use the default value. The
`tbytes` value reported by `FSSTAT` will be
`maxFsStatBytes`. The value of `fbytes` and `abytes` will be
`maxFsStatBytes` minus the metered size of the file
system. If the metered size is larger than `maxFsStatBytes`,
then `fbytes` and `abytes` will both be ''0''.
'
format: int64
type: integer
maxFsStatFiles:
description: 'Controls the maximum `tfiles`, `ffiles`, and `afiles`
values reported by `NFS FSSTAT` calls through any associated
mount targets. This is an advanced feature. For most
applications, use the default value. The
`tfiles` value reported by `FSSTAT` will be
`maxFsStatFiles`. The value of `ffiles` and `afiles` will be
`maxFsStatFiles` minus the metered size of the file
system. If the metered size is larger than `maxFsStatFiles`,
then `ffiles` and `afiles` will both be ''0''.
'
format: int64
type: integer
timeCreated:
description: 'The date and time the export set was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
vcnId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual cloud network (VCN) the export set is in.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
- displayName
- id
- lifecycleState
- timeCreated
- vcnId
x-example: "{\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"mount-target-5 - export set\",\n \"id\": \"ocid1.exportset.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"maxFsStatBytes\": 9223372036854775807,\n \"maxFsStatFiles\": 9223372036854775807,\n \"timeCreated\": \"2017-12-01T22:35:59.954Z\",\n \"vcnId\": \"ocid1.vcn.oc1..<unique_ID>\"\n}\n"
Replication:
description: 'Replications are the primary resource that governs the policy of cross-region replication between source
and target file systems. Replications are associated with a secondary resource called a [`ReplicationTarget`](#/en/iaas/latest/ReplicationTarget)
located in another availability domain in the same or different region.
The replication retrieves the delta of data between two snapshots of a source file system
and sends it to the associated `ReplicationTarget`, which applies it to the target
file system. For more information, see [File System Replication](/iaas/Content/File/Tasks/FSreplication.htm).
'
properties:
availabilityDomain:
description: 'The availability domain that contains the replication. May be unset as a blank or `NULL` value.
Example: `Uocm:PHX-AD-2`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
deltaProgress:
description: 'Percentage progress of the current replication cycle.
'
format: int64
maximum: 100
minimum: 0
type: integer
deltaStatus:
description: The current state of the snapshot during replication operations.
enum:
- IDLE
- CAPTURING
- APPLYING
- SERVICE_ERROR
- USER_ERROR
- FAILED
- TRANSFERRING
type: string
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My replication`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the replication.
maxLength: 255
minLength: 1
type: string
lastSnapshotId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the last snapshot that has been replicated completely.
Empty if the copy of the initial snapshot is not complete.
'
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: Additional information about the current 'lifecycleState'.
type: string
lifecycleState:
description: The current lifecycle state of the replication.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
recoveryPointTime:
description: 'The [`snapshotTime`](#/en/iaas/latest/Snapshot/snapshotTime) of the most recent recoverable replication snapshot
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2021-04-04T20:01:29.100Z`
'
format: date-time
type: string
replicationInterval:
description: Duration in minutes between replication snapshots.
format: int64
type: integer
replicationTargetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the [`ReplicationTarget`](#/en/iaas/latest/ReplicationTarget).
'
maxLength: 255
minLength: 1
type: string
sourceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the source file system.
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
targetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the target file system.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the replication was created
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2021-01-04T20:01:29.100Z`
'
format: date-time
type: string
required:
- compartmentId
- displayName
- id
- lifecycleState
- timeCreated
- sourceId
- targetId
- replicationTargetId
x-example: "{\n \"availabilityDomain\": \"pWEh:PHX-AD-1\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"id\": \"string\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": \"\",\n \"name\": \"replication-1\",\n \"timeCreated\": \"2021-01-10T22:37:23.706Z\"\n \"sourceId\" : \"ocid1.filesystem.oc1..<unique_ID>\"\n \"targetId\" : \"ocid1.filesystem.oc1..<unique_ID>\"\n \"replicationTargetId\" : \"ocid1.replicationtarget.oc1..<unique_ID>\"\n}\n"
QuotaRuleSummary:
description: 'Summary information for a principal''s usage and quota rule.
'
properties:
areViolatorsOnly:
default: false
description: 'An option to display only the users or groups that violate their quota rules.
If `areViolatorsOnly` is false, results report all the quota and usage.
If `areViolatorsOnly` is true, results only report the quota and usage for
the users or groups that violate their quota rules.
'
type: boolean
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `UserXYZ''s quota`
'
type: string
fileSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system.
maxLength: 255
minLength: 1
type: string
id:
description: The identifier of the quota rule. It is the base64 encoded string of the tuple .
maxLength: 255
minLength: 1
type: string
isHardQuota:
description: 'Whether the quota rule will be enforced.
If `isHardQuota` is true, the quota rule is enforced so that the write is blocked if usage
exceeds the hard quota limit.
If `isHardQuota` is false, writes succeed even if usage exceeds the soft quota limit, but the quota rule is violated.
'
type: boolean
principalId:
description: 'An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
identify a user or group to manage access control.
'
type: integer
principalType:
description: 'The type of the owner of this quota rule and usage.
'
enum:
- FILE_SYSTEM_LEVEL
- DEFAULT_GROUP
- DEFAULT_USER
- INDIVIDUAL_GROUP
- INDIVIDUAL_USER
type: string
quotaLimitInGigabytes:
description: 'The value of the quota rule in gigabytes.
'
type: integer
timeCreated:
description: 'The date and time the quota rule was created, expressed in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the quota rule was last updated, expressed in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
usageInBytes:
description: 'The usage value corresponding to this principal in bytes.
'
format: int64
type: integer
required:
- fileSystemId
- usageInBytes
- principalId
- principalType
CreateFilesystemSnapshotPolicyDetails:
description: Details for creating the file system snapshot policy.
properties:
availabilityDomain:
description: 'The availability domain that the file system snapshot policy is in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the file system snapshot policy.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `policy1`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
policyPrefix:
description: 'The prefix to apply to all snapshots created by this policy.
Example: `acme`
'
maxLength: 100
minLength: 1
type: string
schedules:
description: "The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.\n\nIf using the CLI, provide the schedule as a list of JSON strings, with the list wrapped in\nquotation marks, i.e.\n```\n --schedules '[{\"timeZone\":\"UTC\",\"period\":\"DAILY\",\"hourOfDay\":18},{\"timeZone\":\"UTC\",\"period\":\"HOURLY\"}]'\n```\n"
items:
$ref: '#/components/schemas/SnapshotSchedule'
maxItems: 10
type: array
required:
- compartmentId
- availabilityDomain
ReplicationSummary:
description: 'Summary information for a replication.
'
properties:
availabilityDomain:
description: 'The availability domain the replication is in. The replication must be in the same availability domain as the source file system.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Avoid entering confidential information.
Example: `My replication`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the replication.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: Additional information about the current `lifecycleState`.
type: string
lifecycleState:
description: 'The current state of this replication.
This resource can be in a `FAILED` state if replication target is deleted instead of the replication resource.
'
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
recoveryPointTime:
description: 'The `snapshotTime` of the most recent recoverable replication snapshot
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2021-04-04T20:01:29.100Z`
'
format: date-time
type: string
replicationInterval:
description: Duration in minutes between replication snapshots.
format: int64
type: integer
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time the replication was created
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2020-02-04T21:10:29.600Z`
'
format: date-time
type: string
required:
- displayName
- id
- lifecycleState
- timeCreated
x-example: "[\n {\n \"id\": \"string\",\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n \"name\": \"replication-1\",\n \"timeCreated\": \"2021-01-10T22:37:23.706Z\",\n \"freeformTags\" : {\n \"tag1\" : \"value1\",\n \"tag2\" : \"value2\"\n },\n \"definedTags\" : {\n \"tagGroup\" : {\n \"tag001\" : \"tag4\",\n \"tag002\" : \"tag5\",\n \"tag003\" : \"tag6\"\n }\n }\n }\n]\n"
SnapshotSummary:
description: 'Summary information for a snapshot.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
expirationTime:
description: The time when this snapshot will be deleted.
format: date-time
type: string
fileSystemId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the file system from which the snapshot was created.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot.
maxLength: 255
minLength: 1
type: string
isCloneSource:
description: 'Specifies whether the snapshot has been cloned.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
'
type: boolean
lifecycleDetails:
description: Additional information about the current `lifecycleState`.
type: string
lifecycleState:
description: The current state of the snapshot.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
type: string
lockDurationDetails:
$ref: '#/components/schemas/LockDurationDetails'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
name:
description: 'Name of the snapshot. This value is immutable.
Avoid entering confidential information.
Example: `Sunday`
'
maxLength: 255
minLength: 1
type: string
provenanceId:
description: 'An [OCID](/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned.
If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value.
If this snapshot was cloned, then the `provenanceId` value is the parent''s `provenanceId`.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
'
maxLength: 255
minLength: 1
type: string
snapshotTime:
description: 'The date and time the snapshot was taken, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
This value might be the same or different from `timeCreated` depending
on the following factors:
- If the snapshot is created in the original file system directory.
- If the snapshot is cloned from a file system.
- If the snapshot is replicated from a file system.
Example: `2020-08-25T21:10:29.600Z`
'
format: date-time
type: string
snapshotType:
description: 'Specifies the generation type of the snapshot.
'
enum:
- USER
- POLICY_BASED
- REPLICATION
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time the snapshot was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- fileSystemId
- id
- lifecycleState
- name
- timeCreated
x-example: "[\n {\n \"fileSystemId\": \"ocid1.filesystem.oc1..<unique_ID>\",\n \"id\": \"string\",\n \"lifecycleState\": \"ACTIVE\",\n \"name\": \"snapshot-1\",\n \"timeCreated\": \"2017-12-10T22:37:23.706Z\"\n ,\"freeformTags\" : {\n \"tag1\" : \"value1\",\n \"tag2\" : \"value2\"\n },\n \"definedTags\" : {\n \"tagGroup\" : {\n \"tag001\" : \"tag4\",\n \"tag002\" : \"tag5\",\n \"tag003\" : \"tag6\"\n }\n }\n }\n]\n"
Snapshot:
description: 'A point-in-time snapshot of a specified file system.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
expirationTime:
description: The time when this snapshot will be deleted.
format: date-time
type: string
fileSystemId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the file system from which the snapshot
was created.
'
maxLength: 255
minLength: 1
type: string
filesystemSnapshotPolicyId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy that created this snapshot.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot.
maxLength: 255
minLength: 1
type: string
isCloneSource:
description: 'Specifies whether the snapshot has been cloned.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
'
type: boolean
lifecycleDetails:
description: Additional information about the current `lifecycleState`.
type: string
lifecycleState:
description: The current state of the snapshot.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
type: string
lockDurationDetails:
$ref: '#/components/schemas/LockDurationDetails'
locks:
description: Locks associated with this resource.
items:
$ref: '#/components/schemas/ResourceLock'
type: array
name:
description: 'Name of the snapshot. This value is immutable.
Avoid entering confidential information.
Example: `Sunday`
'
maxLength: 255
minLength: 1
type: string
provenanceId:
description: 'An [OCID](/Content/General/Concepts/identifiers.htm) identifying the parent from which this snapshot was cloned.
If this snapshot was not cloned, then the `provenanceId` is the same as the snapshot `id` value.
If this snapshot was cloned, then the `provenanceId` value is the parent''s `provenanceId`.
See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
'
maxLength: 255
minLength: 1
type: string
snapshotTime:
description: 'The date and time the snapshot was taken, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
This value might be the same or different from `timeCreated` depending
on the following factors:
- If the snapshot is created in the original file system directory.
- If the snapshot is cloned from a file system.
- If the snapshot is replicated from a file system.
Example: `2020-08-25T21:10:29.600Z`
'
format: date-time
type: string
snapshotType:
description: 'Specifies generation type of the snapshot.
'
enum:
- USER
- POLICY_BASED
- REPLICATION
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
timeCreated:
description: 'The date and time the snapshot was created, expressed
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeLocked:
description: 'The date and time as per [RFC 3339](https://tools.ietf.org/html/rfc3339) when this snapshot was locked.
It is a read-only property because the user should not be able to set it, it is set by our service.
'
format: date-time
readOnly: true
type: string
required:
- fileSystemId
- id
- lifecycleState
- name
- timeCreated
x-example: "{\n \"fileSystemId\": \"ocid1.filesystem.oc1..<unique_ID>\",\n \"id\": \"string\",\n \"lifecycleState\": \"ACTIVE\",\n \"name\": \"snapshot-1\",\n \"timeCreated\": \"2017-12-10T22:37:23.706Z\"\n}\n"
ReplicationTarget:
description: 'Replication targets are associated with a primary resource called a [`Replication`](#/en/iaas/latest/Replication)
located in another availability domain in the same or different region.
The replication retrieves the delta of data between two snapshots of a source file system
and sends it to the associated `ReplicationTarget`, which applies it to the target
file system.
All operations (except `DELETE`) must be done using the associated replication resource.
Deleting a `ReplicationTarget` allows the target file system to be exported.
Deleting a `ReplicationTarget` does not delete the associated `Replication` resource, but places it in a `FAILED` state.
For more information, see [File System Replication](/iaas/Content/File/Tasks/FSreplication.htm).
'
properties:
availabilityDomain:
description: 'The availability domain the replication resource is in. May be unset
as a blank or NULL value.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the replication.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
deltaProgress:
description: 'Percentage progress of the current replication cycle.
'
format: int64
maximum: 100
minimum: 0
type: integer
deltaStatus:
description: The current state of the snapshot during replication operations.
enum:
- IDLE
- CAPTURING
- APPLYING
- SERVICE_ERROR
- USER_ERROR
- FAILED
- TRANSFERRING
type: string
displayName:
description: 'A user-friendly name. This name is same as the replication display name for the associated resource.
Example: `My Replication`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the replication.
maxLength: 255
minLength: 1
type: string
lastSnapshotId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the last snapshot snapshot which was completely applied to the target file system.
Empty while the initial snapshot is being applied.
'
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: Additional information about the current `lifecycleState`.
type: string
lifecycleState:
description: The current state of this replication.
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
recoveryPointTime:
description: 'The snapshotTime of the most recent recoverable replication snapshot
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2021-04-04T20:01:29.100Z`
'
format: date-time
type: string
replicationId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of replication.
maxLength: 255
minLength: 1
type: string
sourceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of source filesystem.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
targetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of target filesystem.
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the replication target was created in target region.
in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2021-01-04T20:01:29.100Z`
'
format: date-time
type: string
required:
- compartmentId
- displayName
- id
- lifecycleState
- timeCreated
- sourceId
- targetId
- replicationId
x-example: "{\n \"availabilityDomain\": \"pWEh:PHX-AD-2\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"id\": \"string\",\n \"lifecycleState\": \"ACTIVE\",\n \"name\": \"replication-1\",\n \"timeCreated\": \"2021-01-10T22:37:23.706Z\"\n \"sourceId\" : \"ocid1.filesystem.oc1..<unique_ID>\"\n \"targetId\" : \"ocid1.filesystem.oc1..<unique_ID>\"\n \"replicationTargetId\" : \"ocid1.replicationtarget.oc1..<unique_ID>\"\n}\n"
parameters:
AvailabilityDomainQueryParam:
description: 'The name of the availability domain.
Example: `Uocm:PHX-AD-1`
'
in: query
name: availabilityDomain
required: true
schema:
type: string
FilesystemSnapshotPolicyLifecycleStateQueryParam:
description: 'Filter results by the specified lifecycle state. Must be a valid
state for the resource type.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
schema:
type: string
enum:
- CREATING
- ACTIVE
- DELETING
- DELETED
- FAILED
- INACTIVE
ReplicationTargetIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the replication target.
in: path
name: replicationTargetId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ReplicationSortByQueryParam:
description: 'The field to sort by. You can choose either value, but not both.
By default, when you sort by time created, results are shown
in descending order. When you sort by display name, results are
shown in ascending order.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
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
default: none
QuotaRuleIdPathParam:
description: The identifier of the quota rule. It is the base64 encoded string of the tuple .
in: path
name: quotaRuleId
required: true
schema:
type: string
maxLength: 255
minLength: 1
SortOrderQueryParam:
description: 'The sort order to use, either ''asc'' or ''desc'', where ''asc'' is
ascending and ''desc'' is descending. The default order is ''desc''
except for numeric values.
'
in: query
name: sortOrder
required: false
schema:
type: string
enum:
- ASC
- DESC
default: DESC
FileSystemIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system.
in: path
name: fileSystemId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ReplicationDeleteModeQueryParam:
description: 'You can choose a mode for deleting the replication resource.
- `FINISH_CYCLE_IF_CAPTURING_OR_APPLYING` Before deleting, complete the current delta cycle. If cycle is idle, delete immediately. Safest option.
- `ONE_MORE_CYCLE` Before deleting, complete the current delta cycle, and initiate one more cycle. If cycle is idle, initiate one more cycle. Use for lossless failover.
- `FINISH_CYCLE_IF_APPLYING` Before deleting, finish applying. If cycle is idle or capturing, delete immediately. Fastest option.
'
in: query
name: deleteMode
required: false
schema:
type: string
enum:
- FINISH_CYCLE_IF_CAPTURING_OR_APPLYING
- ONE_MORE_CYCLE
- FINISH_CYCLE_IF_APPLYING
default: FINISH_CYCLE_IF_APPLYING
FilesystemSnapshotPolicyIdListStOptionalQueryParam:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy
that is used to create the snapshots.
'
in: query
name: filesystemSnapshotPolicyId
required: false
schema:
type: string
default: none
maxLength: 255
minLength: 1
ReplicationTargetSortByQueryParam:
description: 'The field to sort by. You can choose either value, but not both.
By default, when you sort by `timeCreated`, results are shown
in descending order. When you sort by `displayName`, results are
shown in ascending order.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeCreated
- displayName
default: timeCreated
FileSystemOptionalQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system.
in: query
name: fileSystemId
required: false
schema:
type: string
default: none
maxLength: 255
minLength: 1
ExportSortByQueryParam:
description: 'The field to sort by. You can provide either value, but not both.
By default, when you sort by time created, results are shown
in descending order. When you sort by path, results are
shown in ascending alphanumeric order.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIMECREATED
- PATH
default: TIMECREATED
RequestIdHeader:
description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
schema:
type: string
pattern: '[A-Za-z0-9\-_\.]+'
CompartmentIdOptionalQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
in: query
name: compartmentId
required: false
schema:
type: string
default: none
maxLength: 255
minLength: 1
ReplicationEstimateChangeRateQueryParam:
description: The rate of change of data on source file system in MegaBytes per second.
in: query
name: changeRateInMBps
required: false
schema:
type: integer
default: 0
ExportSetOptionalQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the export set.
in: query
name: exportSetId
required: false
schema:
type: string
default: none
maxLength: 255
minLength: 1
OutboundConnectorIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the outbound connector.
in: path
name: outboundConnectorId
required: true
schema:
type: string
maxLength: 255
minLength: 1
parentFileSystemIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system that contains the source snapshot of a cloned file system. See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
in: query
name: parentFileSystemId
required: false
schema:
type: string
maxLength: 255
minLength: 1
LifecycleStateQueryParam:
description: 'Filter results by the specified lifecycle state. Must be a valid
state for the resource type.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
schema:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
ReplicationIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the replication.
in: path
name: replicationId
required: true
schema:
type: string
maxLength: 255
minLength: 1
CanDetachChildFileSystemQueryParam:
description: 'If the value is set to true, then the file system will be deleted by detaching its child file system, turning
the child file system into an independent File System.
'
in: query
name: canDetachChildFileSystem
required: false
schema:
type: boolean
default: false
SourceFileSystemQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the source file system.
in: query
name: fileSystemId
required: false
schema:
type: string
maxLength: 255
minLength: 1
DisplayNameQueryParam:
description: 'A user-friendly name. It does not have to be unique, and it is changeable.
Example: `My resource`
'
in: query
name: displayName
required: false
schema:
type: string
default: none
maxLength: 255
minLength: 1
SnapshotPaginationLimitQueryParam:
description: 'For list pagination. The maximum number of results per page,
or items to return in a paginated "List" call.
1 is the minimum, 100 is the maximum.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
Example: `100`
'
in: query
name: limit
required: false
schema:
type: integer
default: 100
maximum: 100
minimum: 1
PaginationTokenQueryParam:
description: 'For list pagination. The value of the `opc-next-page` response
header from the previous "List" call.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
in: query
name: page
required: false
schema:
type: string
default: none
maxLength: 512
minLength: 1
FilesystemSnapshotPolicyIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy.
in: path
name: filesystemSnapshotPolicyId
required: true
schema:
type: string
maxLength: 255
minLength: 1
MountTargetIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the mount target.
in: path
name: mountTargetId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ExportIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the export.
in: path
name: exportId
required: true
schema:
type: string
maxLength: 255
minLength: 1
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
default: none
maxLength: 64
minLength: 1
MountTargetSortByQueryParam:
description: 'The field to sort by. You can choose either value, but not both.
By default, when you sort by time created, results are shown
in descending order. When you sort by display name, results are
shown in ascending order.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIMECREATED
- DISPLAYNAME
default: TIMECREATED
PrincipalIdQueryParam:
description: 'An identifier for the user or the group associated with quota rule and usage. UNIX-like operating systems use this integer value to
identify a user or group to manage access control.
'
in: query
name: principalId
required: false
schema:
type: integer
FilesystemSnapshotPolicyIdListFsOptionalQueryParam:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the file system snapshot policy
that is associated with the file systems.
'
in: query
name: filesystemSnapshotPolicyId
required: false
schema:
type: string
default: none
maxLength: 255
minLength: 1
ExportSetIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the export set.
in: path
name: exportSetId
required: true
schema:
type: string
maxLength: 255
minLength: 1
sourceSnapshotIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot used to create a cloned file system. See [Cloning a File System](/iaas/Content/File/Tasks/cloningFS.htm).
in: query
name: sourceSnapshotId
required: false
schema:
type: string
maxLength: 255
minLength: 1
ExportSetSortByQueryParam:
description: 'The field to sort by. You can provide either value, but not both.
By default, when you sort by time created, results are shown
in descending order. When you sort by display name, results are
shown in ascending order.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIMECREATED
- DISPLAYNAME
default: TIMECREATED
OcidQueryParam:
description: 'Filter results by [OCID](/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for
the resouce type.
'
in: query
name: id
required: false
schema:
type: string
default: none
maxLength: 255
minLength: 1
SnapshotIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the snapshot.
in: path
name: snapshotId
required: true
schema:
type: string
maxLength: 255
minLength: 1
AreViolatorsOnlyQueryParam:
description: 'An option to display only the users or groups that violate their quota rules.
If `areViolatorsOnly` is false, results report all the quota and usage.
If `areViolatorsOnly` is true, results only report the quota and usage for
the users or groups that violate their quota rules.
'
in: query
name: areViolatorsOnly
required: false
schema:
type: boolean
default: false
CompartmentIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
in: query
name: compartmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
PaginationLimitQueryParam:
description: 'For list pagination. The maximum number of results per page,
or items to return in a paginated "List" call.
1 is the minimum, 4096 is the maximum.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
Example: `500`
'
in: query
name: limit
required: false
schema:
type: integer
default: 200
maximum: 4096
minimum: 1
FilesystemSnapshotPolicySortByQueryParam:
description: 'The field to sort by. You can provide either value, but not both.
By default, when you sort by time created, results are shown
in descending order. When you sort by displayName, results are
shown in ascending alphanumeric order.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIMECREATED
- DISPLAYNAME
default: TIMECREATED
OverrideLocksQueryParameter:
description: Whether to override locks (if any exist).
in: query
name: isLockOverride
schema:
type: boolean
default: false
FileSystemSortByQueryParam:
description: 'The field to sort by. You can provide either value, but not both.
By default, when you sort by time created, results are shown
in descending order. When you sort by display name, results are
shown in ascending order.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIMECREATED
- DISPLAYNAME
default: TIMECREATED
PrincipalTypeQueryParam:
description: 'The type of the owner of this quota rule and usage.
'
in: query
name: principalType
required: true
schema:
type: string
enum:
- FILE_SYSTEM_LEVEL
- DEFAULT_GROUP
- DEFAULT_USER
- INDIVIDUAL_GROUP
- INDIVIDUAL_USER
OutboundConnectorSortByQueryParam:
description: 'The field to sort by. You can choose either value, but not both.
By default, when you sort by time created, results are shown
in descending order. When you sort by display name, results are
shown in ascending order.
'
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIMECREATED
- DISPLAYNAME
default: TIMECREATED
responses:
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'
x-anchors:
x-headers:
etag:
description: For optimistic concurrency control. See `if-match`.
type: string
opc-next-page:
description: 'For list pagination. When this header appears in the response,
additional pages of results remain.
For important details about how pagination works,
see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
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
x-properties:
DefinedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
FreeformTags:
additionalProperties:
type: string
description: "Free-form tags for this resource. Each tag is a simple key-value pair\n with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\nExample: `{\"Department\": \"Finance\"}`\n"
type: object
SystemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string type is supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'System tags for this resource.
System tags are applied to resources by internal OCI services.
'
type: object
nsgIds:
description: 'A list of Network Security Group [OCIDs](/Content/General/Concepts/identifiers.htm) associated with this mount target.
A maximum of 5 is allowed.
Setting this to an empty array after the list is created removes the mount target from all NSGs.
For more information about NSGs, see [Security Rules](/Content/Network/Concepts/securityrules.htm).
'
items:
maxLength: 255
minLength: 1
type: string
maxItems: 5
type: array
uniqueItems: true
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](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
type: object
x-obmcs-endpoint-service-name: filestorage
x-replication-tenancies:
replication-internal-api-tenants:
- boat
- '{fleet_tenancy_ocid}'
- ocid1.tenancy.oc1..aaaaaaaafdwabtfzxgnxwz6bz5b7faubjlb3rofibg6dpc63s4svyt66awxa
- ocid1.tenancy.oc1..aaaaaaaanpxmpktnydmj6ycoy7csb7y4i4zvssk37ucfl2nwkf25yju7mrtq
- ocid1.tenancy.oc1..aaaaaaaafol4o2jwcdodnqtpg2txwqthxiohlv37qv4zwahhxu4l7ywjim2q
- ocid1.tenancy.oc1..aaaaaaaay6rlnktcwzjg2r2sxneuue6lfr5sxhcn76galegasxihdy3ubz5a
- ocid1.tenancy.oc1..aaaaaaaafysmmwfbn57eldyhbci7ds6yazeidhsmqqhmcc54ot6zdpv3ecva
- ocid1.tenancy.oc2..aaaaaaaa2abri3gakkoiqsnqumeaxwbdp7dr5qaa7oagiz2aglxhss24sbka
- ocid1.tenancy.oc3..aaaaaaaaqmowmzyt3y7pfnftktprjvc6xzxsdubbqi43i4ydvzfhbjoc2eqq
- ocid1.tenancy.oc4..aaaaaaaaojxdlq2uucqh62ddzolpf5hjwi7hbi6frrlhvcpnhfw25ehvfisq
- ocid1.tenancy.oc5..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc6..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc7..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc8..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc9..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc10..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc11..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc12..aaaaaaaakmft2zdl5sa5hq6jkyzh2d2chtofe7offf4sadbcyqowef3revcq
- ocid1.tenancy.oc14..aaaaaaaa5lneiufwtsklzouecgrxovilp3vcnjmvtg5vgzemwmxy66d3wrta
- ocid1.tenancy.oc16..aaaaaaaaytolxm2sdkxiriwjkzolb2wnl2z3i47gxasgxnvw3pqtw5ipwaoa
- ocid1.tenancy.oc17..aaaaaaaaikfmqdbdsxwve4ftfxnotjh4nbejxvtgaf7cycp4vb25f3rh4qsa
- ocid1.tenancy.oc19..aaaaaaaakc3ymawqlm5myqelh7zirtbkh2wb74x55eegr2ypwmxul6jshhxq
- ocid1.tenancy.oc20..aaaaaaaaqf7zs555ojqiq2ks7y2lneyptw2547bz77kpoypezn75juyltxoq
- ocid1.tenancy.oc22..aaaaaaaautad3dsh242qjmm4lq5bdk7l2mlozsa24i6iocbq2dzedsdgrogq
replication-splat-internal-api-tenants:
- splat
- '{fleet_tenancy_ocid}'
- ocid1.tenancy.oc1..aaaaaaaafdwabtfzxgnxwz6bz5b7faubjlb3rofibg6dpc63s4svyt66awxa
- ocid1.tenancy.oc1..aaaaaaaanpxmpktnydmj6ycoy7csb7y4i4zvssk37ucfl2nwkf25yju7mrtq
- ocid1.tenancy.oc1..aaaaaaaafol4o2jwcdodnqtpg2txwqthxiohlv37qv4zwahhxu4l7ywjim2q
- ocid1.tenancy.oc1..aaaaaaaay6rlnktcwzjg2r2sxneuue6lfr5sxhcn76galegasxihdy3ubz5a
- ocid1.tenancy.oc1..aaaaaaaafysmmwfbn57eldyhbci7ds6yazeidhsmqqhmcc54ot6zdpv3ecva
- ocid1.tenancy.oc2..aaaaaaaa2abri3gakkoiqsnqumeaxwbdp7dr5qaa7oagiz2aglxhss24sbka
- ocid1.tenancy.oc3..aaaaaaaaqmowmzyt3y7pfnftktprjvc6xzxsdubbqi43i4ydvzfhbjoc2eqq
- ocid1.tenancy.oc4..aaaaaaaaojxdlq2uucqh62ddzolpf5hjwi7hbi6frrlhvcpnhfw25ehvfisq
- ocid1.tenancy.oc5..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc6..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc7..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc8..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc9..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc10..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc11..aaaaaaaav5ii2tn57e56brsveotzoux5bnjv3euot4dlohwb7fzapqevaeka
- ocid1.tenancy.oc12..aaaaaaaakmft2zdl5sa5hq6jkyzh2d2chtofe7offf4sadbcyqowef3revcq
- ocid1.tenancy.oc14..aaaaaaaa5lneiufwtsklzouecgrxovilp3vcnjmvtg5vgzemwmxy66d3wrta
- ocid1.tenancy.oc16..aaaaaaaaytolxm2sdkxiriwjkzolb2wnl2z3i47gxasgxnvw3pqtw5ipwaoa
- ocid1.tenancy.oc17..aaaaaaaaikfmqdbdsxwve4ftfxnotjh4nbejxvtgaf7cycp4vb25f3rh4qsa
- ocid1.tenancy.oc19..aaaaaaaakc3ymawqlm5myqelh7zirtbkh2wb74x55eegr2ypwmxul6jshhxq
- ocid1.tenancy.oc20..aaaaaaaaqf7zs555ojqiq2ks7y2lneyptw2547bz77kpoypezn75juyltxoq
- ocid1.tenancy.oc22..aaaaaaaautad3dsh242qjmm4lq5bdk7l2mlozsa24i6iocbq2dzedsdgrogq