Метод list
Возвращает список доступных ресурсов Folder в указанном облаке.
HTTP-запрос
GET https://resource-manager.api.cloud.yandex.net/resource-manager/v1/folders
Query-параметры
Параметр | Описание |
---|---|
cloudId | Обязательное поле. Идентификатор облака, для которого запрашивается список каталогов. Чтобы получить идентификатор облака, используйте запрос list. Максимальная длина строки в символах — 50. |
pageSize | Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю Folder.name. 2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений. 3. Значение. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]$ . Максимальная длина строки в символах — 1000. |
Ответ
HTTP Code: 200 - OK
{
"folders": [
{
"id": "string",
"cloudId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string"
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
folders[] | object Ресурс Folder. Дополнительные сведения см. в разделе Каталог как ресурс Яндекс.Облака. |
folders[]. id |
string Идентификатор каталога. |
folders[]. cloudId |
string Идентификатор облака, которому принадлежит каталог. |
folders[]. createdAt |
string (date-time) Время создания. Строка в формате RFC3339. |
folders[]. name |
string Имя каталога. Имя должно быть уникальным в облаке. Длина имени должна быть от 3 до 63 символов. |
folders[]. description |
string Описание каталога. Длина описания должна быть от 0 до 256 символов. |
folders[]. labels |
object Метки ресурса в формате |
folders[]. status |
string Статус каталога.
|
nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |