Contact UsGet started

Resource Manager API, gRPC: CloudService.List

Written by
Updated at December 17, 2024

Retrieves the list of Cloud resources.

gRPC request

rpc List (ListCloudsRequest) returns (ListCloudsResponse)

ListCloudsRequest

{
  "page_size": "int64",
  "page_token": "string",
  "filter": "string",
  "organization_id": "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 ListCloudsResponse.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. Set page_token
to the ListCloudsResponse.next_page_token
returned by a previous list request to get the next page of results.

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

organization_id

string

ID of the organization to list clouds in.
To get the organization ID, use a yandex.cloud.organizationmanager.v1.OrganizationService.List request.

ListCloudsResponse

{
  "clouds": [
    {
      "id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "organization_id": "string",
      "labels": "map<string, string>"
    }
  ],
  "next_page_token": "string"
}

Field

Description

clouds[]

Cloud

List of Cloud 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 ListCloudsRequest.page_size, use
the next_page_token as the value
for the ListCloudsRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

Cloud

A Cloud resource. For more information, see Cloud.

Field

Description

id

string

ID of the cloud.

created_at

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the cloud. 3-63 characters long.

description

string

Description of the cloud. 0-256 characters long.

organization_id

string

ID of the organization that the cloud belongs to.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.
Previous
Get
Next
Create