Jump to

• Request
• Response

ListMountTargets

get

/20171215/mountTargets

Lists the mount target resources in the specified compartment.

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

  Maximum Length: 255

  The OCID of the export set.

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

  Maximum Length: 255

  The OCID of the share set.

  Default Value: none
• sortBy: string
  The field to sort by. You can choose 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).

  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.

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. 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.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object MountTargetSummary
  Summary information for the specified mount target.

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

Nested Schema : MountTargetSummary

Type: object

Summary information for the specified mount target.

Show Source

• availabilityDomain: string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain the mount target 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 mount target.
• 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.
• exportSetId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the associated export set. Controls what file systems will be exported using Network File System (NFS) protocol on this mount target.
• 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 mount target.
• idmapType: string
  Describes whether Idmapping is turned on or off. If on, describes the method used to perform OCID Mapping
• ldapIdmap: object LdapIdmap
  Mount Target details about the LDAP ID Map configuration.
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]

  The current state of the mount target.
• nsgIds: array nsgIds
  Maximum Number of Items: 5

  Unique Items Required: true

  A list of Network Security Group OCIDs 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.
• privateIpIds(required): array privateIpIds
  The OCIDs of the private IP addresses associated with this mount target.
• shareSetId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the associated share set. Controls what file systems will be shared through SMB protocol on this mount target.
• subnetId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the subnet the mount target is in.
• 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 mount target 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 the specified mount target.",
    "x-example":"[  {   \"availabilityDomain\": \"AD-1\",   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"displayName\": \"mount-target-5\",   \"exportSetId\": \"ocid1.exportset.<var>unique_ID</var>\",   \"id\": \"ocid1.mounttarget.<var>unique_ID</var>\",   \"lifecycleState\": \"ACTIVE\",   \"privateIpIds\": [   \"ocid1.privateip.<var>unique_ID</var>\"   ],   \"subnetId\": \"ocid1.subnet.<var>unique_ID</var>\",   \"nsgIds\": [   \"ocid1.networksecuritygroup.<var>unique_ID</var>\"   ],   \"timeCreated\": \"2017-12-01T22:13:22.534Z\"   ,\"freeformTags\": {     \"tag1\": \"value1\",     \"tag2\": \"value2\"   },   \"definedTags\": {     \"tagGroup\": {       \"tag001\": \"tag4\",       \"tag002\": \"tag5\",       \"tag003\": \"tag6\"     }   }  },  {   \"availabilityDomain\": \"AD-1\",   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"displayName\": \"mount-target-6\",   \"exportSetId\": \"ocid1.exportset.<var>unique_ID</var>\",   \"id\": \"ocid1.mounttarget.<var>unique_ID</var>\",   \"lifecycleState\": \"ACTIVE\",   \"privateIpIds\": [   \"ocid1.privateip.<var>unique_ID</var>\"   ],   \"subnetId\": \"ocid1.subnet.<var>unique_ID</var>\",   \"nsgIds\": [   \"ocid1.networksecuritygroup.<var>unique_ID</var>\"   ],   \"timeCreated\": \"2017-12-01T22:15:20.264Z\"   ,\"freeformTags\": {     \"tag10\": \"value10\",     \"tag20\": \"value20\"   },   \"definedTags\": {     \"tagGroup\": {       \"tag0010\": \"tag40\",       \"tag0020\": \"tag50\",       \"tag0030\": \"tag60\"     }   }  } ] ",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain the mount target is in. May be unset as a blank or NULL value. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the mount target.",
            "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"
        },
        "exportSetId":{
            "description":"The OCID 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"
        },
        "id":{
            "description":"The OCID 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"
            ],
            "type":"string"
        },
        "privateIpIds":{
            "description":"The OCIDs of the private IP addresses associated with this mount target.",
            "type":"array",
            "items":{
                "maxLength":"255",
                "minLength":"1",
                "type":"string"
            }
        },
        "subnetId":{
            "description":"The OCID of the subnet the mount target is in.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "idmapType":{
            "description":"Describes whether Idmapping is turned on or off. If on, describes the method used to perform OCID Mapping",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/MountTarget/idmapType"
        },
        "ldapIdmap":{
            "$ref":"#/definitions/LdapIdmap"
        },
        "nsgIds":{
            "type":"array",
            "description":"A list of Network Security Group OCIDs 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.",
            "items":{
                "type":"string",
                "minLength":"1",
                "maxLength":"255"
            },
            "maxItems":"5",
            "uniqueItems":true
        },
        "shareSetId":{
            "description":"The OCID of the associated share set. Controls what file systems will be shared through SMB protocol on this mount target.",
            "maxLength":"255",
            "minLength":"1",
            "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"
        },
        "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."
                }
            }
        }
    },
    "required":[
        "compartmentId",
        "displayName",
        "id",
        "lifecycleState",
        "privateIpIds",
        "subnetId",
        "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 : LdapIdmap

Type: object

Mount Target details about the LDAP ID Map configuration.

Show Source

• baseDistinguishedGroupName(required): string
  Minimum Length: 1

  Maximum Length: 255

  All LDAP searches are recursive starting at this Base Distinguished group name.
• baseDistinguishedUserName(required): string
  Minimum Length: 1

  Maximum Length: 255

  All LDAP searches are recursive starting at this Base Distinguished user name.
• cacheLifetimeSeconds: integer
  Minimum Value: 300

  Maximum Value: 1000

  Default Value: 300

  Integer for how long cached entries may be used.
• cacheRefreshIntervalSeconds: integer
  Minimum Value: 300

  Maximum Value: 1000

  Default Value: 300

  Integer for how often the mount target should recheck LDAP for updates.
• negativeCacheLifetimeSeconds: integer
  Minimum Value: 300

  Maximum Value: 1000

  Default Value: 300

  Integer for how long to cache if idmap information is missing.
• outboundConnector1Id: string
  Minimum Length: 1

  Maximum Length: 255

  OCID of the first LDAP Account
• outboundConnector2Id: string
  Minimum Length: 1

  Maximum Length: 255

  OCID of the second LDAP Account
• schemaType: string
  Default Value: RFC2307

  Allowed Values: [ "RFC2307" ]

  Schema type of LDAP account.

{
    "description":"Mount Target details about the LDAP ID Map configuration.",
    "properties":{
        "schemaType":{
            "description":"Schema type of LDAP account.",
            "enum":[
                "RFC2307"
            ],
            "type":"string",
            "default":"RFC2307"
        },
        "cacheRefreshIntervalSeconds":{
            "description":"Integer for how often the mount target should recheck LDAP for updates.",
            "maximum":"1000",
            "minimum":"300",
            "type":"integer",
            "default":"300"
        },
        "cacheLifetimeSeconds":{
            "description":"Integer for how long cached entries may be used.",
            "maximum":"1000",
            "minimum":"300",
            "type":"integer",
            "default":"300"
        },
        "negativeCacheLifetimeSeconds":{
            "description":"Integer for how long to cache if idmap information is missing.",
            "maximum":"1000",
            "minimum":"300",
            "type":"integer",
            "default":"300"
        },
        "baseDistinguishedUserName":{
            "description":"All LDAP searches are recursive starting at this Base Distinguished user name.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "baseDistinguishedGroupName":{
            "description":"All LDAP searches are recursive starting at this Base Distinguished group name.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "outboundConnector1Id":{
            "description":"OCID of the first LDAP Account",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "outboundConnector2Id":{
            "description":"OCID of the second LDAP Account",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "baseDistinguishedUserName",
        "baseDistinguishedGroupName"
    ],
    "type":"object"
}

Nested Schema : nsgIds

Type: array

Maximum Number of Items: 5

Unique Items Required: true

A list of Network Security Group OCIDs 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.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "type":"array",
    "description":"A list of Network Security Group OCIDs 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.",
    "items":{
        "type":"string",
        "minLength":"1",
        "maxLength":"255"
    },
    "maxItems":"5",
    "uniqueItems":true
}

Nested Schema : privateIpIds

Type: array

The OCIDs of the private IP addresses associated with this mount target.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "description":"The OCIDs of the private IP addresses associated with this mount target.",
    "type":"array",
    "items":{
        "maxLength":"255",
        "minLength":"1",
        "type":"string"
    }
}

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. 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."
        }
    }
}

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