REST Resource: projects.locations.global.connectivityTests

string

Identifier. Unique name of the resource using the form: projects/{projectId}/locations/global/connectivityTests/{testId}

string

The user-supplied description of the Connectivity Test. Maximum of 512 characters.

object (Endpoint)

Required. Source specification of the Connectivity Test.

You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location.

Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information.

If the source of the test is within an on-premises network, then you must provide the destination VPC network.

If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network.

A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test.

object (Endpoint)

Required. Destination specification of the Connectivity Test.

You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location.

Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information.

If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface.

A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test.

string

IP Protocol of the test. When not provided, "TCP" is assumed.

string

Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

string

Output only. The display name of a Connectivity Test.

map (key: string, value: string)

Resource labels to represent user-provided metadata.

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

string (Timestamp format)

Output only. The time the test was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Output only. The time the test's configuration was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

object (ReachabilityDetails)

Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

object (ProbingDetails)

Output only. The probing details of this test from the latest run, present for applicable tests only. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

boolean

Whether run analysis for the return path from destination to source. Default value is false.

object (ReachabilityDetails)

Output only. The reachability details of this test from the latest run for the return path. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

boolean

Whether the test should skip firewall checking. If not provided, we assume false.

string

The IP address of the endpoint, which can be an external or internal IP.

integer

The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.

string

A Compute Engine instance URI.

string

A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules are also used for protocol forwarding, Private Service Connect and other network services to provide forwarding information in the control plane. Format: projects/{project}/global/forwardingRules/{id} or projects/{project}/regions/{region}/forwardingRules/{id}

string

A cluster URI for Google Kubernetes Engine cluster control plane.

string

DNS endpoint of Google Kubernetes Engine cluster control plane. Requires gkeMasterCluster to be set, can't be used simultaneoulsly with ipAddress or network. Applicable only to destination endpoint.

string

A Cloud SQL instance URI.

string

A Redis Instance URI.

string

A Redis Cluster URI.

object (CloudFunctionEndpoint)

A Cloud Function.

object (AppEngineVersionEndpoint)

An App Engine service version.

object (CloudRunRevisionEndpoint)

A Cloud Run revision

string

A Compute Engine network URI.

enum (NetworkType)

Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.

string

Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a Google Cloud project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

enum (ForwardingRuleTarget)

Output only. Specifies the type of the target of the forwarding rule.

string

Output only. ID of the load balancer the forwarding rule points to. Empty for forwarding rules not related to load balancers.

enum (LoadBalancerType)

Output only. Type of the load balancer the forwarding rule points to.

string

A Cloud Function name.

string

An App Engine service version name.

string

A Cloud Run revision URI. The format is: projects/{project}/locations/{location}/revisions/{revision}

enum (Result)

The overall result of the test's configuration analysis.

string (Timestamp format)

The time of the configuration analysis.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

object (Status)

The details of a failure or a cancellation of reachability analysis.

object (Trace)

Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends.

object (EndpointInfo)

Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpointInfo may be different between traces.

object (Step)

A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted).

The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them.

integer

ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace.

string

Source IP address.

string

Destination IP address.

string

IP protocol in string format, for example: "TCP", "UDP", "ICMP".

integer

Source port. Only valid when protocol is TCP or UDP.

integer

Destination port. Only valid when protocol is TCP or UDP.

string

URI of the network where this packet originates from.

string

URI of the network where this packet is sent to.

string

URI of the source telemetry agent this packet originates from.

string

A description of the step. Usually this is a summary of the state.

enum (State)

Each step is in one of the pre-defined states.

boolean

This is a step that leads to the final state Drop.

string

Project ID that contains the configuration this step is validating.

object (InstanceInfo)

Display information of a Compute Engine instance.

object (FirewallInfo)

Display information of a Compute Engine firewall rule.

object (RouteInfo)

Display information of a Compute Engine route.

object (EndpointInfo)

Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy.

object (GoogleServiceInfo)

Display information of a Google service

object (ForwardingRuleInfo)

Display information of a Compute Engine forwarding rule.

object (VpnGatewayInfo)

