Configure data locality by using regional endpoints

This page describes the global and regional service endpoints for the Secure Source Manager control plane.

A service endpoint is a base URL that specifies the network address of an API service. The Secure Source Manager control plane has both global and regional endpoints.

  • Global endpoint: By default, Secure Source Manager sends API requests to the global endpoint, securesourcemanager.googleapis.com. Global endpoints don't guarantee that in-transit data remains in a particular location and can retrieve Secure Source Manager data from any supported region. Your data might be processed outside the region where it is stored.

  • Regional endpoint: A service endpoint that enforces regional restrictions, ensuring that in-transit data remains in a particular location. A regional endpoint only allows requests to proceed if the affected resource exists in the location specified by the endpoint. Regional endpoints use the following format:

    securesourcemanager.LOCATION.rep.googleapis.com.

    For a list of supported regions, see Locations.

Consider using regional endpoints in the following situations:

  • You are storing data in multiple locations and want to optimize latency, reliability, and availability.

  • You need to comply with data locality policies or regulations that require you to process your data in the same location where the data is stored.

The Secure Source Manager data plane only has regional endpoints, so in-transit data remains in the same region as stored data. These endpoints are in the format:

INSTANCE_ID-PROJECT_NUMBER-api.LOCATION.sourcemanager.dev

  • INSTANCE_ID is the ID of the instance.
  • PROJECT_NUMBER is the project number of the project that contains the instance.
  • LOCATION is the region where the instance is located.

Supported commands

You can use regional endpoints to run commands for instances, locations, and operations.

Specify a regional endpoint

gcloud

You can override the global endpoint with a regional endpoint for Secure Source Manager commands.

Make sure you're using the Google Cloud CLI 402.0.0 or newer.

Before using any of the command data below, make the following replacements:

  • LOCATION: the region where the instance is located.

Execute the following command:

Linux, macOS, or Cloud Shell

gcloud config set api_endpoint_overrides/securesourcemanager https://securesourcemanager.LOCATION.rep.googleapis.com

Windows (PowerShell)

gcloud config set api_endpoint_overrides/securesourcemanager https://securesourcemanager.LOCATION.rep.googleapis.com

Windows (cmd.exe)

gcloud config set api_endpoint_overrides/securesourcemanager https://securesourcemanager.LOCATION.rep.googleapis.com

REST

Use the regional endpoint in your commands instead of the global endpoint. For example, the following command list details for all repositories in a specified region for a specified instance.

Before using any of the request data, make the following replacements:

  • LOCATION: the region where the instance is located.
  • INSTANCE_ID: the name of the instance.
  • PROJECT_ID: the project ID of the project where the instance is located.

HTTP method and URL: 

GET https://securesourcemanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances?instance_id=INSTANCE_ID

To send your request, expand one of these options:

You should receive a successful status code (2xx) and an empty response.

Terraform

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands. For more information, see the Terraform provider reference documentation.

Use the API override to set the regional endpoint.

Before using any of the command data below, make the following replacements:

  • LOCATION: the region where the instance is located.
provider "google" {
  secure_source_manager_custom_endpoint = "https://securesourcemanager.LOCATION.rep.googleapis.com/v1/"
}

Client Libraries

See Secure Source Manager client libraries for instructions to install client libraries and set up authetication.

Each client library provides a way to override the default endpoint with a regional endpoint.

  • C++: Use the struct EndpointOption. The Secure Source Manager client library documentation includes an example that overrides the default endpoint with the Private Google Access endpoint, but you can use the same approach to set a regional endpoint as the default.

  • Go: Use the endpoint client option. See the Endpoint Override section of the Go client library documentation for more information and an example.

  • Python: Use the api_endpoint parameter of the ClientOptions class to override the default endpoint with a regional endpoint. See the ClientOptions documentation for more information and examples.

What's next