GetResourceDirectory - query resource directory details - Resource Management

Queries the information about a resource directory. If a management account calls this operation, the details of the resource directory activated by the management account are returned. If a member calls this operation, the details of the resource directory to which the member belongs are returned.

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

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	CD76D376-2517-4924-92C5-DBC52262F93A
ResourceDirectory	object	The resource directory information.
RootFolderId	string	The ID of the Root folder.	r-Zo****
ResourceDirectoryId	string	The resource directory ID.	rd-St****
CreateTime	string	The time when the resource directory was enabled. The time is displayed in ISO 8601 format, in UTC.	2019-02-18T15:32:10.473Z
MasterAccountId	string	The ID of the management account.	172845045600****
MasterAccountName	string	The name of the management account.	aliyun-admin
ControlPolicyStatus	string	The status of the control policy. Valid values: Enabled: Enabled. PendingEnable: Being enabled. Disabled: Disabled. PendingDisable: Being disabled.	Enabled
MemberDeletionStatus	string	Indicates whether member deletion is enabled. Valid values: Enabled: Enabled. You can call DeleteAccount to delete members of the resource account type. Disabled: Disabled. You cannot delete members of the resource account type.	Enabled
IdentityInformation	string	The real-name information of the member.	***有限公司
MemberAccountDisplayNameSyncStatus	string	The synchronization status of the display name for member accounts. Valid values: Enabled: Enabled. Disabled: Shutdown.	Enabled

Examples

Success response

JSON format

{
  "RequestId": "CD76D376-2517-4924-92C5-DBC52262F93A",
  "ResourceDirectory": {
    "RootFolderId": "r-Zo****",
    "ResourceDirectoryId": "rd-St****",
    "CreateTime": "2019-02-18T15:32:10.473Z",
    "MasterAccountId": "172845045600****",
    "MasterAccountName": "aliyun-admin",
    "ControlPolicyStatus": "Enabled",
    "MemberDeletionStatus": "Enabled",
    "IdentityInformation": "*** Co., Ltd.",
    "MemberAccountDisplayNameSyncStatus": "Enabled"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	ResourceDirectoryNotInUse	The specified account is not an Alibaba Cloud account or a member account of the resource directory.	The account is not an Alibaba Cloud account or a member of a resource directory.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.