2023-09-26
▼ ▲ alloydb.projects.locations.list
Path: v1beta/{+name}/locations
Flat Path: v1beta/projects/{projectsId}/locations
HTTP Method: GET
Parameters:
name
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Type: string
filter
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).
Location: query
Type: string
pageSize
Description: The maximum number of results to return. If not set, the service selects a default.
Location: query
Type: integer
Format: int32
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists information about the supported locations for this service.
▼ ▲ alloydb.projects.locations.get
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}
HTTP Method: GET
Parameters:
name
Description: Resource name for the location.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets information about a location.
▼ ▲ alloydb.projects.locations.operations.list
Path: v1beta/{+name}/operations
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ alloydb.projects.locations.operations.get
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ alloydb.projects.locations.operations.delete
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: DELETE
Parameters:
name
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.cancel
Path: v1beta/{+name}:cancel
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method: POST
Parameters:
name
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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`.
▼ ▲ alloydb.projects.locations.clusters.list
Path: v1beta/{+parent}/clusters
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters
HTTP Method: GET
Parameters:
parent
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/-
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Clusters in a given project and location.
▼ ▲ alloydb.projects.locations.clusters.get
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
view
Description: Optional. The view of the cluster to return. Returns all default fields if not set.
Location: query
Type: string
Enum Descriptions:
Enum:
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Cluster.
▼ ▲ alloydb.projects.locations.clusters.create
Path: v1beta/{+parent}/clusters
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters
HTTP Method: POST
Parameters:
parent
Description: Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
clusterId
Description: Required. ID of the requesting object.
Location: query
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
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.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Cluster in a given project and location.
▼ ▲ alloydb.projects.locations.clusters.patch
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method: PATCH
Parameters:
name
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/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
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.
Location: query
Type: string
Format: google-fieldmask
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
validateOnly
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
Type: boolean
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.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single Cluster.
▼ ▲ alloydb.projects.locations.clusters.delete
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
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
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
force
Description: Optional. Whether to cascade delete child instances for given cluster.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Cluster.
▼ ▲ alloydb.projects.locations.clusters.promote
Path: v1beta/{+name}:promote
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:promote
HTTP Method: POST
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the Cluster.name field
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ alloydb.projects.locations.clusters.restore
Path: v1beta/{+parent}/clusters:restore
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters:restore
HTTP Method: POST
Parameters:
parent
Description: Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ alloydb.projects.locations.clusters.createsecondary
Path: v1beta/{+parent}/clusters:createsecondary
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters:createsecondary
HTTP Method: POST
Parameters:
parent
Description: Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
clusterId
Description: Required. ID of the requesting object (the secondary cluster).
Location: query
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
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.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
▼ ▲ alloydb.projects.locations.clusters.generateClientCertificate
Path: v1beta/{+parent}:generateClientCertificate
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:generateClientCertificate
HTTP Method: POST
Parameters:
parent
Description: Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}/clusters/{cluster}
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
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.instances.list
Path: v1beta/{+parent}/instances
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances
HTTP Method: GET
Parameters:
parent
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/-
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Instances in a given project and location.
▼ ▲ alloydb.projects.locations.clusters.instances.get
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Location: path
Required: Yes
Type: string
view
Description: The view of the instance to return.
Location: query
Type: string
Enum Descriptions:
Enum:
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Instance.
▼ ▲ alloydb.projects.locations.clusters.instances.create
Path: v1beta/{+parent}/instances
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances
HTTP Method: POST
Parameters:
parent
Description: Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
instanceId
Description: Required. ID of the requesting object.
Location: query
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
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.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Instance in a given project and location.
▼ ▲ alloydb.projects.locations.clusters.instances.createsecondary
Path: v1beta/{+parent}/instances:createsecondary
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances:createsecondary
HTTP Method: POST
Parameters:
parent
Description: Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
instanceId
Description: Required. ID of the requesting object.
Location: query
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
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.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new SECONDARY Instance in a given project and location.
▼ ▲ alloydb.projects.locations.clusters.instances.patch
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}
HTTP Method: PATCH
Parameters:
name
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}
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Location: path
Required: Yes
Type: string
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
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
validateOnly
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
Type: boolean
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.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single Instance.
▼ ▲ alloydb.projects.locations.clusters.instances.delete
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Location: path
Required: Yes
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
etag
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.
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
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Instance.
▼ ▲ alloydb.projects.locations.clusters.instances.failover
Path: v1beta/{+name}:failover
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:failover
HTTP Method: POST
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
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.
▼ ▲ alloydb.projects.locations.clusters.instances.injectFault
Path: v1beta/{+name}:injectFault
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:injectFault
HTTP Method: POST
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Injects fault in an instance. Imperative only.
▼ ▲ alloydb.projects.locations.clusters.instances.restart
Path: v1beta/{+name}:restart
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:restart
HTTP Method: POST
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Restart an Instance in a cluster. Imperative only.
▼ ▲ alloydb.projects.locations.clusters.instances.getConnectionInfo
Path: v1beta/{+parent}/connectionInfo
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}/connectionInfo
HTTP Method: GET
Parameters:
parent
Description: Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$
Location: path
Required: Yes
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Get instance metadata used for a connection.
▼ ▲ alloydb.projects.locations.clusters.users.list
Path: v1beta/{+parent}/users
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users
HTTP Method: GET
Parameters:
parent
Description: Required. Parent value for ListUsersRequest
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Users in a given project and location.
▼ ▲ alloydb.projects.locations.clusters.users.get
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the User.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single User.
▼ ▲ alloydb.projects.locations.clusters.users.create
Path: v1beta/{+parent}/users
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users
HTTP Method: POST
Parameters:
parent
Description: Required. Value for parent.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
userId
Description: Required. ID of the requesting object.
Location: query
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
validateOnly
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new User in a given project, location, and cluster.
▼ ▲ alloydb.projects.locations.clusters.users.patch
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
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
Type: string
Format: google-fieldmask
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
validateOnly
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Location: query
Type: boolean
allowMissing
Description: Optional. Allow missing fields in the update mask.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single User.
▼ ▲ alloydb.projects.locations.clusters.users.delete
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/users/{usersId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the resource. For the required format, see the comment on the User.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/users/[^/]+$
Location: path
Required: Yes
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
validateOnly
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single User.
▼ ▲ alloydb.projects.locations.backups.list
Path: v1beta/{+parent}/backups
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/backups
HTTP Method: GET
Parameters:
parent
Description: Required. Parent value for ListBackupsRequest
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Filtering results
Location: query
Type: string
orderBy
Description: Hint for how to order the results
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Backups in a given project and location.
▼ ▲ alloydb.projects.locations.backups.get
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the resource
Pattern: ^projects/[^/]+/locations/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Backup.
▼ ▲ alloydb.projects.locations.backups.create
Path: v1beta/{+parent}/backups
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/backups
HTTP Method: POST
Parameters:
parent
Description: Required. Value for parent.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
backupId
Description: Required. ID of the requesting object.
Location: query
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
validateOnly
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Backup in a given project and location.
▼ ▲ alloydb.projects.locations.backups.patch
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}
HTTP Method: PATCH
Parameters:
name
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}
Pattern: ^projects/[^/]+/locations/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
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.
Location: query
Type: string
Format: google-fieldmask
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
validateOnly
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Location: query
Type: boolean
allowMissing
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.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single Backup.
▼ ▲ alloydb.projects.locations.backups.delete
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/backups/{backupsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the resource. For the required format, see the comment on the Backup.name field.
Pattern: ^projects/[^/]+/locations/[^/]+/backups/[^/]+$
Location: path
Required: Yes
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
validateOnly
Description: Optional. If set, the backend validates the request, but doesn't actually execute it.
Location: query
Type: boolean
etag
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
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Backup.
▼ ▲ alloydb.projects.locations.supportedDatabaseFlags.list
Path: v1beta/{+parent}/supportedDatabaseFlags
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/supportedDatabaseFlags
HTTP Method: GET
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: A token identifying a page of results the server should return.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists SupportedDatabaseFlags for a given project and location.