Todos os produtos
Search
Central de documentação

Resource Management:GetHandshake

Última atualização: Jul 04, 2026

Consulta as informações de um convite.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

HandshakeId

string

Sim

O ID do convite.

h-ycm4rp****

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 do convite.

Status

string

O status do convite. Valores válidos:

  • Pending: O convite está aguardando confirmação.

  • Accepted: O convite foi aceito.

  • Cancelled: O convite foi cancelado.

  • Declined: O convite foi recusado.

  • Expired: O convite expirou.

Pending

ExpireTime

string

O horário em que o convite expira. O horário é exibido em UTC.

2018-08-24T09:55:41Z

CreateTime

string

O horário em que o convite foi criado. O horário é exibido em UTC.

2018-08-10T09:55:41Z

TargetEntity

string

O ID ou o endereço de e-mail de login da conta convidada.

someone@example.com

MasterAccountId

string

O ID da conta de gerenciamento do diretório de recursos.

172841235500****

HandshakeId

string

O ID do convite.

h-ycm4rp****

MasterAccountRealName

string

As informações de verificação de nome real da conta de gerenciamento do diretório de recursos.

Nota

Este parâmetro está disponível apenas quando um convidado chama esta operação.

company

ResourceDirectoryId

string

O ID do diretório de recursos.

rd-abcdef****

InvitedAccountRealName

string

As informações de verificação de nome real do convidado.

Nota

Este parâmetro está disponível apenas quando um convidado chama esta operação.

Alice

Note

string

A descrição do convite.

Welcome

MasterAccountName

string

O nome da conta de gerenciamento do diretório de recursos.

company@example.com

TargetType

string

O tipo da conta convidada. Valores válidos:

  • Account: indica o ID da conta.

  • Email: indica o endereço de e-mail de login da conta.

Email

ModifyTime

string

O horário em que o convite foi modificado. O horário é exibido em UTC.

2018-08-10T09:55:41Z

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "Handshake": {
    "Status": "Pending",
    "ExpireTime": "2018-08-24T09:55:41Z",
    "CreateTime": "2018-08-10T09:55:41Z",
    "TargetEntity": "someone@example.com",
    "MasterAccountId": "172841235500****",
    "HandshakeId": "h-ycm4rp****",
    "MasterAccountRealName": "company",
    "ResourceDirectoryId": "rd-abcdef****",
    "InvitedAccountRealName": "Alice",
    "Note": "Welcome\n",
    "MasterAccountName": "company@example.com",
    "TargetType": "Email",
    "ModifyTime": "2018-08-10T09:55:41Z"
  }
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 MissingParameter.HandshakeId You must specify HandshakeId.
400 InvalidParameter.HandshakeId The HandshakeId is invalid.
404 EntityNotExists.Handshake The specified handshake does not exist.
409 HandshakeStatusMismatch The invitation is invalid.
409 MissingAccountRealName The name of the invited account is not specified.
409 NoRealNameAuthentication The account invited has not passed real-name authentication.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.