All Products
Search

This Product

    Resource Management:GetHandshake

    Document Center

    Resource Management:GetHandshake

    Last Updated:Jun 05, 2024

    Queries the information of an invitation.

    Operation description

    In this example, the information of the invitation whose ID is h-ycm4rp**** is queried.

    Debugging

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

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    resourcemanager:GetHandshakeRead
    • Handshake
      acs:resourcemanager:*:{#accountId}:handshake/{#HandshakeId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    HandshakeIdstringYes

    The ID of the invitation.

    		h-ycm4rp****

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

    Response parameters

    ParameterTypeDescriptionExample
    object
    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.
    		Pending
    ExpireTimestring

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

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

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

    		2018-08-10T09:55:41Z
    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****
    HandshakeIdstring

    The ID of the invitation.

    		h-ycm4rp****
    MasterAccountRealNamestring

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

    Note This parameter is available only when an invitee calls this operation.
    		company
    ResourceDirectoryIdstring

    The ID of the resource directory.

    		rd-abcdef****
    InvitedAccountRealNamestring

    The real-name verification information of the invitee.

    Note This parameter is available only when an invitee calls this operation.
    		Alice
    Notestring

    The comment on the invitation.

    		Welcome
    MasterAccountNamestring

    The name of the management account of the resource directory.

    		company@example.com
    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
    ModifyTimestring

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

    		2018-08-10T09:55:41Z

    Examples

    Sample success responses

    JSONformat

    {
  "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",
    "MasterAccountName": "company@example.com",
    "TargetType": "Email",
    "ModifyTime": "2018-08-10T09:55:41Z"
  }
}

    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.
    409MissingAccountRealNameThe name of the invited account is not specified.The name of the invited account is not specified.
    409NoRealNameAuthenticationThe account invited has not passed real-name authentication.The account invited has not passed real-name authentication.

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

    Change history

    Change timeSummary of changesOperation
    No change history