REST Resource: projects.locations.endpoints

Resource: Endpoint

Endpoint resource.

JSON representation 
{
  "name": string,
  "displayName": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "endpointType": enum (EndpointType),
  "targetInstances": [
    string
  ],
  "effectiveTargetInstances": [
    string
  ],
  "dnsConfig": {
    object (DNSConfig)
  },
  "state": enum (State),
  "etag": string,
  "reconciling": boolean,
  "annotations": {
    string: string,
    ...
  }
}
Fields
name

string

Output only. Identifier. The name of the endpoint resource with the format: * projects/{project}/locations/{region}/endpoints/{endpointId} where the endpoint ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project}/locations/{region}
displayName

string

User-settable and human-readable display name for the Endpoint.
uid

string

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
createTime

string (Timestamp format)

Output only. Create time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Update time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

Output only. Delete time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endpointType

enum (EndpointType)

The type of the endpoint, either write or read.
targetInstances[]

string

The names of the target instances for the endpoint, should be of format projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effectiveTargetInstances field.
effectiveTargetInstances[]

string

Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{projectNumber}/locations/{location}/clusters/{clusterId}/instances/{instanceId} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effectiveTargetInstances are the same as targetInstances. Note that after a cross-region failover operation, the effectiveTargetInstances can be stale until the operation to update the endpoint is complete.
dnsConfig

object (DNSConfig)

Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
state

enum (State)

Output only. The state of the endpoint.
etag

string

For Resource freshness validation (https://google.aip.dev/154)
reconciling

boolean

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
annotations

map (key: string, value: string)

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

EndpointType

The type of the endpoint

Enums
ENDPOINT_TYPE_UNSPECIFIED Unspecified endpoint type
WRITE_ENDPOINT Write endpoint, which is associated with a primary instance.
READ_ENDPOINT Read endpoint, which is associated with read or secondary instances.

DNSConfig

The DNS config for the endpoint, containing the DNS record name, type and targets.

JSON representation 
{
  "dnsName": string,
  "dnsRecordType": string
}
Fields
dnsName

string

The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
dnsRecordType

string

The type of the DNS record, e.g., "A", "AAAA", "CNAME".

State

Endpoint State

Enums
STATE_UNSPECIFIED Unspecified state
READY The endpoint is active and ready to use.
CREATING The endpoint is being created.
UPDATING The endpoint is being updated.
DELETING The endpoint is being deleted.

Methods

create

 Creates a new Endpoint in a given project and location.

delete

 Deletes a single Endpoint.

get

 Gets details of a single Endpoint.

list

 Lists Endpoints in a given project and location.

patch

 Updates the parameters of a single Endpoint.