GetEnrolledAccount - Cloud Governance Center - Alibaba Cloud Documentation Center

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
governance:GetEnrolledAccount	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	The information about the account.
AccountUid	long	The account ID.	12868156179*****
BaselineId	string	The ID of the baseline that is implemented.	afb-bp1adadfadsf***
BaselineItems	array<object>	The array that contains baseline items.
BaselineItem	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 baseline item is skipped. Valid values: false true	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.	CompliancePackExists
Message	string	The error message.	The compliance pack already exists.
Recommend	string	The recommended solution.	https://next.api.aliyun.com/troubleshoot?q=CompliancePackExists\\u0026product=Config
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 true	true
Inputs	object	Input parameters used to create an account.
AccountNamePrefix	string	The prefix of the account name.	test-account
AccountUid	long	The account ID.	12868156179*****
BaselineItems	array<object>	The baseline items.
BaselineItem	object
Config	string	The configurations of the baseline item.	{\"Contacts\":[{\"Name\":\"governance\",\"Email\":\"wibud****@gmail.com\",\"Mobile\":\"1234\",\"Position\":\"Other\"}]}
Name	string	The name of the baseline item.	ACS-BP_ACCOUNT_FACTORY_VPC
Skip	boolean	Indicates whether baseline item is skipped. Valid values: false true	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	long	The ID of the settlement account.	19534534552*****
Tag	array<object>	The tag.
tag	object	The tag.
Key	string	The tag key.	product
Value	string	The tag value.	governance
MasterAccountUid	long	The ID of the management account of the resource directory to which the account belongs.	19534534552*****
PayerAccountUid	long	The ID of the settlement account.	19534534552*****
Progress	array<object>	The progress of the applying the baseline to the account.
Progres	object	The progress of applying the account baseline to the account.
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 pending 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 fails 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 pending to be created. Running: The account is being created. Finished: The account is created. Failed: The account fails to be created. Scheduling: The account is being scheduled. ScheduleFailed: The account fails to be scheduled.	Finished
UpdateTime	string	The update time.	2021-11-01T02:38:27Z

Examples

Sample success responses

JSONformat

{
  "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": "CompliancePackExists",
    "Message": "The compliance pack already exists.\n",
    "Recommend": "https://next.api.aliyun.com/troubleshoot?q=CompliancePackExists\\\\u0026product=Config\n",
    "RequestId": "6D5EAA86-2D41-5CB7-8DA7-B60093ACAA4E"
  },
  "FolderId": "fd-5ESoku****",
  "Initialized": true,
  "Inputs": {
    "AccountNamePrefix": "test-account",
    "AccountUid": 0,
    "BaselineItems": [
      {
        "Config": "{\\\"Contacts\\\":[{\\\"Name\\\":\\\"governance\\\",\\\"Email\\\":\\\"wibud****@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.
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.
500	InternalError	A system error occurred.	A system error occurred.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-03-12	The Error code has changed. The response structure of the API has changed	View Change Details