Service Networking API (servicenetworking:v1)

2023-07-28

3 new methods | 3 removed methods

Additions

    Methods
  • servicenetworking.services.dnsZone.get

      Flat Path: v1/services/{servicesId}/dnsZone:get

      Description: Service producers can use this method to retrieve a DNS zone in the shared producer host project and the matching peering zones in consumer project

      Parameters:

        name

          Required: Yes

          Description: Required. The network that the consumer is using to connect with services. Must be in the form of services/{service}/projects/{project}/global/networks/{network}/zones/{zoneName} Where {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this {project} is the project number, as in '12345' {network} is the network name. {zoneName} is the DNS zone name

          Type: string

          Pattern: ^services/[^/]+$

          Location: path

      Scopes:

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

      HTTP Method: GET

      Path: v1/{+name}/dnsZone:get

  • servicenetworking.services.dnsRecordSets.list

      Path: v1/{+parent}/dnsRecordSets:list

      Parameter Order: parent

      Parameters:

        parent

          Type: string

          Location: path

          Pattern: ^services/[^/]+$

          Required: Yes

          Description: Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.

        consumerNetwork

          Location: query

          Description: 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 the project number, as in '12345' {network} is the network name.

          Type: string

        zone

          Location: query

          Type: string

          Description: Required. The name of the private DNS zone in the shared producer host project from which the record set will be removed.

      Description: Producers can use this method to retrieve a list of available DNS RecordSets available inside the private zone on the tenant host project accessible from their network.

      HTTP Method: GET

      Flat Path: v1/services/{servicesId}/dnsRecordSets:list

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/service.management
  • servicenetworking.services.dnsRecordSets.get

      Parameter Order: parent

      Scopes:

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

      Path: v1/{+parent}/dnsRecordSets:get

      Flat Path: v1/services/{servicesId}/dnsRecordSets:get

      Parameters:

        type

          Type: string

          Location: query

          Description: Required. RecordSet Type eg. type='A'. See the list of [Supported DNS Types](https://dns.corp.google.com/docs/overview).

        parent

          Type: string

          Location: path

          Description: Required. Parent resource identifying the connection which owns this collection of DNS zones in the format services/{service}.

          Required: Yes

          Pattern: ^services/[^/]+$

        domain

          Type: string

          Description: Required. The domain name of the zone containing the recordset.

          Location: query

        consumerNetwork

          Location: query

          Description: Required. The consumer network containing the record set. Must be in the form of projects/{project}/global/networks/{network}

          Type: string

        zone

          Type: string

          Description: Required. The name of the zone containing the record set.

          Location: query

      Description: Producers can use this method to retrieve information about the DNS record set added to the private zone inside the shared tenant host project associated with a consumer network.

Deletions

    Methods
  • servicenetworking.services.dnsZones.dnsZone.get

      Parameters:

        name

          Description: Required. The network that the consumer is using to connect with services. Must be in the form of services/{service}/projects/{project}/global/networks/{network}/zones/{zoneName} Where {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this {project} is the project number, as in '12345' {network} is the network name. {zoneName} is the DNS zone name

          Required: Yes

          Type: string

          Location: path

          Pattern: ^services/[^/]+/dnsZones/[^/]+$

      HTTP Method: GET

      Path: v1/{+name}/dnsZone:get

      Description: Service producers can use this method to retrieve a DNS zone in the shared producer host project and the matching peering zones in consumer project

      Parameter Order: name

      Flat Path: v1/services/{servicesId}/dnsZones/{dnsZonesId}/dnsZone:get

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/service.management
  • servicenetworking.services.dnsRecordSet.get

      Parameters:

        parent

          Required: Yes

          Pattern: ^services/[^/]+$

          Type: string

          Description: Required. Parent resource identifying the connection which owns this collection of DNS zones in the format services/{service}.

          Location: path

        domain

          Location: query

          Type: string

          Description: Required. The domain name of the zone containing the recordset.

        type

          Location: query

          Type: string

          Description: Required. RecordSet Type eg. type='A'. See the list of [Supported DNS Types](https://dns.corp.google.com/docs/overview).

        consumerNetwork

          Type: string

          Location: query

          Description: Required. The consumer network containing the record set. Must be in the form of projects/{project}/global/networks/{network}

        zone

          Location: query

          Type: string

          Description: Required. The name of the zone containing the record set.

      Path: v1/{+parent}/dnsRecordSet:get

      Description: Producers can use this method to retrieve information about the DNS record set added to the private zone inside the shared tenant host project associated with a consumer network.

      Flat Path: v1/services/{servicesId}/dnsRecordSet:get

      HTTP Method: GET

      Parameter Order: parent

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/service.management
  • servicenetworking.services.projects.global.networks.zones.dnsRecordSet.lIST

      Parameter Order: parent

      Description: Producers can use this method to retrieve a list of available DNS RecordSets available inside the private zone on the tenant host project accessible from their network.

      Scopes:

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

      Flat Path: v1/services/{servicesId}/projects/{projectsId}/global/networks/{networksId}/zones/{zonesId}/dnsRecordSet:LIST

      Parameters:

        consumerNetwork

          Location: query

          Type: string

          Description: 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 the project number, as in '12345' {network} is the network name.

        parent

          Required: Yes

          Pattern: ^services/[^/]+/projects/[^/]+/global/networks/[^/]+/zones/[^/]+$

          Type: string

          Description: Required. The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.

          Location: path

        zone

          Description: Required. The name of the private DNS zone in the shared producer host project from which the record set will be removed.

          Location: query

          Type: string

      Path: v1/{+parent}/dnsRecordSet:LIST