调用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 入参发生变更 | 看变更集 | ||||||||||||
|