調用GetHandshake獲取邀請信息。

使用說明

本文將提供一個示例，獲取ID為h-ycm4rp****的邀請信息。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 GetHandshake

要執行的操作。取值：GetHandshake。

HandshakeId String 是 h-ycm4rp****

邀請ID。

關于公共請求參數的詳情，請參見公共參數。

返回數據

名稱 類型 示例值 描述
RequestId String 9B34724D-54B0-4A51-B34D-4512372FE1BE

請求ID。
Handshake Object

邀請信息。
Status String Pending

邀請狀態。

  • Pending：等待確認。
  • Accepted：已接受。
  • Cancelled：已取消。
  • Declined：已拒絕。
  • Expired：超時。
ExpireTime String 2018-08-24T09:55:41Z

邀請的過期時間（UTC時間）。
CreateTime String 2018-08-10T09:55:41Z

邀請的創建時間（UTC時間）。
TargetEntity String someone@example.com

被邀請賬號ID或登錄郵箱。
MasterAccountId String 172841235500****

資源目錄管理賬號ID。
HandshakeId String h-ycm4rp****

邀請ID。
MasterAccountRealName String company

資源目錄管理賬號實名認證信息。

說明 被邀請方調用此接口時，才能查看該參數。
ResourceDirectoryId String rd-abcdef****

資源目錄ID。
InvitedAccountRealName String Alice

被邀請方實名認證信息。

說明 被邀請方調用此接口時，才能查看該參數。
Note String 歡迎您加入

備注。
MasterAccountName String company@example.com

資源目錄管理賬號名稱。
TargetType String Email

被邀請賬號類型。

  • Account：賬號ID。
  • Email：賬號登錄郵箱。
ModifyTime String 2018-08-10T09:55:41Z

邀請的修改時間（UTC時間）。

示例

請求示例

https://resourcemanager.aliyuncs.com/?Action=GetHandshake
&HandshakeId=h-ycm4rp****
&<公共請求參數>

正常返回示例

XML格式 

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>歡迎您加入</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格式 

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" : "歡迎您加入",
    "Status" : "Pending",
    "CreateTime" : "2018-08-10T09:55:41Z",
    "ModifyTime" : "2018-08-10T09:55:41Z",
    "ExpireTime" : "2018-08-24T09:55:41Z"
  }
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
400 MissingParameter.HandshakeId You must specify HandshakeId. 邀請ID缺失，請指定目標ID。
400 InvalidParameter.HandshakeId The HandshakeId is invalid. 邀請ID無效，邀請ID應以“h-”開頭+16位數字或英文字母。
404 EntityNotExists.Handshake The specified handshake does not exist. 邀請不存在，請指定正確的邀請。
409 HandshakeStatusMismatch The invitation is invalid. 握手狀態不匹配或邀請已失效。
409 MissingAccountRealName The name of the invited account is not specified. 該邀請賬號沒有名稱信息。
409 NoRealNameAuthentication The account invited has not passed real-name authentication. 被邀請賬號無實名認證。

訪問錯誤中心查看更多錯誤碼。