ListExports
get
/20171215/exports
Lists export resources by compartment, file system, or export set. You must specify an export set OCID, a file system OCID, and / or a compartment OCID.
Request
Supported Media Types
- application/json
Query Parameters
-
compartmentId: string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment.Default Value:none
-
exportSetId: string
Minimum Length:
1
Maximum Length:255
The OCID of the export set.Default Value:none
-
fileSystemId: string
Minimum Length:
1
Maximum Length:255
The OCID of the file system.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.Default Value:
ACTIVE
Allowed Values:[ "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", "UPDATING" ]
-
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:oracle.doceng.json.BetterJsonNull@2c07545f
-
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 path, results are shown in ascending alphanumeric order.Default Value:
TIMECREATED
Allowed Values:[ "TIMECREATED", "PATH" ]
-
sortOrder: string
The sort order to use, either ascending (ASC) or descending (DESC).Allowed Values:
[ "ASC", "DESC" ]
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.
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. Use this value as the page parameter to get the next page of items.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object ExportSummary
Summary information for an export.
Nested Schema : ExportSummary
Type:
object
Summary information for an export.
Show Source
-
exportMode:
string
Allowed Values:
[ "ENABLED", "DISABLED" ]
Export can be created in 'ENABLED' or 'DISABLED' mode. Attempt to mount the filesystem will fail if the export is in 'DISABLED' mode. -
exportSetId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of this export's export set. -
fileSystemId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of this export's file system. -
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of this export. -
isIdmapGroupsForSysAuth:
boolean
The export is modified to include a boolean to 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 the data path uses an empty secondary group list for authorization. If the number of groups exceeds the current limit of 256 groups the list retrieved from LDAP is truncated to the first 256 groups read.
-
lifecycleState(required):
string
Allowed Values:
[ "CREATING", "ACTIVE", "DELETING", "DELETED" ]
The current state of this export. -
path(required):
string
Minimum Length:
1
Maximum Length:1024
Path used to access the associated file system. Avoid entering confidential information. Example: /mediafiles -
timeCreated(required):
string(date-time)
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
400 Response
Bad Request
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.
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
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.
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
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.
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
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.
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
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.
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
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.
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