Querying Account Creation Status
Function
This API is used to query the status of the asynchronous request to create an account. This API can be called only from the organization's management account or a delegated administrator account.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
organizations:createAccountStatuses:get
Read
-
-
-
-
URI
GET /v1/organizations/create-account-status/{create_account_status_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
create_account_status_id |
Yes |
String |
ID value that uniquely identifies a CreateAccount request. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
create_account_status |
CreateAccountStatusDto object |
States of CreateAccount requests for an organization. |
|
Parameter |
Type |
Description |
|---|---|---|
|
account_id |
String |
Unique ID of the newly created account if any. |
|
account_name |
String |
Account name. |
|
completed_at |
String |
Date and time when the account was created and the request was completed. |
|
created_at |
String |
Date and time when the CreateAccount request was made. |
|
id |
String |
Unique ID of a request. You can get this value from the response to the initial CreateAccount request. |
|
state |
String |
Status of the asynchronous request for creating an account. |
|
failure_reason |
String |
error.1000 Failed to query the user identity information. error.2000 Failed to create the account. error.2001 Account name conflict. error.3000 Failed to create the resource account. error.3001 The number of accounts that can be registered with the mobile number exceeds the maximum limit. error.4000 Failed to create the birth token. error.5000 Failed to create the service-linked agency. error.6000 Failed to create the agency. error.6001 Failed to query the permission information. error.6002 Failed to bind the permission information. error.7000 Failed to associate the master account with member accounts for unified accounting. error.7001 Too many real-name authentication records. error.7002 Failed to query the unified accounting association between the master account and member accounts. error.0000 System error. |
|
failure_detail_msg |
failure_detail_msg object |
Detailed reason why the request fails. |
Example Requests
Querying account creation status
GET https://{endpoint}/v1/organizations/create-account-status/{create_account_status_id}
Example Responses
Status code: 200
Successful
{
"create_account_status" : {
"account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
"account_name" : "paas_iam_573331",
"completed_at" : "2022-08-24T06:41:15Z",
"created_at" : "2022-08-24T06:41:15Z",
"id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
"state" : "in_progress",
"failure_reason" : "string"
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Successful |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot