Method list
Retrieves the list of Folder resources in the specified cloud.
HTTP request
GET https://resource-manager.api.cloud.yandex.net/resource-manager/v1/folders
Query parameters
| Parameter | Description |
|---|---|
| cloudId | Required. ID of the cloud to list folders in. To get the cloud ID, use a list request. The maximum string length in characters is 50. |
| 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 100. |
| 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 Folder.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. |
Response
HTTP Code: 200 - OK
{
"folders": [
{
"id": "string",
"cloudId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| folders[] | object A Folder resource. For more information, see Folder. |
| folders[]. id |
string ID of the folder. |
| folders[]. cloudId |
string ID of the cloud that the folder belongs to. |
| folders[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. |
| folders[]. name |
string Name of the folder. The name is unique within the cloud. 3-63 characters long. |
| folders[]. description |
string Description of the folder. 0-256 characters long. |
| folders[]. labels |
object Resource labels as |
| folders[]. status |
string Status of the folder.
|
| 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. |