Display information of a Compute Engine VPN gateway.

object (VpnTunnelInfo)

Display information of a Compute Engine VPN tunnel.

object (VpcConnectorInfo)

Display information of a VPC connector.

object (DeliverInfo)

Display information of the final state "deliver" and reason.

object (ForwardInfo)

Display information of the final state "forward" and reason.

object (AbortInfo)

Display information of the final state "abort" and reason.

object (DropInfo)

Display information of the final state "drop" and reason.

object (LoadBalancerInfo)

Display information of the load balancers. Deprecated in favor of the loadBalancerBackendInfo field, not used in new tests.

object (NetworkInfo)

Display information of a Google Cloud network.

object (GKEMasterInfo)

Display information of a Google Kubernetes Engine cluster master.

object (CloudSQLInstanceInfo)

Display information of a Cloud SQL instance.

object (RedisInstanceInfo)

Display information of a Redis Instance.

object (RedisClusterInfo)

Display information of a Redis Cluster.

object (CloudFunctionInfo)

Display information of a Cloud Function.

object (AppEngineVersionInfo)

Display information of an App Engine service version.

object (CloudRunRevisionInfo)

Display information of a Cloud Run revision.

object (NatInfo)

Display information of a NAT.

object (ProxyConnectionInfo)

Display information of a ProxyConnection.

object (LoadBalancerBackendInfo)

Display information of a specific load balancer backend.

object (StorageBucketInfo)

Display information of a Storage Bucket. Used only for return traces.

object (ServerlessNegInfo)

Display information of a Serverless network endpoint group backend. Used only for return traces.

string

Name of a Compute Engine instance.

string

URI of a Compute Engine instance.

string

Name of the network interface of a Compute Engine instance.

string

URI of a Compute Engine network.

string

Internal IP address of the network interface.

string

External IP address of the network interface.

string

Network tags configured on the instance.

string

Service account authorized for the instance.

string

URI of the PSC network attachment the NIC is attached to (if relevant).

string

The display name of the firewall rule. This field might be empty for firewall policy rules.

string

The URI of the firewall rule. This field is not applicable to implied VPC firewall rules.

string

Possible values: INGRESS, EGRESS

string

Possible values: ALLOW, DENY, APPLY_SECURITY_PROFILE_GROUP

integer

The priority of the firewall rule.

string

The URI of the VPC network that the firewall rule is associated with. This field is not applicable to hierarchical firewall policy rules.

string

The target tags defined by the VPC firewall rule. This field is not applicable to firewall policy rules.

string

The target service accounts specified by the firewall rule.

string

The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules.

string

The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules.

enum (FirewallRuleType)

The firewall rule's type.

enum (RouteType)

Type of route.

enum (NextHopType)

Type of next hop.

enum (RouteScope)

Indicates where route is applicable. Deprecated, routes with NCC_HUB scope are not included in the trace in new tests.

string

Name of a route.

string

URI of a route. SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only.

string

Region of the route. DYNAMIC, PEERING_DYNAMIC, POLICY_BASED and ADVERTISED routes only. If set for POLICY_BASED route, this is a region of VLAN attachments for Cloud Interconnect the route applies to.

string

Destination IP range of the route.

string

String type of the next hop of the route (for example, "VPN tunnel"). Deprecated in favor of the nextHopType and nextHopUri fields, not used in new tests.

string

URI of a VPC network where route is located.

integer

Priority of the route.

string

Instance tags of the route.

string

Source IP address range of the route. POLICY_BASED routes only.

string

Destination port ranges of the route. POLICY_BASED routes only.

string

Source port ranges of the route. POLICY_BASED routes only.

string

Protocols of the route. POLICY_BASED routes only.

string

URI of the next hop resource.

string

URI of a VPC network where the next hop resource is located.

string

For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route.

string

For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route.

string

For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table.

string

URI of the NCC Hub the route is advertised by. PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only.

string

URI of the destination NCC Spoke. PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only.

string

For ADVERTISED dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.

string

For ADVERTISED routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network. Deprecated in favor of the nextHopUri field, not used in new tests.

