調用CancelHandshake取消邀請。

使用說明

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

調試

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

請求參數

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

要執行的參數。取值：CancelHandshake。

HandshakeId String 是 h-ycm4rp****

邀請ID。

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

返回數據

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

請求ID。
Handshake Object

邀請信息。
Status String Cancelled

邀請狀態。

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

邀請的過期時間（UTC時間）。
ResourceDirectoryId String h-ycm4rp****

資源目錄ID。
CreateTime String 2018-08-10T09:55:41Z

邀請的創建時間（UTC時間）。
Note String 歡迎您加入

備注。
TargetEntity String someone@example.com

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

資源目錄管理賬號ID。
MasterAccountName String Alice

資源目錄管理賬號名稱。
ModifyTime String 2018-08-10T09:55:41Z

邀請的修改時間（UTC時間）。
TargetType String Email

被邀請賬號類型。

  • Account：賬號ID。
  • Email：賬號登錄郵箱。
HandshakeId String h-ycm4rp****

邀請ID。

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

示例

請求示例

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

正常返回示例

XML格式 

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

<CancelHandshakeResponse>
    <RequestId>9B34724D-54B0-4A51-B34D-4512372FE1BE</RequestId>
    <Handshake>
        <HandshakeId>h-ycm4rp****</HandshakeId>
        <ResourceDirectoryId>rd-abcdef****</ResourceDirectoryId>
        <MasterAccountId>172841235500****</MasterAccountId>
        <MasterAccountName>Alice</MasterAccountName>
        <TargetEntity>someone@example.com</TargetEntity>
        <TargetType>Email</TargetType>
        <Note>歡迎您加入</Note>
        <Status>Cancelled</Status>
        <CreateTime>2018-08-10T09:55:41Z</CreateTime>
        <ModifyTime>2018-08-10T09:55:41Z</ModifyTime>
        <ExpireTime>2018-08-24T09:55:41Z</ExpireTime>
    </Handshake>
</CancelHandshakeResponse>

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" : "Alice",
    "TargetEntity" : "someone@example.com",
    "TargetType" : "Email",
    "Note" : "歡迎您加入",
    "Status" : "Cancelled",
    "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. 握手狀態不匹配或邀請已失效。

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