Resource Management:GetHandshake - Resource Management - Alibaba Cloud - Resource Management

Queries the information of an invitation.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
HandshakeId	string	Yes	The ID of the invitation.	h-ycm4rp****

Response elements

Element	Type	Description	Example
	object	The returned result.
RequestId	string	The ID of the request.	9B34724D-54B0-4A51-B34D-4512372FE1BE
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.	Pending
ExpireTime	string	The time when the invitation expires. The time is displayed in UTC.	2018-08-24T09:55:41Z
CreateTime	string	The time when the invitation was created. The time is displayed in UTC.	2018-08-10T09:55:41Z
TargetEntity	string	The ID or logon email address of the invited account.	someone@example.com
MasterAccountId	string	The ID of the management account of the resource directory.	172841235500****
HandshakeId	string	The ID of the invitation.	h-ycm4rp****
MasterAccountRealName	string	The real-name verification information of the management account of the resource directory. Note This parameter is available only when an invitee calls this operation.	company
ResourceDirectoryId	string	The ID of the resource directory.	rd-abcdef****
InvitedAccountRealName	string	The real-name verification information of the invitee. Note This parameter is available only when an invitee calls this operation.	Alice
Note	string	The description of the invitation.	Welcome
MasterAccountName	string	The name of the management account of the resource directory.	company@example.com
TargetType	string	The type of the invited account. Valid values: Account: indicates the ID of the account. Email: indicates the logon email address of the account.	Email
ModifyTime	string	The time when the invitation was modified. The time is displayed in UTC.	2018-08-10T09:55:41Z

Examples

Success response

JSON format

{
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "Handshake": {
    "Status": "Pending",
    "ExpireTime": "2018-08-24T09:55:41Z",
    "CreateTime": "2018-08-10T09:55:41Z",
    "TargetEntity": "someone@example.com",
    "MasterAccountId": "172841235500****",
    "HandshakeId": "h-ycm4rp****",
    "MasterAccountRealName": "company",
    "ResourceDirectoryId": "rd-abcdef****",
    "InvitedAccountRealName": "Alice",
    "Note": "Welcome\n",
    "MasterAccountName": "company@example.com",
    "TargetType": "Email",
    "ModifyTime": "2018-08-10T09:55:41Z"
  }
}

Error codes

HTTP status code	Error code	Error message
400	MissingParameter.HandshakeId	You must specify HandshakeId.
400	InvalidParameter.HandshakeId	The HandshakeId is invalid.
404	EntityNotExists.Handshake	The specified handshake does not exist.
409	HandshakeStatusMismatch	The invitation is invalid.
409	MissingAccountRealName	The name of the invited account is not specified.
409	NoRealNameAuthentication	The account invited has not passed real-name authentication.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.