GetFolder API Reference for Folder Metadata - Resource Management - Alibaba Cloud - Resource Management

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:GetFolder

get

*Folder

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

None

Request parameters

Parameter	Type	Required	Description	Example
FolderId	string	Yes	The folder ID.	fd-Jyl5U7****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C2CBCA30-C8DD-423E-B4AD-4FB694C9180C
Folder	object	The folder information.
FolderId	string	The folder ID.	fd-Jyl5U7****
CreateTime	string	The time when the folder was created. The time is displayed in ISO 8601 format, in UTC.	2021-06-15T06:39:08.521Z
ParentFolderId	string	The ID of the parent folder.	r-Wm****
FolderName	string	The name of the folder.	Applications
ResourceDirectoryPath	string	The path ID (RDPath) of the folder in the resource directory.	rd-3G**/r-Wm/fd-Jyl5U7**

Examples

Success response

JSON format

{
  "RequestId": "C2CBCA30-C8DD-423E-B4AD-4FB694C9180C",
  "Folder": {
    "FolderId": "fd-Jyl5U7****",
    "CreateTime": "2021-06-15T06:39:08.521Z",
    "ParentFolderId": "r-Wm****",
    "FolderName": "Applications",
    "ResourceDirectoryPath": "rd-3G****/r-Wm****/fd-Jyl5U7****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.FolderId	You must specify FolderId.	The FolderId parameter is not configured. Configure this parameter.
400	InvalidParameter.FolderId	The FolderId is invalid.	The value of the FolderId parameter is invalid. The value must start with r- followed by 6 characters or start with fd- followed by 10 characters. Valid characters are 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.