Method: peerings.list

Full name: projects.locations.global.peerings.list

Lists Peerings in a given project.

HTTP request

GET https://managedidentities.googleapis.com/v1/{parent=projects/*/locations/global}/peerings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the peering location using the form: projects/{projectId}/locations/global

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

  • managedidentities.peerings.list

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the pageSize value, the response may include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.
pageToken

string

Optional. The nextPageToken value returned from a previous List request, if any.
filter

string

Optional. Filter specifying constraints of a list operation. For example, peering.authorized_network="projects/myprojectid/global/networks/mynetwork".
orderBy

string

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Request body

The request body must be empty.

Response body

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

ListPeeringsResponse is the response message for peerings.list method.

JSON representation 
{
  "peerings": [
    {
      object (Peering)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
peerings[]

object (Peering)

A list of Managed Identities Service Peerings in the project.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.
unreachable[]

string

Locations that could not be reached.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.