Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Cloud Interconnect
    • Overview
    • Terminology
    • Points of presence
    • CIC partners
    • Transceivers
    • Trunk
    • Private connection
    • Public connection
    • Routing
    • Monitoring
    • Data size and connection capacity
    • Quotas and limits
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
  • Pricing policy
  • Release notes

In this article:

  • gRPC request
  • ListPartnersRequest
  • ListPartnersResponse
  • Partner
  1. API reference
  2. gRPC
  3. Partner
  4. List

Cloud Interconnect API, gRPC: PartnerService.List

Written by
Yandex Cloud
Improved by
Tania L.
Updated at February 21, 2025
  • gRPC request
  • ListPartnersRequest
  • ListPartnersResponse
  • Partner

Retrieves the list of Partner resources in the specified folder.

gRPC requestgRPC request

rpc List (ListPartnersRequest) returns (ListPartnersResponse)

ListPartnersRequestListPartnersRequest

{
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

page_size

int64

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

page_token

string

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

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].

ListPartnersResponseListPartnersResponse

{
  "partners": [
    {
      "id": "string",
      "region_id": "string",
      "status": "Status"
    }
  ],
  "next_page_token": "string"
}

Field

Description

partners[]

Partner

List of Partner resources.

next_page_token

string

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

PartnerPartner

A Partner resource.

Field

Description

id

string

ID of the partner.

region_id

string

ID of the region that the partner belongs to.

status

enum Status

Status of the partner.

  • STATUS_UNSPECIFIED
  • UP
  • DOWN

Was the article helpful?

Previous
Get
Next
Overview
Yandex project
© 2025 Yandex.Cloud LLC