GetEnrolledAccount API Overview & Response Fields - Cloud Governance Center - Alibaba Cloud - Cloud Governance Center

Queries the details about an account that is enrolled in the account factory.

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

governance:GetEnrolledAccount

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AccountUid	integer	Yes	The ID of the account.	19534534552****
RegionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response parameters.
AccountUid	integer	The ID of the account.	12868156179*****
BaselineId	string	The ID of the baseline that is applied.	afb-bp1adadfadsf***
BaselineItems	array<object>	The baseline items.
	object	The configuration of the baseline item.
Config	string	The configuration of the baseline item.	{\"Notifications\":[{\"GroupKey\":\"account_msg\",\"Contacts\":[{\"Name\":\"aa\"}],\"PmsgStatus\":1,\"EmailStatus\":1,\"SmsStatus\":1}]}
Name	string	The name of the baseline item.	ACS-BP_ACCOUNT_FACTORY_VPC
Skip	boolean	Indicates whether the baseline item is skipped. Valid values: false: The baseline item is not skipped. true: The baseline item is skipped.	false
Version	string	The version of the baseline item.	1.0
CreateTime	string	The time when the account was created.	2021-11-01T02:38:27Z
DisplayName	string	The display name of the account.	test-account
ErrorInfo	object	The error message. Note This parameter is returned if the value of `Status` is `Failed` or `ScheduleFailed`.
Code	string	The error code.	EntityAlreadyExists.Role
Message	string	The error message.	The role already exists.
Recommend	string	The recommended solution.	https://next.api.aliyun.com/troubleshoot?q=EntityAlreadyExists.Role\u0026product=Ram
RequestId	string	The request ID.	6D5EAA86-2D41-5CB7-8DA7-B60093ACAA4E
FolderId	string	The ID of the parent folder.	fd-5ESoku****
Initialized	boolean	Indicates whether the initialization is complete. Valid values: false: The initialization is not complete. true: The initialization is complete.	true
Inputs	object	The input parameters that were specified when the account was enrolled.
AccountNamePrefix	string	The prefix of the account name.	test-account
AccountUid	integer	The ID of the account.	12868156179*****
BaselineItems	array<object>	The baseline items.
	object
Config	string	The configurations of the baseline item.	{\"Contacts\":[{\"Name\":\"governance\",\"Email\":\"wibud5210+10@gmail.com\",\"Mobile\":\"1234\",\"Position\":\"Other\"}]}
Name	string	The name of the baseline item.	ACS-BP_ACCOUNT_FACTORY_VPC
Skip	boolean	Indicates whether the baseline item is skipped. Valid values: false: The baseline item is not skipped. true: The baseline item is skipped.	false
Version	string	The version of the baseline item.	1.0
DisplayName	string	The display name of the account.	test-account
FolderId	string	The ID of the parent folder.	fd-5ESoku****
PayerAccountUid	integer	The ID of the billing account.	19534534552*****
Tag	array<object>	The tag.
	object	The tag.
Key	string	The tag key.	product
Value	string	The tag value.	governance
MasterAccountUid	integer	The ID of the management account of the resource directory to which the account belongs.	19534534552*****
PayerAccountUid	integer	The ID of the billing account.	19534534552*****
Progress	array<object>	The progress of applying the baseline to the account.
	object	The baseline application progress.
Name	string	The name of the baseline item.	ACS-BP_ACCOUNT_FACTORY_VPC
Status	string	The status of applying the baseline to the account. Valid values: Pending: The baseline is waiting to be applied to the account. Running: The baseline is being applied to the account. Finished: The baseline is applied to the account. Failed: The baseline failed to be applied to the account.	Running
RequestId	string	The request ID.	768F908D-A66A-5A5D-816C-20C93CBBFEE3
Status	string	The status of the account. Valid values: Pending: The account is waiting to be enrolled. Running: The account is being enrolled. Finished: The account is enrolled. Failed: The account failed to be enrolled. Scheduling: The account is being scheduled. ScheduleFailed: The account failed to be scheduled.	Finished
UpdateTime	string	The update time.	2021-11-01T02:38:27Z

Examples

Success response

JSON format

{
  "AccountUid": 0,
  "BaselineId": "afb-bp1adadfadsf***",
  "BaselineItems": [
    {
      "Config": "{\\\"Notifications\\\":[{\\\"GroupKey\\\":\\\"account_msg\\\",\\\"Contacts\\\":[{\\\"Name\\\":\\\"aa\\\"}],\\\"PmsgStatus\\\":1,\\\"EmailStatus\\\":1,\\\"SmsStatus\\\":1}]}",
      "Name": "ACS-BP_ACCOUNT_FACTORY_VPC",
      "Skip": false,
      "Version": "1.0"
    }
  ],
  "CreateTime": "2021-11-01T02:38:27Z",
  "DisplayName": "test-account",
  "ErrorInfo": {
    "Code": "EntityAlreadyExists.Role",
    "Message": "The role already exists.",
    "Recommend": "https://next.api.aliyun.com/troubleshoot?q=EntityAlreadyExists.Role\\u0026product=Ram",
    "RequestId": "6D5EAA86-2D41-5CB7-8DA7-B60093ACAA4E"
  },
  "FolderId": "fd-5ESoku****",
  "Initialized": true,
  "Inputs": {
    "AccountNamePrefix": "test-account",
    "AccountUid": 0,
    "BaselineItems": [
      {
        "Config": "{\\\"Contacts\\\":[{\\\"Name\\\":\\\"governance\\\",\\\"Email\\\":\\\"wibud5210+10@gmail.com\\\",\\\"Mobile\\\":\\\"1234\\\",\\\"Position\\\":\\\"Other\\\"}]}",
        "Name": "ACS-BP_ACCOUNT_FACTORY_VPC",
        "Skip": false,
        "Version": "1.0"
      }
    ],
    "DisplayName": "test-account",
    "FolderId": "fd-5ESoku****",
    "PayerAccountUid": 0,
    "Tag": [
      {
        "Key": "product",
        "Value": "governance"
      }
    ]
  },
  "MasterAccountUid": 0,
  "PayerAccountUid": 0,
  "Progress": [
    {
      "Name": "ACS-BP_ACCOUNT_FACTORY_VPC",
      "Status": "Running"
    }
  ],
  "RequestId": "768F908D-A66A-5A5D-816C-20C93CBBFEE3",
  "Status": "Finished",
  "UpdateTime": "2021-11-01T02:38:27Z"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter %s is not valid.	The specified parameter %s is invalid.
500	InternalError	A system error occurred.	A system error occurred.
404	InvalidUser.NotFound	The specified user does not exist.	The user does not exist.
404	InvalidBlueprint.NotFound	The specified blueprint does not exist.	The specified blueprint does not exist.
404	InvalidEnterpriseRealName.NotFound	The specified account has not passed enterprise real name verification. Please complete the verification for the account first.	The specified account has not passed enterprise real-name verification. Please complete the verification for the account first.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.