DescribePolarFsObjects - PolarDB - Alibaba Cloud Documentation Center

Lists the files and subdirectories under a specified path.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PolarFsInstanceId	string	Yes	The PolarFs instance ID.	pfs-2ze0i74ka607*****
Path	string	Yes	The absolute path of the directory.	/test

Response elements

Element	Type	Description	Example
	object	The query was successful.
PolarFsInstanceId	string	The PolarFs instance ID.	pfs-2ze0i7*****
Items	array<object>	The list of directory entries.
	object	The directory entry object.
Path	string	The absolute path of the directory.	/test
Type	string	The file type.	directory
Capacity	string	The capacity.	100
CreationTime	integer	The creation time.	2025-03-25T09:37:10Z
Nlink	integer	The number of links.	test
Mode	string	The file system permissions.	755
Owner	string	Owner	test
LastModified	integer	The last modified time.	2025-03-25T09:37:10Z
LinkTarget	string	The real path of the symbolic link.	test
TotalRecordCount	string	The total number of records.	50
Path	string	The absolute path of the directory.	/test
PageSize	string	The number of records per page. Valid values: 30, 50, and 100. Default value: 30.	30
PageRecordCount	string	The maximum number of records that can be displayed on the current page.	30
RequestId	string	The request ID.	CDB3258F-B5DE-43C4-8935-CBA0CA******

Examples

Success response

JSON format

{
  "PolarFsInstanceId": "pfs-2ze0i7*****",
  "Items": [
    {
      "Path": "/test",
      "Type": "directory",
      "Capacity": "100",
      "CreationTime": 0,
      "Nlink": 0,
      "Mode": "755",
      "Owner": "test",
      "LastModified": 0,
      "LinkTarget": "test"
    }
  ],
  "TotalRecordCount": "50",
  "Path": "/test",
  "PageSize": "30",
  "PageRecordCount": "30",
  "RequestId": "CDB3258F-B5DE-43C4-8935-CBA0CA******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.