調(diào)用GetHandshake獲取邀請(qǐng)信息。

使用說(shuō)明

本文將提供一個(gè)示例，獲取ID為h-ycm4rp****的邀請(qǐng)信息。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

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

要執(zhí)行的操作。取值：GetHandshake。

HandshakeId String 是 h-ycm4rp****

邀請(qǐng)ID。

關(guān)于公共請(qǐng)求參數(shù)的詳情，請(qǐng)參見(jiàn)公共參數(shù)。

返回?cái)?shù)據(jù)

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

請(qǐng)求ID。
Handshake Object

邀請(qǐng)信息。
Status String Pending

邀請(qǐng)狀態(tài)。

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

邀請(qǐng)的過(guò)期時(shí)間（UTC時(shí)間）。
CreateTime String 2018-08-10T09:55:41Z

邀請(qǐng)的創(chuàng)建時(shí)間（UTC時(shí)間）。
TargetEntity String someone@example.com

被邀請(qǐng)賬號(hào)ID或登錄郵箱。
MasterAccountId String 172841235500****

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

邀請(qǐng)ID。
MasterAccountRealName String company

資源目錄管理賬號(hào)實(shí)名認(rèn)證信息。

說(shuō)明 被邀請(qǐng)方調(diào)用此接口時(shí)，才能查看該參數(shù)。
ResourceDirectoryId String rd-abcdef****

資源目錄ID。
InvitedAccountRealName String Alice

被邀請(qǐng)方實(shí)名認(rèn)證信息。

說(shuō)明 被邀請(qǐng)方調(diào)用此接口時(shí)，才能查看該參數(shù)。
Note String 歡迎您加入

備注。
MasterAccountName String company@example.com

資源目錄管理賬號(hào)名稱。
TargetType String Email

被邀請(qǐng)賬號(hào)類型。

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

邀請(qǐng)的修改時(shí)間（UTC時(shí)間）。

示例

請(qǐng)求示例

https://resourcemanager.aliyuncs.com/?Action=GetHandshake
&HandshakeId=h-ycm4rp****
&<公共請(qǐng)求參數(shù)>

正常返回示例

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"
  }
}

錯(cuò)誤碼

HttpCode 錯(cuò)誤碼 錯(cuò)誤信息 描述
400 MissingParameter.HandshakeId You must specify HandshakeId. 邀請(qǐng)ID缺失，請(qǐng)指定目標(biāo)ID。
400 InvalidParameter.HandshakeId The HandshakeId is invalid. 邀請(qǐng)ID無(wú)效，邀請(qǐng)ID應(yīng)以“h-”開(kāi)頭+16位數(shù)字或英文字母。
404 EntityNotExists.Handshake The specified handshake does not exist. 邀請(qǐng)不存在，請(qǐng)指定正確的邀請(qǐng)。
409 HandshakeStatusMismatch The invitation is invalid. 握手狀態(tài)不匹配或邀請(qǐng)已失效。
409 MissingAccountRealName The name of the invited account is not specified. 該邀請(qǐng)賬號(hào)沒(méi)有名稱信息。
409 NoRealNameAuthentication The account invited has not passed real-name authentication. 被邀請(qǐng)賬號(hào)無(wú)實(shí)名認(rèn)證。

訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。