調用CancelHandshake取消邀請。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
HandshakeId | string | 是 | 邀請 ID。 | h-ycm4rp**** |
返回參數
關于公共請求參數的詳情,請參見公共參數。
示例
正常返回示例
JSON
格式
{
"RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
"Handshake": {
"Status": "Cancelled",
"ExpireTime": "2018-08-24T09:55:41Z",
"ResourceDirectoryId": "h-ycm4rp****",
"CreateTime": "2018-08-10T09:55:41Z",
"Note": "歡迎您加入",
"TargetEntity": "someone@example.com",
"MasterAccountId": "172841235500****",
"MasterAccountName": "Alice",
"ModifyTime": "2018-08-10T09:55:41Z",
"TargetType": "Email",
"HandshakeId": "h-ycm4rp****"
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
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. | 握手狀態不匹配或邀請已失效。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史