All Products
Search
Document Center

Resource Management:CancelHandshake

Last Updated:Jun 25, 2024

Cancels an invitation.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
HandshakeIdstringYes

The ID of the invitation.

h-ycm4rp****

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The ID of the request.

9B34724D-54B0-4A51-B34D-4512372FE1BE
Handshakeobject

The information of the invitation.

Statusstring

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
ExpireTimestring

The time when the invitation expires. The time is displayed in UTC.

2018-08-24T09:55:41Z
ResourceDirectoryIdstring

The ID of the resource directory.

h-ycm4rp****
CreateTimestring

The time when the invitation was created. The time is displayed in UTC.

2018-08-10T09:55:41Z
Notestring

The description of the invitation.

Welcome
TargetEntitystring

The ID or logon email address of the invited account.

someone@example.com
MasterAccountIdstring

The ID of the management account of the resource directory.

172841235500****
MasterAccountNamestring

The name of the management account of the resource directory.

Alice
ModifyTimestring

The time when the invitation was modified. The time is displayed in UTC.

2018-08-10T09:55:41Z
TargetTypestring

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
HandshakeIdstring

The ID of the invitation.

h-ycm4rp****

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

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\n",
    "TargetEntity": "someone@example.com",
    "MasterAccountId": "172841235500****",
    "MasterAccountName": "Alice",
    "ModifyTime": "2018-08-10T09:55:41Z",
    "TargetType": "Email",
    "HandshakeId": "h-ycm4rp****"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameter.HandshakeIdYou must specify HandshakeId.-
400InvalidParameter.HandshakeIdThe HandshakeId is invalid.-
404EntityNotExists.HandshakeThe specified handshake does not exist.-
409HandshakeStatusMismatchThe invitation is invalid.The invitation is invalid.

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

Change history

Change timeSummary of changesOperation
No change history