Use ListFoldersForParent to query subfolders of a parent folder - Resource Management - Alibaba Cloud - Resource Management

Operation description

Note

Only the first-level subfolders of the specified folder are returned.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

resourcemanager:ListFoldersForParent

list

*Folder

acs:resourcemanager:*:{#accountId}:folder/{#ResourceDirectoryPath}

None

Request parameters

Parameter	Type	Required	Description	Example
ParentFolderId	string	No	The ID of the parent folder. If you leave this parameter empty, the first-level subfolders of the Root folder are queried.	r-b1****
QueryKeyword	string	No	The keyword used for the query, such as a folder name. Fuzzy match is supported.	rdFolder
PageNumber	integer	No	The page number to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	2
RequestId	string	The request ID.	7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
PageSize	integer	The number of entries per page.	5
PageNumber	integer	The page number.	1
Folders	object
Folder	array<object>	The folders.
	object
FolderId	string	The folder ID.	rd-evic31****
CreateTime	string	The time when the folder was created.	2015-01-23T12:33:18Z
FolderName	string	The name of the folder.	project-1

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "RequestId": "7B8A4E7D-6CFF-471D-84DF-195A7A241ECB",
  "PageSize": 5,
  "PageNumber": 1,
  "Folders": {
    "Folder": [
      {
        "FolderId": "rd-evic31****",
        "CreateTime": "2015-01-23T12:33:18Z",
        "FolderName": "project-1"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.ParentFolderId	The ParentFolderId is invalid.	The specified ID of the parent folder is invalid. The ID must either be a 6-character string that starts with r- or a 10-character string that starts with fd-. The ID can contain letters and digits.
404	EntityNotExists.ResourceDirectory	The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.	The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.
404	EntityNotExists.Folder	The resource directory folder does not exist.	The specified resource directory does not exist. We recommend that you first create a resource directory.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.