2026-10-19
▼ ▲ oracledatabase.projects.locations.odbNetworks.odbDnsZones.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbDnsZones
Description : Lists all the ODB DNS Zones in a given ODB Network.
Parameters :
pageSize
Description : Optional. The maximum number of items to return. If unspecified, at most 50 OdbDnsZones will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format : int32
Type : integer
Location : query
pageToken
Description : Optional. A token identifying a page of results the server should return.
Type : string
Location : query
parent
Location : path
Required : Yes
Description : Required. The parent value for the OdbDnsZone in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$
filter
Description : Optional. An expression for filtering the results of the request.
Type : string
Location : query
orderBy
Location : query
Type : string
Description : Optional. An expression for ordering the results of the request.
Path : v1/{+parent}/odbDnsZones
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
HTTP Method : GET
▼ ▲ oracledatabase.projects.locations.odbNetworks.odbDnsZones.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbDnsZones/{odbDnsZonesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbDnsZones/[^/]+$
Description : Required. The name of the OdbDnsZone in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbDnsZones/{odb_dns_zone}.
HTTP Method : GET
Description : Gets details of a single ODB DNS Zone.
Path : v1/{+name}
Parameter Order : name
▼ ▲ oracledatabase.projects.locations.odbNetworks.odbDnsZones.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbDnsZones/{odbDnsZonesId}
Description : Deletes a single ODB DNS Zone.
Parameters :
requestId
Type : string
Description : Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server 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).
Location : query
name
Location : path
Required : Yes
Type : string
Description : Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbDnsZones/{odb_dns_zone}.
Pattern : ^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbDnsZones/[^/]+$
Path : v1/{+name}
Parameter Order : name
HTTP Method : DELETE
▼ ▲ oracledatabase.projects.locations.odbNetworks.odbDnsZones.create
HTTP Method : POST
Path : v1/{+parent}/odbDnsZones
Parameters :
requestId
Description : Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server 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).
Type : string
Location : query
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$
Location : path
Required : Yes
Description : Required. The parent value for the OdbDnsZone in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.
odbDnsZoneId
Description : Required. The ID of the OdbDnsZone to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbDnsZones
Description : Creates a new ODB DNS Zone in a given ODB Network.
▼ ▲ oracledatabase.projects.locations.odbNetworks.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : PATCH
Parameters :
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : Optional. A mask specifying which fields in the OdbNetwork should be updated. A field specified in the mask is updated. If a mask isn't provided, the service treats this as an implied field mask equivalent to all fields that are populated (have a non-empty value). To clear or unset a field, the field must be explicitly specified in the `update_mask`.
requestId
Type : string
Description : Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server 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).
Location : query
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$
Description : Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}
Type : string
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}
Description : Updates the `labels` and `service_connectivity_config` of a single OdbNetwork.
▼ ▲ oracledatabase.projects.locations.databaseConnections.list
Parameters :
orderBy
Type : string
Location : query
Description : Optional. An expression for ordering the results of the request.
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent value for the DatabaseConnection in the following format: projects/{project}/locations/{location}.
Location : path
Required : Yes
filter
Type : string
Description : Optional. An expression for filtering the results of the request.
Location : query
pageSize
Format : int32
Type : integer
Description : Optional. The maximum number of items to return. If unspecified, at most 50 DatabaseConnections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the server should return.
Description : Lists DatabaseConnections in a given project and location.
HTTP Method : GET
Parameter Order : parent
Path : v1/{+parent}/databaseConnections
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/databaseConnections
▼ ▲ oracledatabase.projects.locations.databaseConnections.executeSql
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/databaseConnections/{databaseConnectionsId}:executeSql
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Location : path
Required : Yes
Description : Required. The name of the DatabaseConnection in the following format: projects/{project}/locations/{location}/databaseConnections/{database_connection}.
Pattern : ^projects/[^/]+/locations/[^/]+/databaseConnections/[^/]+$
Type : string
HTTP Method : POST
Path : v1/{+name}:executeSql
Description : Executes a SQL statement on a DatabaseConnection.
▼ ▲ oracledatabase.projects.locations.databaseConnections.get
HTTP Method : GET
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/databaseConnections/{databaseConnectionsId}
Description : Gets details of a single DatabaseConnection.
Parameter Order : name
Parameters :
name
Description : Required. The name of the DatabaseConnection in the following format: projects/{project}/locations/{location}/databaseConnections/{database_connection}.
Pattern : ^projects/[^/]+/locations/[^/]+/databaseConnections/[^/]+$
Type : string
Location : path
Required : Yes
▼ ▲ oracledatabase.projects.locations.databaseConnections.delete
Description : Deletes a single DatabaseConnection.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
requestId
Description : Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server 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).
Type : string
Location : query
name
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/databaseConnections/[^/]+$
Description : Required. The name of the resource in the following format: projects/{project}/locations/{location}/databaseConnections/{database_connection}.
Path : v1/{+name}
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/databaseConnections/{databaseConnectionsId}
▼ ▲ oracledatabase.projects.locations.databaseConnections.create
Parameters :
databaseConnectionId
Type : string
Description : Required. The ID of the DatabaseConnection to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
Location : query
parent
Description : Required. The parent value for the DatabaseConnection in the following format: projects/{project}/locations/{location}.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
requestId
Location : query
Type : string
Description : Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server 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).
Parameter Order : parent
Description : Creates a new DatabaseConnection in a given project and location.
Path : v1/{+parent}/databaseConnections
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/databaseConnections
▼ ▲ oracledatabase.projects.locations.databaseConnections.test
Path : v1/{+name}:test
Description : Tests connectivity of a DatabaseConnection.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The name of the DatabaseConnection to test. Format: projects/{project}/locations/{location}/databaseConnections/{database_connection}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/databaseConnections/[^/]+$
Location : path
Required : Yes
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/databaseConnections/{databaseConnectionsId}:test
▼ ▲ oracledatabase.projects.locations.databaseConnections.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/databaseConnections/{databaseConnectionsId}
Path : v1/{+name}
Description : Updates the parameters of a single DatabaseConnection.
Parameters :
updateMask
Format : google-fieldmask
Location : query
Description : Optional. A mask specifying which fields in the DatabaseConnection should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the DatabaseConnection are overwritten.
Type : string
requestId
Description : Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server 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).
Location : query
Type : string
name
Type : string
Description : Identifier. The resource name of the DatabaseConnection. Format: projects/{project}/locations/{location}/databaseConnections/{database_connection}
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/databaseConnections/[^/]+$