List Resource Directory Subfolders via ListFoldersForParent API - Resource Management - Alibaba Cloud - Resource Management

Queries the list of subfolders of a specified folder.

Operation description

You can only view the subfolders at the next level under the specified folder. You cannot view folders at deeper levels.

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 this parameter is left empty, the subfolders at the next level under the Root folder are queried.	r-b1****
QueryKeyword	string	No	The query keyword, such as the folder name. Fuzzy match is supported.	rdFolder
PageNumber	integer	No	The page number. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
Tag	array<object>	No	Filters by tag.
	object	No	The list of tags used for filtering.
Key	string	No	The tag key.	k1
Value	string	No	The tag value.	v1

Response elements

Element	Type	Description	Example
	object	The response parameters.
Folders	object
Folder	array<object>	The list of folders.
	array<object>	The list of folders.
CreateTime	string	The time when the folder was created. The time is displayed in ISO 8601 format, in UTC.	2015-01-23T12:33:18Z
FolderId	string	The ID of the folder.	rd-evic31****
FolderName	string	The name of the folder.	project-1
Tags	object
Tag	array<object>	The tags of the folder.
	object	The tags of the folder.
Key	string	The tag key.	k1
Value	string	The tag value.	v1
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	5
RequestId	string	The request ID.	7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
TotalCount	integer	The total number of entries.	2

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.ParentFolderId	The ParentFolderId is invalid.	The value of the ParentFolderId parameter is invalid. The value must start with r- followed by 6 characters or start with fd- followed by 10 characters. Valid characters include 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 account is not used to enable a resource directory. Use the account to enable a resource directory first.
404	EntityNotExists.Folder	The resource directory folder does not exist.	The specified folder does not exist. Create such a folder first.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.