POST | Desativar agente do Network Connector

Descrição

Desative um agente do Network Connector. Agentes não podem ser excluídos. Um agente desativado mantém o código de identificação, a porta e o fingerprint. Você pode ativá-lo de novo.

Um agente desativado não pode ser editado nem vinculado a um dispositivo. Ele continua disponível para consulta, com active igual a false. Para usá-lo de novo, acesse POST | Ativar agente do Network Connector.

Pré-requisitos

Uma aplicação com a Permissão do recurso PAM definida como Leitura e escrita, concedida pelo administrador no A2A. Para mais informações, acesse Como gerenciar autorizações no A2A API v2.
Um token de acesso OAuth 2.0 válido. Para mais informações, acesse Como autenticar uma aplicação A2A.
Um agente ativo. Desativar um agente que já está desativado retorna 409.
O agente não é o agente padrão da aplicação. O agente padrão é o selecionado no campo Network Connector dos parâmetros da aplicação. Para mais informações, acesse Aplicação.
Nenhum recurso ativo, como um dispositivo, usa o agente. Vincule esses recursos a outro agente ou desative-os antes.

Requisição

POST /api/v2/platform/network-connector/agents/{agent_id}/deactivate

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
`agent_id`	integer	Sim	Código de identificação único do agente. Aceita apenas dígitos. Para encontrá-lo, acesse GET \| Listar todos os agentes do Network Connector.

Esta ação não tem corpo de requisição e não exige o cabeçalho If-Match.

Exemplo de requisição

POST {{url}}/api/v2/platform/network-connector/agents/12/deactivate

Resposta

HTTP/1.1 204 No Content

A resposta não tem corpo. O cabeçalho ETag traz o novo estado do agente.

Erros

Código HTTP	Mensagem	Causa possível	Solução
`403`	`api.auth.insufficient_permission`	A Permissão do recurso PAM da aplicação é Apenas leitura.	Peça ao administrador para definir a Permissão do recurso PAM como Leitura e escrita no A2A.
`404`	`api.resource.not_found`	O agente não existe.	Verifique o código de identificação enviado no caminho.
`404`	`api.route.not_found`	O valor de `agent_id` não é formado apenas por dígitos.	Envie o código de identificação do agente usando apenas dígitos.
`409`	`api.resource.conflict.already_inactive`	O agente já está desativado.	Nenhuma ação é necessária. O agente já está no estado pedido.
`409`	`network_connector_agent.is_application_default`	O agente é o agente padrão da aplicação.	Selecione outro agente no campo Network Connector dos parâmetros da aplicação e reenvie a requisição. Para mais informações, acesse Aplicação.
`409`	`network_connector_agent.in_use`	Recursos ativos ainda usam o agente. O campo `details` lista os tipos de recurso, como `devices`.	Vincule esses recursos a outro agente ou desative-os e reenvie a requisição.

Para erros de autenticação, limites de requisição e o formato da resposta de erro, acesse API v2 - Convenções e comportamentos compartilhados.

Exemplo de resposta de erro

409 dispositivos ativos ainda usam o agente:

{
    "code": "network_connector_agent.in_use",
    "message": "Cannot deactivate the agent while it is linked to other resources.",
    "details": [
        {
            "category": "devices"
        }
    ]
}