CancelHandshake - Resource Management - Alibaba Cloud Documentation Center

Cancels an invitation.

Operation description

This topic provides an example on how to call the API operation to cancel the invitation whose ID is h-ycm4rp****.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
resourcemanager:CancelHandshake	Write	Handshake acs:resourcemanager:*:{#accountId}:handshake/{#HandshakeId}	none	none

Request parameters

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

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

Response parameters

Parameter	Type	Description	Example
	object
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.	Cancelled
ExpireTime	string	The time when the invitation expires. The time is displayed 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. The time is displayed in UTC.	2018-08-10T09:55:41Z
Note	string	The comment on 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 modified. The time is displayed in UTC.	2018-08-10T09:55:41Z
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
HandshakeId	string	The ID of the invitation.	h-ycm4rp****

Examples

Sample success responses

JSONformat

{
  "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",
    "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	Description
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.	The invitation is invalid.

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

Change history

Change time	Summary of changes	Operation

No change history