All Products
Search
Document Center

:ListEnrolledAccounts

Last Updated:Apr 29, 2024

Queries a list of accounts that are enrolled in the account factory.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
governance:ListEnrolledAccountsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.

AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****
MaxResultsintegerNo

The maximum number of entries to return on each page.

Valid values: 1 to 100. Default value: 10.

10
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The accounts that were enrolled.

RequestIdstring

The request ID.

768F908D-A66A-5A5D-816C-20C93CBBFEE3
NextTokenstring

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.

AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****
EnrolledAccountsobject []

The accounts.

Statusstring

The creation status of the account. Valid values:

  • Pending: The account is waiting to be created.
  • Running: The account is being created.
  • Finished: The account is created.
  • Failed: The account failed to be created.
  • Scheduling: The account is being scheduled.
  • ScheduleFailed: The account failed to be scheduled.
Running
CreateTimestring

The time at which the account was created.

2021-11-01T02:38:27Z
DisplayNamestring

The display name of the account.

TestAccount
FolderIdstring

The ID of the parent folder.

fd-5ESoku****
UpdateTimestring

The time when the information about the account was updated.

2021-11-01T02:38:27Z
AccountUidlong

The account ID.

19534534552*****
PayerAccountUidlong

The ID of the billing account.

13161210500*****
BaselineIdstring

The baseline ID.

afb-bp1durvn3lgqe28v****

Examples

Sample success responses

JSONformat

{
  "RequestId": "768F908D-A66A-5A5D-816C-20C93CBBFEE3",
  "NextToken": "AAAAALHWGpGoYCcYMxiFfmlhvh62Xr2DzYbz/SAfc*****",
  "EnrolledAccounts": [
    {
      "Status": "Running",
      "CreateTime": "2021-11-01T02:38:27Z",
      "DisplayName": "TestAccount",
      "FolderId": "fd-5ESoku****",
      "UpdateTime": "2021-11-01T02:38:27Z",
      "AccountUid": 0,
      "PayerAccountUid": 0,
      "BaselineId": "afb-bp1durvn3lgqe28v****"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter %s is not valid.The specified parameter %s is invalid.
404InvalidUser.NotFoundThe specified user does not exist.The user does not exist.
404InvalidEnterpriseRealName.NotFoundThe 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.
500InternalErrorA system error occurred.A system error occurred.

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