GetAccount API Reference for Member Account Details - Resource Management - Alibaba Cloud - Resource Management

Queries the information about a member account.

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 member account ID.	181761095690****
IncludeTags	boolean	No	Specifies whether to return tag information. Valid values: false (default): Does not return tag information. true: Returns tag information.	true

Response elements

Element	Type	Description	Example
	object	The response.
Account	object	The member account information.
Status	string	The join status of the member account. Valid values: CreateSuccess: Created. PromoteVerifying: Upgrade is being confirmed. PromoteFailed: Upgrade failed. PromoteExpired: Upgrade expired. PromoteCancelled: Upgrade canceled. PromoteSuccess: Upgrade succeeded. InviteSuccess: Invited.	CreateSuccess
Type	string	The type of the member account. Valid values: CloudAccount: cloud account. ResourceAccount: resource account.	ResourceAccount
DisplayName	string	The display name of the member account.	admin
FolderId	string	The folder ID.	fd-bVaRIG****
ResourceDirectoryId	string	The resource directory ID.	rd-k3****
IdentityInformation	string	The real-name verification information.	aliyun-admin
JoinTime	string	The time when the member account joined the resource directory. The time is displayed in ISO 8601 format, in UTC.	2015-01-23T12:33:18Z
AccountId	string	The member account ID.	181761095690****
JoinMethod	string	The method used by the member account to join the resource directory. Valid values: invited: The member account was invited to join. created: The member account was created.	created
ModifyTime	string	The time when the member account was last modified. The time is displayed in ISO 8601 format, in UTC.	2015-01-23T12:33:18Z
AccountName	string	The name of the account.	someone@example.com
ResourceDirectoryPath	string	The path ID (RDPath) of the member account in the resource directory.	rd-k3**/r-Wm/fd-bVaRIG/181761095690**
Tags	array<object>	The tags.
	object	The tag list.
Key	string	The tag key.	tag_key
Value	string	The tag value.	tag_value
Location	string	The location of the member account in the resource directory.	root/AlRd**/Z5Aa**
EmailStatus	string	The email status. Valid values: Empty: No email modification record exists. WAIT_MODIFY: The email is being modified. CANCELLED: The modification is canceled. EXPIRED: The modification expired.	WAIT_MODIFY
HasSecureMobilePhone	boolean	Indicates whether the member account has a bound secure phone number. Valid values: true: The member account has a bound secure phone number. false: The member account does not have a bound secure phone number.	true
SecureMobilePhone	string	The secure phone number.	1234567****
RequestId	string	The request ID.	9B34724D-54B0-4A51-B34D-4512372FE1BE

Examples

Success response

JSON format

{
  "Account": {
    "Status": "CreateSuccess",
    "Type": "ResourceAccount",
    "DisplayName": "admin",
    "FolderId": "fd-bVaRIG****",
    "ResourceDirectoryId": "rd-k3****",
    "IdentityInformation": "aliyun-admin",
    "JoinTime": "2015-01-23T12:33:18Z",
    "AccountId": "181761095690****",
    "JoinMethod": "created",
    "ModifyTime": "2015-01-23T12:33:18Z",
    "AccountName": "someone@example.com",
    "ResourceDirectoryPath": "rd-k3****/r-Wm****/fd-bVaRIG****/181761095690****",
    "Tags": [
      {
        "Key": "tag_key",
        "Value": "tag_value"
      }
    ],
    "Location": "root/AlRd****/Z5Aa****",
    "EmailStatus": "WAIT_MODIFY",
    "HasSecureMobilePhone": true,
    "SecureMobilePhone": "1234567****"
  },
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE"
}

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.