AcceptHandshake - Resource Management - Alibaba Cloud Documentation Center

Accepts an invitation.

Operation description

After an invited Alibaba Cloud account joins a resource directory, it becomes a member of the resource directory. By default, the name of the invited Alibaba Cloud account is used as the display name of the account in the resource directory.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
HandshakeId	string	Yes	The ID of the invitation. You can call the ListHandshakesForAccount operation to obtain the ID.	h-Ih8IuPfvV0t0****

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The ID of the request.	5828C836-3286-49A6-9006-15231BB19342
Handshake	object	The information of the invitation.
Status	string	The status of the invitation. Valid values: Pending: The invitation is waiting for confirmation. Accepted: The invitation is accepted. Cancelled: The invitation is canceled. Declined: The invitation is rejected. Expired: The invitation expires.	Accepted
ExpireTime	string	The time when the invitation expires. The time is displayed in UTC.	2021-01-20T02:15:40Z
ResourceDirectoryId	string	The ID of the resource directory.	rd-3G****
CreateTime	string	The time when the invitation was created. The time is displayed in UTC.	2021-01-06T02:15:40Z
Note	string	The description of the invitation.	Welcome
TargetEntity	string	The ID or logon email address of the invited Alibaba Cloud account.	177242285274****
MasterAccountId	string	The ID of the management account of the resource directory.	151266687691****
MasterAccountName	string	The name of the management account of the resource directory.	CompanyA
ModifyTime	string	The time when the invitation was modified. The time is displayed in UTC.	2021-01-06T02:16:40Z
TargetType	string	The type of the invited Alibaba Cloud account. Valid values: Account: indicates the ID of the Alibaba Cloud account. Email: indicates the logon email address of the Alibaba Cloud account.	Account
HandshakeId	string	The ID of the invitation.	h-Ih8IuPfvV0t0****

Examples

Sample success responses

JSONformat

{
  "RequestId": "5828C836-3286-49A6-9006-15231BB19342",
  "Handshake": {
    "Status": "Accepted",
    "ExpireTime": "2021-01-20T02:15:40Z",
    "ResourceDirectoryId": "rd-3G****",
    "CreateTime": "2021-01-06T02:15:40Z",
    "Note": "Welcome\n",
    "TargetEntity": "177242285274****",
    "MasterAccountId": "151266687691****",
    "MasterAccountName": "CompanyA",
    "ModifyTime": "2021-01-06T02:16:40Z",
    "TargetType": "Account",
    "HandshakeId": "h-Ih8IuPfvV0t0****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.HandshakeId	You must specify HandshakeId.	-
400	InvalidParameter.HandshakeId	The HandshakeId is invalid.	-
404	EntityNotExists.Handshake	The specified handshake does not exist.	-
404	SpecifiedResourceDirectoryNotExists	The specified resource directory does not exist. You must specify a valid resource directory.	The specified resource directory does not exist. Specify a valid resource directory.
409	HandshakeStatusMismatch	The invitation is invalid.	The invitation is invalid.
409	NotSupport.AccountInAnotherResourceDirectory	Your account is a management account for another resource directory or a member of another resource directory.	-
409	Invalid.AccountType	The specified profile type of account is invalid.	The account type is invalid. Use an enterprise account.
409	NotSupport.Account.RealNameType	Your account is not a real-name of enterprise type, so you cannot accept the invitation.	You cannot accept the invitation because your account does not pass enterprise real-name verification.

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

Change history

Change time	Summary of changes	Operation

No change history