Method: projects.locations.environments.fetchDatabaseProperties

Fetches database properties.

HTTP request

GET https://composer.googleapis.com/v1beta1/{environment=projects/*/locations/*/environments/*}:fetchDatabaseProperties

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
environment

string

Required. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Authorization requires the following IAM permission on the specified resource environment:

  • composer.environments.get

Request body

The request body must be empty.

Response body

Response for FetchDatabasePropertiesRequest.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "primaryGceZone": string,
  "secondaryGceZone": string,
  "isFailoverReplicaAvailable": boolean
}
Fields
primaryGceZone

string

The Compute Engine zone that the instance is currently serving from.
secondaryGceZone

string

The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance.
isFailoverReplicaAvailable

boolean

The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.