All Products
Search

This Product

    Resource Management:CancelHandshake

    Document Center

    Resource Management:CancelHandshake

    Last Updated:Aug 28, 2026

    Cancels an invitation.

    Operation description

    This example shows how to cancel the invitation whose ID is h-ycm4rp****.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    resourcemanager:CancelHandshake

    update

    *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 elements

    Element

    Type

    Description

    Example

    object

    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 has expired.

    Cancelled
    ExpireTime

    string

    The expiration time of the invitation, 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 comment on the invitation.

    欢迎您加入
    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****

    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": "欢迎您加入",
    "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.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.