Todos os produtos
Search
Central de documentação

Resource Management:CancelHandshake

Última atualização: Jul 04, 2026

Cancela 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.

Cancelled

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.

h-ycm4rp****

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 login 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:

  • Account: indica o ID da conta.

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

Email

HandshakeId

string

O ID do convite.

h-ycm4rp****

Para obter mais informações sobre os parâmetros de solicitação comuns, consulte Parâmetros comuns.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "Handshake": {
    "Status": "Cancelled",
    "ExpireTime": "2018-08-24T09:55:41Z",
    "ResourceDirectoryId": "h-ycm4rp****",
    "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.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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.