Consulta os convites em um diretório de recursos.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| PageNumber |
integer |
Não |
O número da página a ser retornada. As páginas começam na página 1. Valor padrão: 1. |
1 |
| PageSize |
integer |
Não |
O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Valor padrão: 10. |
10 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
O resultado retornado. |
||
| TotalCount |
integer |
O número total de entradas retornadas. |
2 |
| RequestId |
string |
O ID da solicitação. |
9B34724D-54B0-4A51-B34D-4512372FE1BE |
| PageSize |
integer |
O número de entradas retornadas por página. |
10 |
| PageNumber |
integer |
O número da página retornada. |
1 |
| Handshakes |
object |
||
| Handshake |
array<object> |
As informações dos convites. |
|
|
object |
As informações de um convite. |
||
| Status |
string |
The status of the invitation. Valid values:
|
Pending |
| ExpireTime |
string |
The time when the invitation expires. The time is displayed in UTC. |
2018-08-24T09:55:41Z |
| ResourceDirectoryId |
string |
The ID of the resource directory. |
rd-abcdef**** |
| CreateTime |
string |
The time when the invitation was created. The time is displayed in UTC. |
2018-08-10T09:55:41Z |
| Note |
string |
The description of the invitation. |
Welcome |
| TargetEntity |
string |
The ID or logon email address of the invited account. |
someone@example.com |
| MasterAccountId |
string |
The ID of the management account of the resource directory. |
172841235500**** |
| MasterAccountName |
string |
The name of the management account of the resource directory. |
Alice |
| ModifyTime |
string |
The time when the invitation was modified. The time is displayed in UTC. |
2018-08-10T09:55:41Z |
| TargetType |
string |
The type of the invited account. Valid values:
|
|
| HandshakeId |
string |
The ID of the invitation. |
h-ycm4rp**** |
Exemplos
Resposta de sucesso
JSON formato
{
"TotalCount": 2,
"RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
"PageSize": 10,
"PageNumber": 1,
"Handshakes": {
"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 |
|---|---|---|---|
| 404 | EntityNotExists.ResourceDirectory | The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.