調用InviteAccountToResourceDirectory邀請外部賬號加入資源目錄。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TargetEntity | string | 是 | 被邀請賬號 ID 或登錄郵箱。 | someone@example.com |
TargetType | string | 是 | 被邀請賬號類型。取值:
| |
Note | string | 否 | 備注。 最大長度為 1024 個字符。 | 歡迎您加入 |
Tag | object [] | 否 | 標簽。 | |
Key | string | 否 | 標簽鍵。 | k1 |
Value | string | 否 | 標簽值。 | v1 |
ParentFolderId | string | 否 | 父資源夾 ID。 | r-b1**** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
"Handshake": {
"Status": "Pending",
"ExpireTime": "2018-08-24T09:55:41Z",
"ResourceDirectoryId": "rd-abcdef****",
"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.TargetEntity | You must specify TargetEntity. | 邀請方信息缺失,請指定目標實體。 |
400 | InvalidParameter.TargetEntity | The TargetEntity is invalid. | 目標實體無效,請指定賬號UID/賬號登錄郵箱。 |
400 | MissingParameter.TargetType | You must specify TargetType. | 邀請類型缺失,請指定目標類型。 |
400 | InvalidParameter.TargetType | The TargetType is invalid. | 邀請類型無效,請指定賬號UID/賬號登錄郵箱。 |
400 | InvalidParameter.Note.Length | The length of the invitation note exceeds the limit. | 邀請備注長度超出限制,最多不能超過1024個字符或漢字。 |
400 | InvalidParameter.Note | The Note is invalid. | Note無效。 |
400 | InvalidParameter.ParentFolderId | The ParentFolderId is invalid. | 父資源夾ID無效,資源夾ID應以“r-”開頭+6位數字或英文字母或以“fd-”開頭+10位數字或英文字母。 |
400 | InvalidParameter.AccountId | The AccountId is invalid. | 成員ID無效,請輸入16位賬號ID。 |
404 | EntityNotExists.ResourceDirectory | The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account. | 當前賬號未啟用資源目錄,請先啟用資源目錄。 |
404 | EntityNotExists.Folder | The resource directory folder does not exist. | 資源夾不存在,請先創建資源夾。 |
409 | LimitExceeded.Account | The maximum number of member accounts in a resource directory exceeds the limit. | 資源目錄中的成員數量超出限制。 |
409 | LimitExceeded.InvitationRate | The number of invitations sent exceeds the limit. | 發送邀請數量超出限制,每日最多只能發送20條邀請。 |
409 | EntityAlreadyExists.Handshake | Handshakes with the same target entity already exist. | 被邀請方已存在邀請記錄,請先處理邀請。 |
409 | Invalid.AccountType | The specified profile type of account is invalid. | 賬號類型無效,請您使用企業類型賬號。 |
409 | EntityAlreadyExists.ResourceDir.Account | This resource directory account already exists. | 創建成員時系統生成的郵箱已被占用,請重試。 |
409 | LimitExceeded.Invitation.InvalidTarget | The maximum number of invalid targets that can be invited by a single account is exceeded. | 同一賬號邀請無效目標數量超過限制。 |
409 | NotSupport.AccountInAnotherResourceDirectory | The invited account already belongs to another resource directory. To continue, remove the account from the other resource directory. | 被邀請賬號已歸屬其他資源目錄,如需繼續請先將此賬號從其他資源目錄中移除。 |
409 | LegalEntityMismatch | The account does not have the same legal entity as the management account. | 被邀請賬號與資源目錄管理賬號的實名信息不一致。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-12-08 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||||||
| ||||||||||||||
2023-10-25 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||||||
| ||||||||||||||
2023-09-04 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||||||
| ||||||||||||||
2023-05-24 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||||||
| ||||||||||||||
2023-04-28 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 看變更集 | ||||||||||||
|