Cloud Interconnect API, REST: Partner.List

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListPartnersResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests. Default value: 100.

The maximum value is 1000.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListPartnersResponse.nextPageToken returned by a previous list request.

The maximum string length in characters is 100.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

1. The field name. Currently you can use filtering only on [Subnet.name] field.
2. An = operator.
3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

The maximum string length in characters is 1000.

Field

Description

partners[]

Partner

List of Partner resources.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListPartnersRequest.pageSize, use
the nextPageToken as the value
for the ListPartnersRequest.pageToken query parameter
in the next list request. Subsequent list requests will have their own
nextPageToken to continue paging through the results.

Field

Description

id

string

ID of the partner.

name

string

Name of the partner.

url

string

Link to info about the partner.

popIds[]

string

List of pointOfPresence IDs that the partner is connected to.

status

enum (Status)

Status of the partner.

• UP: Partner is up and operational.
• DOWN: Partner is down and not operational.