GetAccount - Resource Management - Alibaba Cloud Documentation Center

Queries the information about a member.

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

get

*Account

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

None

Request parameters

Parameter	Type	Required	Description	Example
AccountId	string	Yes	The ID of the member.
IncludeTags	boolean	No	Specifies whether to return tag information. Valid values: true false Default value: false.

Response elements

Element	Type	Description	Example
	object	The response parameters.
Account	object	The information about the member.
Status	string	The status of the member. Valid values: CreateSuccess: The member is created. PromoteVerifying: The upgrade is being confirmed. PromoteFailed: The upgrade failed. PromoteExpired: The upgrade expired. PromoteCancelled: The upgrade is canceled. PromoteSuccess: The member is upgraded. InviteSuccess: The invitation is successful.
Type	string	The type of the member. Valid values: CloudAccount: Alibaba Cloud account. ResourceAccount: resource account.
DisplayName	string	The display name of the member.
FolderId	string	The ID of the folder.
ResourceDirectoryId	string	The ID of the resource directory.
IdentityInformation	string	The identity verification information.
JoinTime	string	The time when the member joined the resource directory.
AccountId	string	The ID of the member.
JoinMethod	string	The method by which the member joined the resource directory. Valid values: invited: The member was invited. created: The member was created.
ModifyTime	string	The time when the member was last modified.
AccountName	string	The name of the account.
ResourceDirectoryPath	string	The path of the member in the resource directory (RDPath).
Tags	array<object>	The tags.
	object	The tag.
Key	string	The tag key.
Value	string	The tag value.
Location	string	The location of the member in the resource directory.
EmailStatus	string	The status of the email address. Valid values: Empty: No records of email address modifications exist. WAIT_MODIFY: The email address is being modified. CANCELLED: The modification is canceled. EXPIRED: The modification expired.
HasSecureMobilePhone	boolean	Indicates whether a mobile phone number is attached to the member. Valid values: true false
SecureMobilePhone	string	The mobile phone number.
RequestId	string	The request ID.

Examples

Success response

JSON format

{
  "Account": {
    "Status": "",
    "Type": "",
    "DisplayName": "",
    "FolderId": "",
    "ResourceDirectoryId": "",
    "IdentityInformation": "",
    "JoinTime": "",
    "AccountId": "",
    "JoinMethod": "",
    "ModifyTime": "",
    "AccountName": "",
    "ResourceDirectoryPath": "",
    "Tags": [
      {
        "Key": "",
        "Value": ""
      }
    ],
    "Location": "",
    "EmailStatus": "",
    "HasSecureMobilePhone": true,
    "SecureMobilePhone": ""
  },
  "RequestId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.AccountId	You must specify AccountId.	The AccountId parameter is not configured.
400	InvalidParameter.AccountId	The AccountId is invalid.	The value of the AccountId parameter is invalid. Specify a 16-digit ID.
404	EntityNotExists.Account	This resource directory account does not exist.	The member does not exist. Create such a member first.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.