Console
    Contact Us Start free

    REST Resource: projects.locations.instances

    Resource: Instance

    A Managed Lustre instance.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "filesystem" 
 : 
 string 
 , 
 "capacityGib" 
 : 
 string 
 , 
 "network" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "mountPoint" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "perUnitStorageThroughput" 
 : 
 string 
 , 
 "gkeSupportEnabled" 
 : 
 boolean 
 , 
 "accessRulesOptions" 
 : 
 { 
 object (  AccessRulesOptions 
 
) 
 } 
 , 
 "uid" 
 : 
 string 
 }
    Fields
    name

    string

    Identifier. The name of the instance.
    filesystem

    string

    Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers.
    capacityGib

    string ( int64 format)

    Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 7632000 , depending on the perUnitStorageThroughput . See Performance tiers and maximum storage capacities for specific minimums, maximums, and step sizes for each performance tier.
    network

    string

    Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{projectId}/global/networks/{network_name} .
    state

    enum ( State )

    Output only. The state of the instance.
    mountPoint

    string

    Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM .
    createTime

    string ( Timestamp format)

    Output only. Timestamp when the instance was created.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

    Output only. Timestamp when the instance was last updated.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    description

    string

    Optional. A user-readable description of the instance.
    labels

    map (key: string, value: string)

    Optional. Labels as key value pairs.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    perUnitStorageThroughput

    string ( int64 format)

    Required. The throughput of the instance in MB/s/TiB. Valid values are 125, 250, 500, 1000. See Performance tiers and maximum storage capacities for more information.
    gkeSupportEnabled
    (deprecated)

    boolean

    Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported. Deprecated. No longer required for GKE instance creation.
    accessRulesOptions

    object ( AccessRulesOptions )

    Optional. The access rules options for the instance.
    uid

    string

    Output only. Unique ID of the resource. This is unrelated to the access rules which allow specifying the root squash uid.

    State

    The possible states of an instance.

    Enums
    STATE_UNSPECIFIED Not set.
    ACTIVE The instance is available for use.
    CREATING The instance is being created and is not yet ready for use.
    DELETING The instance is being deleted.
    UPGRADING The instance is being upgraded.
    REPAIRING The instance is being repaired.
    STOPPED The instance is stopped.
    UPDATING

    The instance is being updated.

    AccessRulesOptions

    IP-based access rules for the Managed Lustre instance. These options define the root user squash configuration.

    JSON representation 
     { 
 "accessRules" 
 : 
 [ 
 { 
 object (  AccessRule 
 
) 
 } 
 ] 
 , 
 "defaultSquashMode" 
 : 
 enum (  SquashMode 
 
) 
 , 
 "defaultSquashUid" 
 : 
 integer 
 , 
 "defaultSquashGid" 
 : 
 integer 
 }
    Fields
    accessRules[]

    object ( AccessRule )

    Optional. The access rules for the instance.
    defaultSquashMode

    enum ( SquashMode )

    Required. The squash mode for the default access rule.
    defaultSquashUid

    integer

    Optional. The user squash UID for the default access rule. This user squash UID applies to all root users connecting from clients that are not matched by any of the access rules. If not set, the default is 0 (no UID squash).
    defaultSquashGid

    integer

    Optional. The user squash GID for the default access rule. This user squash GID applies to all root users connecting from clients that are not matched by any of the access rules. If not set, the default is 0 (no GID squash).

    AccessRule

    A single policy group with IP-based access rules for the Managed Lustre instance.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "ipAddressRanges" 
 : 
 [ 
 string 
 ] 
 , 
 "squashMode" 
 : 
 enum (  SquashMode 
 
) 
 }
    Fields
    name

    string

    Required. The name of the access rule policy group. Must be 16 characters or less and include only alphanumeric characters or '_'.
    ipAddressRanges[]

    string

    Required. The IP address ranges to which to apply this access rule. Accepts non-overlapping CIDR ranges (e.g., 192.168.1.0/24 ) and IP addresses (e.g., 192.168.1.0 ).
    squashMode

    enum ( SquashMode )

    Required. Squash mode for the access rule.

    SquashMode

    Squash mode for an access rule.

    Enums
    SQUASH_MODE_UNSPECIFIED Unspecified squash mode.
    NO_SQUASH

    Squash is disabled.

    If set inside an AccessRule , root users matching the [ip_ranges][AccessRule.ip_ranges] are not squashed.

    If set as the defaultSquashMode , root squash is disabled for this instance.

    If the default squash mode is NO_SQUASH , do not set the defaultSquashUid or defaultSquashGid , or an invalid argument error is returned.
    ROOT_SQUASH

    Root user squash is enabled.

    Not supported inside an AccessRule .

    If set as the defaultSquashMode , root users not matching any of the accessRules are squashed to the defaultSquashUid and defaultSquashGid .

    Methods

    create

    		Creates a new instance in a given project and location.

    delete

    		Deletes a single instance.

    exportData

    		Exports data from a Managed Lustre instance to Cloud Storage.

    get

    		Gets details of a single instance.

    importData

    		Imports data from Cloud Storage to a Managed Lustre instance.

    list

    		Lists instances in a given project and location.

    patch

    		Updates the parameters of a single instance.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: