Todos os produtos
Search
Central de documentação

:Consultar o agent de um cluster

Última atualização: Jul 08, 2026

Chame a operação DescribeExternalAgent para consultar as configurações do agent de um cluster registrado. Implante essas configurações em um cluster externo para acessar o servidor de API do cluster.

Para mais informações, consulte Registrar um cluster Kubernetes externo.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente exemplos de código da operação para diferentes SDKs.

Sintaxe da solicitação

GET /k8s/ClusterId/external/agent/deployment?PrivateIpAddress=String HTTP/1.1 
Content-Type:application/json

Parâmetros da solicitação

Parâmetros de caminho da solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

ClusterId

String

Sim

c106f377e16f34eb1808d6b9362c9****

ID do cluster a ser consultado.

Parâmetros de consulta da solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

PrivateIpAddress String Não true

Define se as credenciais de acesso ao cluster devem ser obtidas pela rede interna.

  • true: obtém as credenciais de acesso ao cluster pela rede interna.
  • false: obtém as credenciais de acesso ao cluster pela Internet.

Valor padrão: false.

AgentMode String Não admin

Modo de permissão do agent. Valores válidos:

admin: modo administrador, que concede permissões totais.

restricted: modo restrito, que concede permissões parciais.

Valor padrão: admin.

Sintaxe da resposta

HTTP/1.1 200
Content-Type:application/json
{
  "config" : "String"
}

Parâmetros da resposta

Parâmetros do corpo da resposta

Parâmetro

Tipo

Exemplo

Descrição

config

String

apiVersion: v1****

Configurações do agent no formato YAML.

Exemplos

Exemplos de solicitações

GET /k8s/c106f377e16f34eb1808d6b9362c9****/external/agent/deployment?PrivateIpAddress=true HTTP/1.1 
Content-Type:application/json

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<config>apiVersion: v1****</config>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "config" : "apiVersion: v1****"
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.