GET | Listar um agente do Network Connector por [id]

Descrição

Obtenha o nome, a porta, o status e o fingerprint de um único agente do Network Connector pelo código de identificação.

O endpoint retorna agentes ativos e desativados. O campo active mostra o status do agente.

O id do agente é o valor que o campo network_connector_id de um dispositivo aceita. Um dispositivo aceita apenas um agente ativo. Na requisição do dispositivo, envie o id como número inteiro.

Pré-requisitos

Uma aplicação com a Permissão do recurso PAM definida como Apenas leitura ou 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.

Requisição

GET /api/v2/platform/network-connector/agents/{agent_id}

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.

Parâmetros de query

Campo	Tipo	Descrição
`fields`	string	Restringe a resposta aos campos listados. Aceita `id`, `network_connector_agent.name`, `network_connector_agent.port`, `network_connector_agent.active` e `network_connector_agent.fingerprint`. O campo `id` é sempre retornado.

Para a sintaxe completa de projeção de campos, acesse API v2 - Convenções e comportamentos compartilhados.

Exemplo de requisição

GET {{url}}/api/v2/platform/network-connector/agents/2

Resposta

HTTP/1.1 200 OK

O endpoint aceita leituras condicionais. Envie no cabeçalho If-None-Match o valor de ETag de uma resposta anterior. Se o agente não mudou, a resposta é 304 Not Modified, sem corpo.

Exemplo de corpo da resposta

{
    "data": {
        "id": "2",
        "network_connector_agent": {
            "name": "agent-rj-01",
            "port": "30001",
            "active": true,
            "fingerprint": "EXAMPLE-FINGERPRINT-0001"
        }
    },
    "meta": {
        "links": {
            "self": "/api/v2/platform/network-connector/agents/2"
        },
        "actions": {
            "deactivate": "/api/v2/platform/network-connector/agents/2/deactivate"
        }
    }
}

Campos do corpo da resposta

Campo	Tipo	Descrição
`data`	object	O agente.
`data.id`	string	Código de identificação único do agente, retornado como string. Use este valor no campo `network_connector_id` de um dispositivo.
`data.network_connector_agent`	object	Atributos do agente.
`data.network_connector_agent.name`	string	Nome do agente.
`data.network_connector_agent.port`	string	Porta do agente, retornada como string. Pode ser `null`.
`data.network_connector_agent.active`	boolean	`true` quando o agente está ativo, `false` quando está desativado.
`data.network_connector_agent.fingerprint`	string	Valor usado para instalar o agente. Guarde-o com segurança e compartilhe-o apenas com quem vai instalar o agente. Pode ser `null`.
`meta`	object	Metadados da resposta.
`meta.links.self`	string	URL da requisição atual.
`meta.actions.deactivate`	string	Caminho para desativar o agente. Retornado apenas quando o agente está ativo. Para mais informações, acesse POST \| Desativar agente do Network Connector.
`meta.actions.activate`	string	Caminho para ativar o agente. Retornado apenas quando o agente está desativado. Para mais informações, acesse POST \| Ativar agente do Network Connector.

Erros

Código HTTP	Mensagem	Causa possível	Solução
`404`	`api.resource.not_found`	O agente não existe.	Verifique o código de identificação enviado no caminho. Para encontrar os agentes, acesse GET \| Listar todos os agentes do Network Connector.
`404`	`api.route.not_found`	O valor de `agent_id` não é formado apenas por dígitos, como `abc`, `-1` ou `1.5`.	Envie o código de identificação do agente usando apenas dígitos.
`422`	`api.fields.invalid`	O parâmetro `fields` pediu um campo que não existe.	Confira os nomes dos campos em Parâmetros de query.

Para erros de autenticação e de permissão e a política de 403 versus 404, acesse API v2 - Convenções e comportamentos compartilhados.