2023-09-26
▼ ▲ alloydb.projects.locations.supportedDatabaseFlags.list
Parameters:
pageToken
Location: query
Type: string
Description: A token identifying a page of results the server should return.
pageSize
Format: int32
Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
parent
Description: Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
HTTP Method: GET
Path: v1alpha/{+parent}/supportedDatabaseFlags
Description: Lists SupportedDatabaseFlags for a given project and location.
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/supportedDatabaseFlags
▼ ▲ alloydb.projects.locations.backups.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/backups
HTTP Method: GET
Parameter Order: parent
Parameters:
pageSize
Type: integer
Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Format: int32
parent
Type: string
Description: Required. Parent value for ListBackupsRequest
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
pageToken
Description: A token identifying a page of results the server should return.
Type: string
Location: query
filter
Type: string
Location: query
Description: Filtering results
orderBy
Description: Hint for how to order the results
Type: string
Location: query
Path: v1alpha/{+parent}/backups
Description: Lists Backups in a given project and location.
▼ ▲ alloydb.projects.locations.backups.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Parameters:
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: Optional. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask 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.
requestId
Description: 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).
Location: query
Type: string
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/backups/[^/]+$
Description: Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
Type: string
allowMissing
Type: boolean
Location: query
Description: Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and `update_mask` is ignored.
validateOnly
Location: query
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Type: boolean
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}
Description: Updates the parameters of a single Backup.
HTTP Method: PATCH
Parameter Order: name
▼ ▲ alloydb.projects.locations.backups.delete
Description: Deletes a single Backup.
Parameter Order: name
Parameters:
requestId
Description: 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 after 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).
Location: query
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/backups/[^/]+$
Type: string
Description: Required. Name of the resource. For the required format, see the comment on the Backup.name field.
Location: path
Required: Yes
etag
Type: string
Description: Optional. The current etag of the Backup. If an etag is provided and does not match the current etag of the Backup, deletion will be blocked and an ABORTED error will be returned.
Location: query
validateOnly
Type: boolean
Location: query
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
HTTP Method: DELETE
▼ ▲ alloydb.projects.locations.backups.create
Parameter Order: parent
HTTP Method: POST
Description: Creates a new Backup in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/backups
Parameters:
validateOnly
Location: query
Type: boolean
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
backupId
Description: Required. ID of the requesting object.
Type: string
Location: query
requestId
Type: string
Location: query
Description: 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).
parent
Description: Required. Value for parent.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/backups
▼ ▲ alloydb.projects.locations.backups.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Backup.
Parameter Order: name
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/backups/[^/]+$
Type: string
Description: Required. Name of the resource
Required: Yes
Path: v1alpha/{+name}
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}
▼ ▲ alloydb.projects.locations.clusters.get
Parameters:
view
Description: Optional. The view of the cluster to return. Returns all default fields if not set.
Enum Descriptions:
Enum:
Type: string
Location: query
name
Description: Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Parameter Order: name
Description: Gets details of a single Cluster.
HTTP Method: GET
Path: v1alpha/{+name}
▼ ▲ alloydb.projects.locations.clusters.restore
Parameters:
parent
Required: Yes
Description: Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
HTTP Method: POST
Path: v1alpha/{+parent}/clusters:restore
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters:restore
▼ ▲ alloydb.projects.locations.clusters.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Path: v1alpha/{+name}
Parameters:
etag
Description: Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.
Location: query
Type: string
validateOnly
Description: Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
Location: query
Type: boolean
requestId
Description: 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 after 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).
Location: query
Type: string
force
Type: boolean
Description: Optional. Whether to cascade delete child instances for given cluster.
Location: query
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Required: Yes
Type: string
Description: Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
Description: Deletes a single Cluster.
HTTP Method: DELETE
Parameter Order: name
▼ ▲ alloydb.projects.locations.clusters.create
Description: Creates a new Cluster in a given project and location.
HTTP Method: POST
Path: v1alpha/{+parent}/clusters
Parameters:
parent
Location: path
Type: string
Description: Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
validateOnly
Type: boolean
Description: Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
Location: query
requestId
Location: query
Description: 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).
Type: string
clusterId
Type: string
Location: query
Description: Required. ID of the requesting object.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters
▼ ▲ alloydb.projects.locations.clusters.generateClientCertificate
Parameters:
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Description: Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}/clusters/{cluster}
Type: string
Path: v1alpha/{+parent}:generateClientCertificate
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:generateClientCertificate
Description: Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.
▼ ▲ alloydb.projects.locations.clusters.createsecondary
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters:createsecondary
Description: Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Path: v1alpha/{+parent}/clusters:createsecondary
Parameters:
validateOnly
Location: query
Description: Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
Type: boolean
parent
Type: string
Description: Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
clusterId
Description: Required. ID of the requesting object (the secondary cluster).
Type: string
Location: query
requestId
Description: 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).
Location: query
Type: string
Parameter Order: parent
HTTP Method: POST
▼ ▲ alloydb.projects.locations.clusters.promote
Description: Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:promote
Parameters:
name
Type: string
Location: path
Description: Required. The name of the resource. For the required format, see the comment on the Cluster.name field
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
HTTP Method: POST
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}:promote
▼ ▲ alloydb.projects.locations.clusters.patch
Parameters:
name
Location: path
Description: Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Type: string
Required: Yes
validateOnly
Location: query
Type: boolean
Description: Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
updateMask
Format: google-fieldmask
Description: Optional. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask 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.
Type: string
Location: query
requestId
Type: string
Location: query
Description: 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).
allowMissing
Description: Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created and `update_mask` is ignored.
Type: boolean
Location: query
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
Path: v1alpha/{+name}
Description: Updates the parameters of a single Cluster.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: PATCH
▼ ▲ alloydb.projects.locations.clusters.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
pageSize
Format: int32
Location: query
Type: integer
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
orderBy
Location: query
Type: string
Description: Optional. Hint for how to order the results
pageToken
Description: A token identifying a page of results the server should return.
Type: string
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/-
filter
Location: query
Description: Optional. Filtering results
Type: string
Description: Lists Clusters in a given project and location.
Path: v1alpha/{+parent}/clusters
HTTP Method: GET
▼ ▲ alloydb.projects.locations.clusters.instances.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}
Parameters:
requestId
Location: query
Type: string
Description: 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 after 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).
validateOnly
Type: boolean
Location: query
Description: Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
name
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Location: path
Required: Yes
Type: string
etag
Type: string
Location: query
Description: Optional. The current etag of the Instance. If an etag is provided and does not match the current etag of the Instance, deletion will be blocked and an ABORTED error will be returned.
HTTP Method: DELETE
Parameter Order: name
Description: Deletes a single Instance.
▼ ▲ alloydb.projects.locations.clusters.instances.restart
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:restart
Description: Restart an Instance in a cluster. Imperative only.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Path: v1alpha/{+name}:restart
Parameter Order: name
▼ ▲ alloydb.projects.locations.clusters.instances.injectFault
Description: Injects fault in an instance. Imperative only.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1alpha/{+name}:injectFault
HTTP Method: POST
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Required: Yes
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Location: path
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:injectFault
▼ ▲ alloydb.projects.locations.clusters.instances.getConnectionInfo
Path: v1alpha/{+parent}/connectionInfo
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}/connectionInfo
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Parameters:
parent
Required: Yes
Description: Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Type: string
requestId
Description: 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 after 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).
Location: query
Type: string
Description: Get instance metadata used for a connection.
▼ ▲ alloydb.projects.locations.clusters.instances.createsecondary
Description: Creates a new SECONDARY Instance in a given project and location.
Path: v1alpha/{+parent}/instances:createsecondary
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
instanceId
Description: Required. ID of the requesting object.
Type: string
Location: query
requestId
Type: string
Location: query
Description: 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).
validateOnly
Description: Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
Type: boolean
Location: query
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Required: Yes
Type: string
Description: Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances:createsecondary
▼ ▲ alloydb.projects.locations.clusters.instances.create
Description: Creates a new Instance in a given project and location.
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/instances
Parameters:
validateOnly
Location: query
Type: boolean
Description: Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
instanceId
Location: query
Type: string
Description: Required. ID of the requesting object.
parent
Location: path
Required: Yes
Description: Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Type: string
requestId
Description: 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).
Location: query
Type: string
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances
▼ ▲ alloydb.projects.locations.clusters.instances.failover
HTTP Method: POST
Path: v1alpha/{+name}:failover
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
Parameter Order: name
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Type: string
Required: Yes
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:failover
▼ ▲ alloydb.projects.locations.clusters.instances.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances
Parameter Order: parent
Path: v1alpha/{+parent}/instances
Description: Lists Instances in a given project and location.
HTTP Method: GET
Parameters:
filter
Type: string
Description: Optional. Filtering results
Location: query
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Type: string
Description: Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: * projects/{project}/locations/-/clusters/- * projects/{project}/locations/{region}/clusters/-
pageToken
Location: query
Type: string
Description: A token identifying a page of results the server should return.
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type: integer
Format: int32
Location: query
orderBy
Type: string
Location: query
Description: Optional. Hint for how to order the results
▼ ▲ alloydb.projects.locations.clusters.instances.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single Instance.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}
Parameters:
updateMask
Description: Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the update_mask 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.
Location: query
Type: string
Format: google-fieldmask
allowMissing
Description: Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and `update_mask` is ignored.
Type: boolean
Location: query
validateOnly
Type: boolean
Description: Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
Location: query
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Description: Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}
Type: string
requestId
Location: query
Description: 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).
Type: string
HTTP Method: PATCH
Path: v1alpha/{+name}
Parameter Order: name
▼ ▲ alloydb.projects.locations.clusters.instances.get
Parameter Order: name
Path: v1alpha/{+name}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
view
Enum:
Description: The view of the instance to return.
Location: query
Type: string
Enum Descriptions:
name
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Type: string
Location: path
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Required: Yes
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}
Description: Gets details of a single Instance.
▼ ▲ alloydb.projects.locations.clusters.users.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}
Parameters:
validateOnly
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Type: boolean
Location: query
requestId
Location: query
Description: 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 after 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).
Type: string
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/users/[^/]+$
Required: Yes
Description: Required. The name of the resource. For the required format, see the comment on the User.name field.
Parameter Order: name
Path: v1alpha/{+name}
Description: Deletes a single User.
▼ ▲ alloydb.projects.locations.clusters.users.create
Parameters:
validateOnly
Type: boolean
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Location: query
requestId
Location: query
Type: string
Description: 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).
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Type: string
Description: Required. Value for parent.
userId
Description: Required. ID of the requesting object.
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users
Description: Creates a new User in a given project, location, and cluster.
Path: v1alpha/{+parent}/users
▼ ▲ alloydb.projects.locations.clusters.users.patch
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
requestId
Location: query
Description: 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).
Type: string
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/users/[^/]+$
Description: Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.
Location: path
Type: string
allowMissing
Description: Optional. Allow missing fields in the update mask.
Type: boolean
Location: query
updateMask
Type: string
Description: Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask 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.
Location: query
Format: google-fieldmask
validateOnly
Location: query
Type: boolean
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}
HTTP Method: PATCH
Parameter Order: name
Description: Updates the parameters of a single User.
▼ ▲ alloydb.projects.locations.clusters.users.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. The name of the resource. For the required format, see the comment on the User.name field.
Parameter Order: name
Description: Gets details of a single User.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}
HTTP Method: GET
Path: v1alpha/{+name}
▼ ▲ alloydb.projects.locations.clusters.users.list
Parameter Order: parent
Parameters:
pageToken
Location: query
Type: string
Description: Optional. A token identifying a page of results the server should return.
filter
Type: string
Location: query
Description: Optional. Filtering results
parent
Required: Yes
Description: Required. Parent value for ListUsersRequest
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
orderBy
Location: query
Type: string
Description: Optional. Hint for how to order the results
pageSize
Format: int32
Location: query
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type: integer
Description: Lists Users in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users
HTTP Method: GET
Path: v1alpha/{+parent}/users
▼ ▲ alloydb.projects.locations.operations.delete
Path: v1alpha/{+name}
HTTP Method: DELETE
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be deleted.
Type: string
Required: Yes
Location: path
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ alloydb.projects.locations.operations.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}/operations
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method: GET
Parameters:
filter
Type: string
Description: The standard list filter.
Location: query
pageToken
Location: query
Description: The standard list page token.
Type: string
pageSize
Format: int32
Description: The standard list page size.
Location: query
Type: integer
name
Required: Yes
Type: string
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
▼ ▲ alloydb.projects.locations.operations.get
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Description: The name of the operation resource.
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1alpha/{+name}
Parameter Order: name
▼ ▲ alloydb.projects.locations.operations.cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
name
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Type: string
Required: Yes
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Path: v1alpha/{+name}:cancel
▼ ▲ alloydb.projects.locations.get
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Resource name for the location.
Required: Yes
Location: path
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}
HTTP Method: GET
Description: Gets information about a location.
Parameter Order: name
Path: v1alpha/{+name}
▼ ▲ alloydb.projects.locations.list
Description: Lists information about the supported locations for this service.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}/locations
Flat Path: v1alpha/projects/{projectsId}/locations
Parameters:
filter
Location: query
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Type: string
pageSize
Type: integer
Description: The maximum number of results to return. If not set, the service selects a default.
Format: int32
Location: query
name
Location: path
Type: string
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
Required: Yes
pageToken
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location: query
Type: string
Parameter Order: name
HTTP Method: GET