Queries the information of an invitation.

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.

Response parameters

Parameter Type Example Description
Handshake Struct

The information of the invitation.

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

The time when the invitation was created.

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

The time when the invitation expires.

HandshakeId String h-ycm4rp****

The ID of the invitation.

InvitedAccountRealName String Alice

The real name of the invitee.

Note This parameter is available only when an invitee calls this operation.
MasterAccountId String 172841235500****

The ID of the master account.

MasterAccountName String company@example.com

The name of the master account.

MasterAccountRealName String company

The real name of the master account.

Note This parameter is available only when an invitee calls this operation.
ModifyTime String 2018-08-10T09:55:41Z

The time when the invitation was modified.

Note String Welcome

The invitation note.

ResourceDirectoryId String rd-abcdef****

The ID of the resource directory.

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 expired.
TargetEntity String someone@example.com

The ID or logon email address of the invited account.

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.
RequestId String 9B34724D-54B0-4A51-B34D-4512372FE1BE

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<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>Welcom</Note>
            <Status>Pending</Status>
            <CreateTime>2018-08-10T09:55:41Z</CreateTime>
            <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>
            <ExpireTime>2018-08-17T09:55:41Z</ExpireTime>
      </Handshake>
</GetHandshakeResponse>

JSON format

{
    "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": "Welcom",
        "Status": "Pending",
        "CreateTime": "2018-08-10T09:55:41Z",
        "ModifyTime": "2018-08-10T09:55:41Z",
        "ExpireTime": "2018-08-17T09: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 specified. Specify 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 are 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.

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