All Products
Search
Document Center

Resource Management:GetHandshake

Last Updated:Oct 27, 2026

Queries the details of a handshake.

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:GetHandshake

get

*Handshake

acs:resourcemanager::{#accountId}:handshake/{#HandshakeId}

None None

Request parameters

Parameter

Type

Required

Description

Example

HandshakeId

string

Yes

The handshake ID.

h-ycm4rp****

Response elements

Element

Type

Description

Example

object

The returned result.

RequestId

string

The request ID.

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

Handshake

object

The handshake information.

Status

string

The handshake status. Valid values:

  • Pending: waiting for confirmation

  • Accepted: accepted

  • Cancelled: canceled

  • Declined: declined

  • Expired: expired

Pending

ExpireTime

string

The expiration time of the handshake in UTC.

2018-08-24T09:55:41Z

CreateTime

string

The creation time of the handshake 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 for the resource directory.

172841235500****

HandshakeId

string

The handshake ID.

h-ycm4rp****

MasterAccountRealName

string

The real-name verification information of the management account for the resource directory.

Note

This parameter is visible only when the invited account calls this operation.

company

ResourceDirectoryId

string

The resource directory ID.

rd-abcdef****

InvitedAccountRealName

string

The real-name verification information of the invited account.

Note

This parameter is visible only when the invited account calls this operation.

Alice

Note

string

The note.

Welcome aboard

MasterAccountName

string

The name of the management account for the resource directory.

company@example.com

TargetType

string

The type of the invited account. Valid values:

  • Account: account ID

  • Email: logon email address

Email

ModifyTime

string

The modification time of the handshake 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

Description

400 MissingParameter.HandshakeId You must specify HandshakeId.
400 InvalidParameter.HandshakeId The HandshakeId is invalid. The value of the HandshakeId parameter is invalid. The value must start with h- followed by 16 letters or digits.
404 EntityNotExists.Handshake The specified handshake does not exist.
409 HandshakeStatusMismatch The invitation is invalid. The invitation is invalid.
409 MissingAccountRealName The name of the invited account is not specified. The name of the invited account is not specified.
409 NoRealNameAuthentication The account invited has not passed real-name authentication. The invited account does not pass real-name verification.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.