Console
    Contact Us Start free

    REST Resource: storagePools

    Resource: StoragePool

    Represents a zonal storage pool resource.

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "creationTimestamp" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "poolProvisionedCapacityGb" 
 : 
 string 
 , 
 "poolProvisionedIops" 
 : 
 string 
 , 
 "poolProvisionedThroughput" 
 : 
 string 
 , 
 "zone" 
 : 
 string 
 , 
 "state" 
 : 
 enum 
 , 
 "selfLink" 
 : 
 string 
 , 
 "selfLinkWithId" 
 : 
 string 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "labelFingerprint" 
 : 
 string 
 , 
 "resourceStatus" 
 : 
 { 
 "lastResizeTimestamp" 
 : 
 string 
 , 
 "diskCount" 
 : 
 string 
 , 
 "poolUsedCapacityBytes" 
 : 
 string 
 , 
 "poolUserWrittenBytes" 
 : 
 string 
 , 
 "totalProvisionedDiskCapacityGb" 
 : 
 string 
 , 
 "maxTotalProvisionedDiskCapacityGb" 
 : 
 string 
 , 
 "poolUsedIops" 
 : 
 string 
 , 
 "totalProvisionedDiskIops" 
 : 
 string 
 , 
 "poolUsedThroughput" 
 : 
 string 
 , 
 "totalProvisionedDiskThroughput" 
 : 
 string 
 } 
 , 
 "storagePoolType" 
 : 
 string 
 , 
 "status" 
 : 
 { 
 "lastResizeTimestamp" 
 : 
 string 
 , 
 "diskCount" 
 : 
 string 
 , 
 "poolUsedCapacityBytes" 
 : 
 string 
 , 
 "poolUserWrittenBytes" 
 : 
 string 
 , 
 "totalProvisionedDiskCapacityGb" 
 : 
 string 
 , 
 "maxTotalProvisionedDiskCapacityGb" 
 : 
 string 
 , 
 "poolUsedIops" 
 : 
 string 
 , 
 "totalProvisionedDiskIops" 
 : 
 string 
 , 
 "poolUsedThroughput" 
 : 
 string 
 , 
 "totalProvisionedDiskThroughput" 
 : 
 string 
 } 
 , 
 "capacityProvisioningType" 
 : 
 enum 
 , 
 "performanceProvisioningType" 
 : 
 enum 
 }
    Fields
    kind

    string

    [Output Only] Type of the resource. Always compute#storagePool for storage pools.

    id

    string ( uint64 format)

    [Output Only] The unique identifier for the resource. This identifier is defined by the server.

    creationTimestamp

    string

    [Output Only] Creation timestamp in RFC3339 text format.

    name

    string

    Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035 . Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

    description

    string

    An optional description of this resource. Provide this property when you create the resource.

    poolProvisionedCapacityGb

    string ( int64 format)

    Size of the storage pool in GiB. For more information about the size limits, see https://cloud.google.com/compute/docs/disks/storage-pools .

    poolProvisionedIops

    string ( int64 format)

    Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.

    poolProvisionedThroughput

    string ( int64 format)

    Provisioned throughput of the storage pool in MiB/s. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.

    zone

    string

    [Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

    state

    enum

    [Output Only] The status of storage pool creation.

    • CREATING : Storage pool is provisioning.
      • storagePool.
    • FAILED : Storage pool creation failed.
    • READY : Storage pool is ready for use.
    • DELETING : Storage pool is deleting.
    labels

    map (key: string, value: string)

    Labels to apply to this storage pool. These can be later modified by the setLabels method.

    labelFingerprint

    string ( bytes format)

    A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet .

    To see the latest fingerprint, make a get() request to retrieve a storage pool.

    A base64-encoded string.

    resourceStatus

    object

    [Output Only] Status information for the storage pool resource.

    resourceStatus.lastResizeTimestamp

    string

    [Output Only] Timestamp of the last successful resize in RFC3339 text format.

    resourceStatus.diskCount

    string ( int64 format)

    [Output Only] Number of disks used.

    resourceStatus.poolUsedCapacityBytes

    string ( int64 format)

    [Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks.

    resourceStatus.poolUserWrittenBytes

    string ( int64 format)

    [Output Only] Amount of data written into the pool, before it is compacted.

    resourceStatus.totalProvisionedDiskCapacityGb

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned capacity (in GiB) in this storage pool. A disk's provisioned capacity is the same as its total capacity.

    resourceStatus.maxTotalProvisionedDiskCapacityGb

    string ( int64 format)

    [Output Only] Maximum allowed aggregate disk size in GiB.

    resourceStatus.poolUsedIops

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. For more information, see https://cloud.google.com/compute/docs/disks/storage-pools .

    resourceStatus.totalProvisionedDiskIops

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned IOPS.

    resourceStatus.poolUsedThroughput

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned throughput in MiB/s.

    resourceStatus.totalProvisionedDiskThroughput

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned throughput in MiB/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity.

    storagePoolType

    string

    Type of the storage pool.

    status

    object

    [Output Only] Status information for the storage pool resource.

    status.lastResizeTimestamp

    string

    [Output Only] Timestamp of the last successful resize in RFC3339 text format.

    status.diskCount

    string ( int64 format)

    [Output Only] Number of disks used.

    status.poolUsedCapacityBytes

    string ( int64 format)

    [Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks.

    status.poolUserWrittenBytes

    string ( int64 format)

    [Output Only] Amount of data written into the pool, before it is compacted.

    status.totalProvisionedDiskCapacityGb

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned capacity (in GiB) in this storage pool. A disk's provisioned capacity is the same as its total capacity.

    status.maxTotalProvisionedDiskCapacityGb

    string ( int64 format)

    [Output Only] Maximum allowed aggregate disk size in GiB.

    status.poolUsedIops

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. For more information, see https://cloud.google.com/compute/docs/disks/storage-pools .

    status.totalProvisionedDiskIops

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned IOPS.

    status.poolUsedThroughput

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned throughput in MiB/s.

    status.totalProvisionedDiskThroughput

    string ( int64 format)

    [Output Only] Sum of all the disks' provisioned throughput in MiB/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity.

    capacityProvisioningType

    enum

    Provisioning type of the byte capacity of the pool.

    performanceProvisioningType

    enum

    Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.

    Methods

    aggregatedList

    		Retrieves an aggregated list of storage pools.

    delete

    		Deletes the specified storage pool.

    get

    		Returns a specified storage pool.

    getIamPolicy

    		Gets the access control policy for a resource.

    insert

    		Creates a storage pool in the specified project using the data in the request.

    list

    		Retrieves a list of storage pools contained within the specified zone.

    listDisks

    		Lists the disks in a specified storage pool.

    setIamPolicy

    		Sets the access control policy on the specified resource.

    testIamPermissions

    		Returns permissions that a caller has on the specified resource.

    update

    		Updates the specified storagePool with the data included in the request.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: