調用GetHandshake獲取邀請信息。
接口說明
本文將提供一個示例，獲取 ID 為h-ycm4rp****的邀請信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| resourcemanager:GetHandshake | Read |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| HandshakeId | string | 是 | 邀請 ID。 | h-ycm4rp**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
"Handshake": {
"Status": "Pending",
"ExpireTime": "2018-08-24T09:55:41Z",
"CreateTime": "2018-08-10T09:55:41Z",
"TargetEntity": "someone@example.com",
"MasterAccountId": "172841235500****",
"HandshakeId": "h-ycm4rp****",
"MasterAccountRealName": "company",
"ResourceDirectoryId": "rd-abcdef****",
"InvitedAccountRealName": "Alice",
"Note": "歡迎您加入",
"MasterAccountName": "company@example.com",
"TargetType": "Email",
"ModifyTime": "2018-08-10T09:55:41Z"
}
}錯誤碼
| 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. | 握手狀態不匹配或邀請已失效。 |
| 409 | MissingAccountRealName | The name of the invited account is not specified. | 該邀請賬號沒有名稱信息。 |
| 409 | NoRealNameAuthentication | The account invited has not passed real-name authentication. | 被邀請賬號無實名認證。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史