Jump to

• Request
• Response

GetFileSystem

get

/20171215/fileSystems/{file_system_id}

Gets the specified file system's information.

Request

Supported Media Types

• application/json

Path Parameters

• fileSystemId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the file system.

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The file system was retrieved.

Headers

• etag: string
  For optimistic concurrency control. See if-match.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : FileSystem

Type: object

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.

Show Source

• availabilityDomain: string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain the file system is in. May be unset as a blank or NULL value. Example: AD-1
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment that contains the file system.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the file system.
• isCloneParent: boolean
  Whether the file system has been cloned.
• isHydrated: boolean
  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.
• isTargetable: boolean
  Whether the file system can be used as a target file system for replication.
• kmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the KMS key which is the master encryption key for the file system.
• lifecycleDetails: string
  Additional information about the current 'lifecycleState'.
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]

  The current state of the file system.
• meteredBytes(required): integer(int64)
  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.
• replicationTargetId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the replication target associated with the file system. Empty if the file system is not being used as target in a replication.
• snapshotPolicyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the associated Filesystem Snapshot Policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.
• sourceDetails: object SourceDetails
  Source information for the file system.
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  Not used by File Systems but required for SPLAT tag integration.
• timeCreated(required): string(date-time)
  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

{
    "x-obmcs-splat":{
        "resourceKind":"file-systems",
        "adLocality":"ad-local",
        "taggable":true,
        "activeLifecycleStates":[
            "ACTIVE"
        ],
        "deletedLifecycleStates":[
            "DELETED",
            "FAILED"
        ],
        "getOperationId":"GetFileSystem",
        "listResourcesOperationId":"ListFileSystems",
        "ocidEntityType":"filesystem",
        "useSurrogateKeyForCreation":true,
        "getBySurrogateKeyUri":"/20171215/fileSystems/splat-request",
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"FileSystem",
            "scope":"customer",
            "rvnFromHeader":true
        }
    },
    "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.",
    "x-example":"{   \"availabilityDomain\": \"AD-1\",   \"meteredBytes\": 0,   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"displayName\": \"media-files-1\",   \"id\": \"ocid1.filesystem.<var>unique_ID</var>\",   \"lifecycleState\": \"ACTIVE\",   \"timeCreated\": \"2017-11-25T21:14:50.024Z\" } ",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain the file system is in. May be unset as a blank or NULL value. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "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"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the file system.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. It does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "id":{
            "description":"The OCID of the file system.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the file system.",
            "enum":[
                "CREATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ],
            "type":"string"
        },
        "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"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair  with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported."
                }
            }
        },
        "systemTags":{
            "description":"Not used by File Systems but required for SPLAT tag integration.",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string type is supported."
                }
            }
        },
        "kmsKeyId":{
            "description":"The OCID of the KMS key which is the master encryption key for the file system.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "sourceDetails":{
            "$ref":"#/definitions/SourceDetails"
        },
        "isCloneParent":{
            "description":"Whether the file system has been cloned.",
            "type":"boolean"
        },
        "isHydrated":{
            "description":"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.",
            "type":"boolean"
        },
        "lifecycleDetails":{
            "description":"Additional information about the current 'lifecycleState'.",
            "type":"string"
        },
        "isTargetable":{
            "description":"Whether the file system can be used as a target file system for replication.",
            "type":"boolean"
        },
        "replicationTargetId":{
            "description":"The OCID 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"
        },
        "snapshotPolicyId":{
            "description":"The OCID of the associated Filesystem Snapshot Policy, which controls the frequency of snapshot creation and retention period of the taken snapshots.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "meteredBytes",
        "compartmentId",
        "displayName",
        "id",
        "lifecycleState",
        "timeCreated"
    ],
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  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. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported."
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair  with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : SourceDetails

Type: object

Source information for the file system.

Show Source

• parentFileSystemId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the file system that contains the source snapshot of a cloned file system.
• sourceSnapshotId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the source snapshot used to create a cloned file system.

{
    "description":"Source information for the file system.",
    "properties":{
        "parentFileSystemId":{
            "description":"The OCID of the file system that contains the source snapshot of a cloned file system.",
            "type":"string",
            "maxLength":"255",
            "minLength":"1"
        },
        "sourceSnapshotId":{
            "description":"The OCID of the source snapshot used to create a cloned file system.",
            "type":"string",
            "maxLength":"255",
            "minLength":"1"
        }
    },
    "type":"object"
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}

{
    "description":"Not used by File Systems but required for SPLAT tag integration.",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"} ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string type is supported."
        }
    }
}

Not used by File Systems but required for SPLAT tag integration.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  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\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported."
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  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\"} ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string type is supported."
    }
}

Key-value pair representing system tags' keys and values scoped to a namespace. Example: {"bar-key": "value"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string type is supported.

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top