string

Source IP address.

enum (GoogleServiceType)

Recognized type of a Google Service.

string

Name of the forwarding rule.

string

URI of the forwarding rule.

string

Protocol defined in the forwarding rule that matches the packet.

string

Port range defined in the forwarding rule that matches the packet.

string

VIP of the forwarding rule.

string

Target type of the forwarding rule.

string

Network URI.

string

Region of the forwarding rule. Set only for regional forwarding rules.

string

Name of the load balancer the forwarding rule belongs to. Empty for forwarding rules not related to load balancers (like PSC forwarding rules).

string

URI of the PSC service attachment this forwarding rule targets (if applicable).

string

PSC Google API target this forwarding rule targets (if applicable).

string

Name of a VPN gateway.

string

URI of a VPN gateway.

string

URI of a Compute Engine network where the VPN gateway is configured.

string

IP address of the VPN gateway.

string

A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed.

string

Name of a Google Cloud region where this VPN gateway is configured.

string

Name of a VPN tunnel.

string

URI of a VPN tunnel.

string

URI of the VPN gateway at local end of the tunnel.

string

URI of a VPN gateway at remote end of the tunnel.

string

Remote VPN gateway's IP address.

string

Local VPN gateway's IP address.

string

URI of a Compute Engine network where the VPN tunnel is configured.

string

Name of a Google Cloud region where this VPN tunnel is configured.

enum (RoutingType)

Type of the routing policy.

string

Name of a VPC connector.

string

URI of a VPC connector.

string

Location in which the VPC connector is deployed.

enum (Target)

Target type where the packet is delivered to.

string

URI of the resource that the packet is delivered to.

string

IP address of the target (if applicable).

string

Name of the Cloud Storage Bucket the packet is delivered to (if applicable).

string

PSC Google API target the packet is delivered to (if applicable).

enum (Target)

Target type where this packet is forwarded to.

string

URI of the resource that the packet is forwarded to.

string

IP address of the target (if applicable).

enum (Cause)

Causes that the analysis is aborted.

string

URI of the resource that caused the abort.

string

IP address that caused the abort.

string

List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause.

enum (Cause)

Cause that the packet is dropped.

string

URI of the resource that caused the drop.

string

Source IP address of the dropped packet (if relevant).

string

Destination IP address of the dropped packet (if relevant).

string

Region of the dropped packet (if relevant).

enum (LoadBalancerType)

Type of the load balancer.

string

URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks.

object (LoadBalancerBackend)

Information for the loadbalancer backends.

enum (BackendType)

Type of load balancer's backend configuration.

string

Backend configuration URI.

string

Name of a Compute Engine instance or network endpoint.

string

URI of a Compute Engine instance or network endpoint.

enum (HealthCheckFirewallState)

State of the health check firewall configuration.

string

A list of firewall rule URIs allowing probes from health check IP ranges.

string

A list of firewall rule URIs blocking probes from health check IP ranges.

string

Name of a Compute Engine network.

string

URI of a Compute Engine network.

string

URI of the subnet matching the source IP address of the test.

string

The IP range of the subnet matching the source IP address of the test.

string

The region of the subnet matching the source IP address of the test.

string

URI of a GKE cluster.

string

URI of a GKE cluster network.

string

Internal IP address of a GKE cluster control plane.

string

External IP address of a GKE cluster control plane.

string

DNS endpoint of a GKE cluster control plane.

string

Name of a Cloud SQL instance.

string

URI of a Cloud SQL instance.

string

URI of a Cloud SQL instance network or empty string if the instance does not have one.

string

Internal IP address of a Cloud SQL instance.

string

External IP address of a Cloud SQL instance.

string

Region in which the Cloud SQL instance is running.

string

Name of a Cloud Redis Instance.

string

URI of a Cloud Redis Instance.

string

URI of a Cloud Redis Instance network.

string

Primary endpoint IP address of a Cloud Redis Instance.

string

Read endpoint IP address of a Cloud Redis Instance (if applicable).

string

