All Products
Search
Document Center

Resource Management:ListFoldersForParent

Last Updated:Jun 05, 2024

Queries the information of all subfolders of a folder.

Operation description

Note You can view the information of only the first-level subfolders of a folder.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
resourcemanager:ListFoldersForParentRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParentFolderIdstringNo

The ID of the parent folder.

If you leave this parameter empty, the information of the first-level subfolders of the Root folder is queried.

r-b1****
QueryKeywordstringNo

The keyword used for the query, such as a folder name.

Fuzzy match is supported.

rdFolder
PageNumberintegerNo

The number of the page to return.

Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Valid values: 1 to 100. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

2
RequestIdstring

The ID of the request.

7B8A4E7D-6CFF-471D-84DF-195A7A241ECB
PageSizeinteger

The number of entries returned per page.

5
PageNumberinteger

The page number of the returned page.

1
Foldersobject []

The information of the folders.

FolderIdstring

The ID of the folder.

rd-evic31****
CreateTimestring

The time when the folder was created.

2015-01-23T12:33:18Z
FolderNamestring

The name of the folder.

project-1

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParameter.ParentFolderIdThe 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.
404EntityNotExists.ResourceDirectoryThe 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.
404EntityNotExists.FolderThe resource directory folder does not exist.The specified resource directory does not exist. We recommend that you first create a resource directory.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history