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
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Resource Manager
  • Getting started
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • ListOperations
        • ListAccessBindings
        • SetAccessBindings
        • UpdateAccessBindings
  • Audit Trails events
  • Release notes
  • FAQ

In this article:

  • HTTP request
  • Query parameters
  • Response
  • Cloud
  1. API reference
  2. REST
  3. Cloud
  4. List

Resource Manager API, REST: Cloud.List

Written by
Yandex Cloud
Updated at December 17, 2024
  • HTTP request
  • Query parameters
  • Response
  • Cloud

Retrieves the list of Cloud resources.

HTTP requestHTTP request

GET https://resource-manager.api.cloud.yandex.net/resource-manager/v1/clouds

Query parametersQuery parameters

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 ListCloudsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. Set pageToken
to the ListCloudsResponse.nextPageToken
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].

organizationId

string

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

ResponseResponse

HTTP Code: 200 - OK

{
  "clouds": [
    {
      "id": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "organizationId": "string",
      "labels": "object"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

clouds[]

Cloud

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

CloudCloud

A Cloud resource. For more information, see Cloud.

Field

Description

id

string

ID of the cloud.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the cloud. 3-63 characters long.

description

string

Description of the cloud. 0-256 characters long.

organizationId

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.

Was the article helpful?

Previous
Get
Next
Create
© 2025 Direct Cursus Technology L.L.C.