All Products
Search
Document Center

Resource Management:ListFoldersForParent

Last Updated:Jun 25, 2024

Queries the information of all subfolders of a folder.

Operation description

You can call this API operation to 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

There is currently no authorization information disclosed in the API.

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

The returned result.

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 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.
404EntityNotExists.ResourceDirectoryThe 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.
404EntityNotExists.FolderThe resource directory folder does not exist.The specified folder does not exist. Create such a folder first.

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

Change history

Change timeSummary of changesOperation
No change history