Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13101834.9 KB
projects

Updates the parameters of a single instance.

patch/v1/{+name}

Path parameters

namestring required

Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id}.

Query parameters

requestIdstring

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

updateMaskstring

Required. Mask of fields to update. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. At least one path must be supplied in this field. The fields specified in the update_mask are relative to the resource, not the full request.

Request body

labelsobject

Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.

reservedIpRangestring

Optional. Immutable. The ID of the IP address range being used by the instance's VPC network. See Configure a VPC network. If no ID is provided, all ranges are considered.

networkstring

Optional. Immutable. The name of the Compute Engine VPC network to which the instance is connected.

directoryStripeLevel'DIRECTORY_STRIPE_LEVEL_UNSPECIFIED' | 'DIRECTORY_STRIPE_LEVEL_MIN' | 'DIRECTORY_STRIPE_LEVEL_BALANCED' | 'DIRECTORY_STRIPE_LEVEL_MAX'

Optional. Immutable. Stripe level for directories. Allowed values are: * DIRECTORY_STRIPE_LEVEL_MIN: recommended when directories contain a small number of files. * DIRECTORY_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large directories. * DIRECTORY_STRIPE_LEVEL_MAX: recommended for directories with a large number of files.

namestring

Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id}.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'FAILED' | 'UPGRADING' | 'REPAIRING'

Output only. The instance state.

effectiveReservedIpRangestring

Output only. Immutable. The ID of the IP address range being used by the instance's VPC network. This field is populated by the service and contains the value currently used by the service.

accessPointsstring[]

Output only. A list of IPv4 addresses used for client side configuration.

daosVersionstring

Output only. Deprecated: The version of DAOS software running in the instance.

capacityGibstring int64

Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ...

updateTimestring google-datetime

Output only. The time when the instance was updated.

fileStripeLevel'FILE_STRIPE_LEVEL_UNSPECIFIED' | 'FILE_STRIPE_LEVEL_MIN' | 'FILE_STRIPE_LEVEL_BALANCED' | 'FILE_STRIPE_LEVEL_MAX'

Optional. Immutable. Stripe level for files. Allowed values are: * FILE_STRIPE_LEVEL_MIN: offers the best performance for small size files. * FILE_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large files. * FILE_STRIPE_LEVEL_MAX: higher throughput performance for larger files.

createTimestring google-datetime

Output only. The time when the instance was created.

descriptionstring

Optional. The description of the instance. 2048 characters or less.

deploymentType'DEPLOYMENT_TYPE_UNSPECIFIED' | 'SCRATCH' | 'PERSISTENT'

Optional. Immutable. The deployment type of the instance. Allowed values are: * SCRATCH: the instance is a scratch instance. * PERSISTENT: the instance is a persistent instance.

Response

Successful response