Convida uma conta para participar de um diretório de recursos.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| TargetEntity |
string |
Sim |
O ID ou o endereço de e-mail de logon da conta que você deseja convidar. |
someone@example.com |
| TargetType |
string |
Sim |
O tipo da conta convidada. Valores válidos:
|
|
| Note |
string |
Não |
A descrição do convite. A descrição pode ter até 1.024 caracteres. |
Welcome |
| Tag |
array<object> |
Não |
As tags. |
|
|
object |
Não |
As tags. |
||
| Key |
string |
Não |
A chave da tag. |
k1 |
| Value |
string |
Não |
O valor da tag. |
v1 |
| ParentFolderId |
string |
Não |
O ID da pasta pai. |
r-b1**** |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
O resultado retornado. |
||
| RequestId |
string |
O ID da solicitação. |
9B34724D-54B0-4A51-B34D-4512372FE1BE |
| Handshake |
object |
As informações sobre o convite. |
|
| Status |
string |
O status do convite. Valores válidos:
|
Pending |
| ExpireTime |
string |
A hora em que o convite expira. A hora é exibida em UTC. |
2018-08-24T09:55:41Z |
| ResourceDirectoryId |
string |
O ID do diretório de recursos. |
rd-abcdef**** |
| CreateTime |
string |
A hora em que o convite foi criado. A hora é exibida em UTC. |
2018-08-10T09:55:41Z |
| Note |
string |
A descrição do convite. |
Welcome |
| TargetEntity |
string |
O ID ou o endereço de e-mail de logon da conta convidada. |
someone@example.com |
| MasterAccountId |
string |
O ID da conta de gerenciamento do diretório de recursos. |
172841235500**** |
| MasterAccountName |
string |
O nome da conta de gerenciamento do diretório de recursos. |
Alice |
| ModifyTime |
string |
A hora em que o convite foi modificado. A hora é exibida em UTC. |
2018-08-10T09:55:41Z |
| TargetType |
string |
O tipo da conta convidada. Valores válidos:
|
|
| HandshakeId |
string |
O ID do convite. |
h-ycm4rp**** |
Exemplos
Resposta de sucesso
JSON formato
{
"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": "Welcome\n",
"TargetEntity": "someone@example.com",
"MasterAccountId": "172841235500****",
"MasterAccountName": "Alice",
"ModifyTime": "2018-08-10T09:55:41Z",
"TargetType": "Email",
"HandshakeId": "h-ycm4rp****"
}
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | MissingParameter.TargetEntity | You must specify TargetEntity. | |
| 400 | InvalidParameter.TargetEntity | The TargetEntity is invalid. | |
| 400 | MissingParameter.TargetType | You must specify TargetType. | |
| 400 | InvalidParameter.TargetType | The TargetType is invalid. | |
| 400 | InvalidParameter.Note.Length | The length of the invitation note exceeds the limit. | |
| 400 | InvalidParameter.Note | The Note is invalid. | |
| 400 | InvalidParameter.ParentFolderId | The ParentFolderId is invalid. | |
| 400 | InvalidParameter.AccountId | The AccountId is invalid. | |
| 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. | |
| 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. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.