Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1325131186.2 KB
services

Service producers use this method to validate if the consumer provided network, project and requested range are valid. This allows them to use a fail-fast mechanism for consumer requests, and not have to wait for AddSubnetwork operation completion to determine if user request is invalid.

post/v1/{+parent}:validate

Path parameters

parentstring required

Required. This is in a form services/{service} where {service} is the name of the private access management service. For example 'service-peering.example.com'.

Request body

consumerNetworkstring

Required. The network that the consumer is using to connect with services. Must be in the form of projects/{project}/global/networks/{network} {project} is a project number, as in '12345' {network} is network name.

validateNetworkboolean

The validations will be performed in the order listed in the ValidationError enum. The first failure will return. If a validation is not requested, then the next one will be performed. SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are performed for all requests where validation is requested. NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for requests that have validate_network set to true.

checkServiceNetworkingUsePermissionboolean

Optional. The IAM permission check determines whether the consumer project has 'servicenetworking.services.use' permission or not.

Response

Successful response