Queries the information of an invitation.

Usage notes

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetHandshake

The operation that you want to perform. Set the value to GetHandshake.

HandshakeId String Yes h-ycm4rp****

The ID of the invitation.

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

Response parameters

Parameter Type Example Description
RequestId String 9B34724D-54B0-4A51-B34D-4512372FE1BE

The ID of the request.

Handshake Object

The information of the invitation.

Status String Pending

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.
ExpireTime String 2018-08-24T09:55:41Z

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

CreateTime String 2018-08-10T09:55:41Z

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

TargetEntity String someone@example.com

The ID or logon email address of the invited account.

MasterAccountId String 172841235500****

The ID of the management account of the resource directory.

HandshakeId String h-ycm4rp****

The ID of the invitation.

MasterAccountRealName String company

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.
ResourceDirectoryId String rd-abcdef****

The ID of the resource directory.

InvitedAccountRealName String Alice

The real-name verification information of the invitee.

Note This parameter is available only when an invitee calls this operation.
Note String Welcome

The comment on the invitation.

MasterAccountName String company@example.com

The name of the management account of the resource directory.

TargetType String Email

The type of the invited account. Valid values:

  • Account: indicates the ID of the account.
  • Email: indicates the logon email address of the account.
ModifyTime String 2018-08-10T09:55:41Z

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

Examples

Sample requests

https://resourcemanager.aliyuncs.com/?Action=GetHandshake
&HandshakeId=h-ycm4rp****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<GetHandshakeResponse>
    <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>
    <Handshake>
        <HandshakeId>h-ycm4rp****</HandshakeId>
        <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>
        <MasterAccountId>172841235500****</MasterAccountId>
        <MasterAccountName>company@example.com</MasterAccountName>
        <MasterAccountRealName>company</MasterAccountRealName>
        <InvitedAccountRealName>Alice</InvitedAccountRealName>
        <TargetEntity>someone@example.com</TargetEntity>
        <TargetType>Email</TargetType>
        <Note>Welcome</Note>
        <Status>Pending</Status>
        <CreateTime>2018-08-10T09:55:41Z</CreateTime>
        <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>
        <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>
    </Handshake>
</GetHandshakeResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "Handshake" : {
    "HandshakeId" : "h-ycm4rp****",
    "ResourceDirectoryId" : "rd-abcdef****",
    "MasterAccountId" : "172841235500****",
    "MasterAccountName" : "company@example.com",
    "MasterAccountRealName" : "company",
    "InvitedAccountRealName" : "Alice",
    "TargetEntity" : "someone@example.com",
    "TargetType" : "Email",
    "Note" : "Welcome",
    "Status" : "Pending",
    "CreateTime" : "2018-08-10T09:55:41Z",
    "ModifyTime" : "2018-08-10T09:55:41Z",
    "ExpireTime" : "2018-08-24T09:55:41Z"
  }
}

Error codes

HTTP status code Error code Error message Description
400 MissingParameter.HandshakeId You must specify HandshakeId. The error message returned because the HandshakeId parameter is not configured. Configure this parameter.
400 InvalidParameter.HandshakeId The HandshakeId is invalid. The error message returned because the value of the HandshakeId parameter is invalid. The value must start with h- followed by 16 characters. Valid characters include letters and digits.
404 EntityNotExists.Handshake The specified handshake does not exist. The error message returned because the invitation does not exist. Specify a valid invitation.
409 HandshakeStatusMismatch The invitation is invalid. The error message returned because the invitation is invalid.
409 MissingAccountRealName The name of the invited account is not specified. The error message returned because the name of the invited account is not specified.
409 NoRealNameAuthentication The account invited has not passed real-name authentication. The error message returned because the invited account has not passed real-name verification.

For a list of error codes, visit the API Error Center.