Updates the parameters of a single Instance.
HTTP request
PATCH https://alloydb.googleapis.com/v1beta/{instance.name=projects/*/locations/*/clusters/*/instances/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
instance. |
Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{clusterId}/instances/{instanceId} where the cluster and instance ID segments should satisfy the regex expression |
Query parameters
Parameters | |
---|---|
update |
Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This is a comma-separated list of fully qualified names of fields. Example: |
request |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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). |
validate |
Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. |
allow |
Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and |
Request body
The request body contains an instance of Instance
.
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.