Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex Resource Manager
  • Начало работы
  • Пошаговые инструкции
    • Все инструкции
    • Облако
      • Создание облака
      • Переименование облака
      • Удаление облака
      • Отмена удаления облака
      • Настройка прав доступа
      • Получение идентификатора облака
      • Переключение на другое облако
      • Изменение организации для облака
      • Уведомления об инцидентах в облаке
    • Каталог
      • Создание каталога
      • Изменение каталога
      • Удаление каталога
      • Настройка прав доступа
      • Получение идентификатора каталога
      • Уведомления об инцидентах в каталоге
  • Концепции
    • Иерархия ресурсов Yandex Cloud
    • Оповещения от Yandex Cloud
    • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC (англ.)
      • Overview
      • CloudService
      • FolderService
      • OperationService
    • REST (англ.)
      • Overview
      • Cloud
        • Overview
        • create
        • get
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
      • Folder
        • Overview
        • create
        • delete
        • get
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
  • Вопросы и ответы
  1. Справочник API
  2. REST (англ.)
  3. Cloud
  4. list

Method list

Статья создана
Yandex Cloud
  • HTTP request
  • Query parameters
  • Response

Retrieves the list of Cloud resources.

HTTP request

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

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a 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 Page token. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. The maximum string length in characters is 1000.
filter 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]. The maximum string length in characters is 1000.
organizationId ID of the organization to list clouds in. To get the organization ID, use a list request. The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

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

A Cloud resource. For more information, see Cloud.

clouds[].
id
string

ID of the cloud.

clouds[].
createdAt
string (date-time)

Creation timestamp.

String in RFC3339 text format.

clouds[].
name
string

Name of the cloud. 3-63 characters long.

clouds[].
description
string

Description of the cloud. 0-256 characters long.

clouds[].
organizationId
string

ID of the organization that the cloud belongs to.

clouds[].
labels
object

Resource labels as key:value pairs. Maximum of 64 per resource.

nextPageToken string

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

Была ли статья полезна?

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • HTTP request
  • Query parameters
  • Response