Method: services.projects.global.networks.get

Stay organized with collections Save and categorize content based on your preferences.

Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.

HTTP request

GET https://servicenetworking.googleapis.com/v1/{name=services/*/projects/*/global/networks/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the consumer config to retrieve in the format: services/{service}/projects/{project}/global/networks/{network}. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is servicenetworking.googleapis.com. {project} is a project number e.g. 12345 that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network.

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

  • servicenetworking.services.getConsumerConfig

Query parameters

Parameters
includeUsedIpRanges

boolean

Optional. When true, include the used IP ranges as part of the networks.get output. This includes routes created inside the service networking network, consumer network, peers of the consumer network, and reserved ranges inside the service networking network. By default, this is false

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ConsumerConfig.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.