Cancel an invitation by calling CancelHandshake - Resource Management - Alibaba Cloud - Resource Management

Cancels 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 invitation details.
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.	Cancelled
ExpireTime	string	The time when the invitation expires, in UTC.	2018-08-24T09:55:41Z
ResourceDirectoryId	string	The ID of the resource directory.	h-ycm4rp****
CreateTime	string	The time when the invitation was created, in UTC.	2018-08-10T09:55:41Z
Note	string	The description of the invitation.	Welcome
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****
MasterAccountName	string	The name of the management account of the resource directory.	Alice
ModifyTime	string	The time when the invitation was last modified, in UTC.	2018-08-10T09:55:41Z
TargetType	string	The type of the invited account. Valid values: Account: the ID of the account. Email: the logon email address of the account.	Email
HandshakeId	string	The ID of the invitation.	h-ycm4rp****

For more information about common request parameters, see Common parameters.

Examples

Success response

JSON format

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

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.