Method: services.projects.global.networks.getVpcServiceControls

Consumers can use this method to view whether VPC Service Controls is enabled or disabled for a connection.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the VPC Service Controls config to retrieve in the format: services/{service}/projects/{project}/global/networks/{network}. {service} is the 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.getVpcServiceControls

Request body

The request body must be empty.

Response body

Response for the get VPC Service Controls request.

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

JSON representation 
{
  "enabled": boolean
}
Fields
enabled

boolean

Output only. Indicates whether the VPC Service Controls is enabled or disabled for the connection. If the consumer called the services.enableVpcServiceControls method, then this is true. If the consumer called services.disableVpcServiceControls, then this is false. The default is false.

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.