InviteAccountToResourceDirectory
更新時間:
調(diào)用InviteAccountToResourceDirectory邀請外部賬號加入資源目錄。
使用說明
本文將提供一個示例,邀請外部賬號someone@example.com
加入資源目錄。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | InviteAccountToResourceDirectory | 要執(zhí)行的操作。取值:InviteAccountToResourceDirectory。 |
TargetEntity | String | 是 | someone@example.com | 被邀請賬號ID或登錄郵箱。 |
TargetType | String | 是 | 被邀請賬號類型。
|
|
Note | String | 否 | 歡迎您加入 | 備注。 最大長度為1024個字符。 |
Tag.N.Key | String | 否 | k1 | 標簽鍵。 |
Tag.N.Value | String | 否 | v1 | 標簽值。 |
關(guān)于公共請求參數(shù)的詳情,請參見公共參數(shù)。
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 9B34724D-54B0-4A51-B34D-4512372FE1BE | 請求ID。 |
Handshake | Object | 邀請信息。 |
|
Status | String | Pending | 邀請狀態(tài)。
|
ExpireTime | String | 2018-08-24T09:55:41Z | 邀請的過期時間(UTC時間)。 |
ResourceDirectoryId | String | rd-abcdef**** | 資源目錄ID。 |
CreateTime | String | 2018-08-10T09:55:41Z | 邀請的創(chuàng)建時間(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 | 被邀請賬號類型。
|
|
HandshakeId | String | h-ycm4rp**** | 邀請ID。 |
示例
請求示例
https://resourcemanager.aliyuncs.com/?Action=InviteAccountToResourceDirectory
&TargetEntity=someone@example.com
&TargetType=Email
&<公共請求參數(shù)>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<InviteAccountToResourceDirectoryResponse>
<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>Pending</Status>
<CreateTime>2018-08-10T09:55:41Z</CreateTime>
<ModifyTime>2018-08-10T09:55:41Z</ModifyTime>
<ExpireTime>2018-08-24T09:55:41Z</ExpireTime>
</Handshake>
</InviteAccountToResourceDirectoryResponse>
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" : "Pending",
"CreateTime" : "2018-08-10T09:55:41Z",
"ModifyTime" : "2018-08-10T09:55:41Z",
"ExpireTime" : "2018-08-24T09:55:41Z"
}
}
錯誤碼
HttpCode |
錯誤碼 |
錯誤信息 |
描述 |
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無效。 |
404 | EntityNotExists.ResourceDirectory | The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account. | 當(dāng)前賬號未啟用資源目錄,請先啟用資源目錄。 |
409 | LimitExceeded.Account | The maximum number of member accounts in a resource directory exceeds the limit. | 資源目錄中的成員數(shù)量超出限制。 |
409 | LimitExceeded.InvitationRate | The number of invitations sent exceeds the limit. | 發(fā)送邀請數(shù)量超出限制,每日最多只能發(fā)送20條邀請。 |
409 | EntityAlreadyExists.Handshake | Handshakes with the same target entity already exist. | 被邀請方已存在邀請記錄,請先處理邀請。 |
409 | NotSupport.AccountInAnotherResourceDirectory | Your account is a management account for another resource directory or a member of another resource directory. | 您的賬號是另一個資源目錄的管理賬號或是另一個資源目錄內(nèi)的成員。 |
409 | Invalid.AccountType | The specified profile type of account is invalid. | 賬號類型無效,請您使用企業(yè)類型賬號。 |
訪問錯誤中心查看更多錯誤碼。
文檔內(nèi)容是否對您有幫助?