Jump to

• Request
• Response

List File Systems

get

/20171215/fileSystems

List the file system resources in the specified compartment, or by the specified compartment and filesystem snapshot policy.

Request

Supported Media Types

• application/json

Query Parameters

• availabilityDomain: string
  The availability domain of the pod shape.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  The displayName of a resource.

  Default Value: none
• filesystemSnapshotPolicyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Filesystem Snapshot Policy that is associated with the filesystems or used to create the snapshots.

  Default Value: none
• id: string
  Minimum Length: 1

  Maximum Length: 255

  Filter results by OCID. Must be an OCID of the correct type for the resouce type.

  Default Value: none
• lifecycleState: string
  The state of a resource.

  Allowed Values: [ "ACTIVE" ]
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: 0
• parentFileSystemId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the file system that contains the source snapshot of a cloned file system.
• sortBy: string
  The field to sort by. You can provide either value, but not both. When you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order.

  Default Value: TIMECREATED

  Allowed Values: [ "TIMECREATED", "DISPLAYNAME" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Default Value: ASC

  Allowed Values: [ "ASC", "DESC" ]
• sourceSnapshotId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the snapshot used to create a cloned 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 list is being retrieved.

Headers

• opc-next-page: string
  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).
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object FileSystemSummary
  Summary information for a file system.

{
    "items":{
        "$ref":"#/definitions/FileSystemSummary"
    },
    "type":"array"
}

Nested Schema : FileSystemSummary

Type: object

Summary information for a file system.

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.
• kmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the KMS key used to encrypt the encryption keys associated with this 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.
• 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

{
    "description":"Summary information for a file system.",
    "x-example":"[  {   \"availabilityDomain\": \"pWEh:PHX-AD-2\",   \"meteredBytes\": 0,   \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",   \"displayName\": \"media-files-1\",   \"id\": \"ocid1.filesystem.oc1..<var>&lt;unique_ID&gt;</var>\",   \"lifecycleState\": \"ACTIVE\",   \"timeCreated\": \"2017-11-25T21:14:50.024Z\"   ,\"freeformTags\" : {     \"tag1\" : \"value1\",     \"tag2\" : \"value2\"   },   \"definedTags\" : {     \"tagGroup\" : {       \"tag001\" : \"tag4\",       \"tag002\" : \"tag5\",       \"tag003\" : \"tag6\"     }   }  }, {  \"availabilityDomain\": \"pWEh:PHX-AD-1\",  \"meteredBytes\": 0,  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",  \"displayName\": \"vmdk-repo-1\",  \"id\": \"ocid1.filesystem.oc1..<var>&lt;unique_ID&gt;</var>\",  \"lifecycleState\": \"ACTIVE\",  \"timeCreated\": \"2017-11-29T21:04:12.622Z\"   ,\"freeformTags\" : {     \"tag10\" : \"value10\",     \"tag20\" : \"value20\"   },   \"definedTags\" : {     \"tagGroup\" : {       \"tag0010\" : \"tag40\",       \"tag0020\" : \"tag50\",       \"tag0030\" : \"tag60\"     }   }  } ] ",
    "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 used to encrypt the encryption keys associated with this 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"
        }
    },
    "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.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top