Region in which the Cloud Redis Instance is defined.

string

Name of a Redis Cluster.

string

URI of a Redis Cluster in format "projects/{projectId}/locations/{location}/clusters/{cluster_id}"

string

URI of a Redis Cluster network in format "projects/{projectId}/global/networks/{network_id}".

string

Discovery endpoint IP address of a Redis Cluster.

string

Secondary endpoint IP address of a Redis Cluster.

string

Name of the region in which the Redis Cluster is defined. For example, "us-central1".

string

Name of a Cloud Function.

string

URI of a Cloud Function.

string

Location in which the Cloud Function is deployed.

string (int64 format)

Latest successfully deployed version id of the Cloud Function.

string

Name of an App Engine version.

string

URI of an App Engine version.

string

Runtime of the App Engine version.

string

App Engine execution environment for a version.

string

Name of a Cloud Run revision.

string

URI of a Cloud Run revision.

string

Location in which this revision is deployed.

string

URI of Cloud Run service this revision belongs to.

enum (Type)

Type of NAT.

string

IP protocol in string format, for example: "TCP", "UDP", "ICMP".

string

URI of the network where NAT translation takes place.

string

Source IP address before NAT translation.

string

Source IP address after NAT translation.

string

Destination IP address before NAT translation.

string

Destination IP address after NAT translation.

integer

Source port before NAT translation. Only valid when protocol is TCP or UDP.

integer

Source port after NAT translation. Only valid when protocol is TCP or UDP.

integer

Destination port before NAT translation. Only valid when protocol is TCP or UDP.

integer

Destination port after NAT translation. Only valid when protocol is TCP or UDP.

string

Uri of the Cloud Router. Only valid when type is CLOUD_NAT.

string

The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT.

string

IP protocol in string format, for example: "TCP", "UDP", "ICMP".

string

Source IP address of an original connection.

string

Source IP address of a new connection.

string

Destination IP address of an original connection

string

Destination IP address of a new connection.

integer

Source port of an original connection. Only valid when protocol is TCP or UDP.

integer

Source port of a new connection. Only valid when protocol is TCP or UDP.

integer

Destination port of an original connection. Only valid when protocol is TCP or UDP.

integer

Destination port of a new connection. Only valid when protocol is TCP or UDP.

string

Uri of proxy subnet.

string

URI of the network where connection is proxied.

string

Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends.

string

URI of the backend instance (if applicable). Populated for instance group backends, and zonal NEG backends.

string

URI of the backend service this backend belongs to (if applicable).

string

URI of the instance group this backend belongs to (if applicable).

string

URI of the network endpoint group this backend belongs to (if applicable).

string

URI of the backend bucket this backend targets (if applicable).

string

URI of the PSC service attachment this PSC NEG backend targets (if applicable).

string

PSC Google API target this PSC NEG backend targets (if applicable).

string

URI of the health check attached to this backend (if applicable).

enum (HealthCheckFirewallsConfigState)

Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules

string

Cloud Storage Bucket name.

string

URI of the serverless network endpoint group.

enum (ProbingResult)

The overall result of active probing.

string (Timestamp format)

The time that reachability was assessed through active probing.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

object (Status)

Details about an internal failure or the cancellation of active probing.

enum (ProbingAbortCause)

The reason probing was aborted.

integer

Number of probes sent.

integer

Number of probes that reached the destination.

object (EndpointInfo)

The source and destination endpoints derived from the test input and used for active probing.

object (LatencyDistribution)

Latency as measured by active probing in one direction: from the source to the destination endpoint.

object (EdgeLocation)

The EdgeLocation from which a packet destined for/originating from the internet will egress/ingress the Google network. This will only be populated for a connectivity test which has an internet destination/source address. The absence of this field must not be used as an indication that the destination/source is part of the Google network.

object (LatencyPercentile)

Representative latency percentiles.

integer

Percentage of samples this data point applies to.

string (int64 format)

percent-th percentile of latency observed, in microseconds. Fraction of percent/100 of samples have latency lower or equal to the value of this field.

string

Name of the metropolitan area.