Method: projects.locations.dataAgents.list

Lista os DataAgents num determinado projeto e localização.

Pedido HTTP

GET https://geminidataanalytics.googleapis.com/v1beta/{parent=projects/*/locations/*}/dataAgents

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Valor principal para ListDataAgentsRequest.

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O servidor pode devolver menos itens do que o pedido. Se não for especificado, o servidor escolhe uma predefinição adequada.

pageToken

string

Opcional. Um token de página, recebido de uma chamada dataAgents.list anterior. Forneça este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a dataAgents.list têm de corresponder à chamada que forneceu o token da página. O serviço pode devolver um número inferior a este valor.

filter

string

Opcional. A filtrar resultados. Consulte o AIP-160 para ver a sintaxe.

orderBy

string

Opcional. Especificação do utilizador sobre como ordenar os resultados.

showDeleted

boolean

Opcional. Se o valor for verdadeiro, os resultados da lista incluem DataAgents eliminados temporariamente. A predefinição é false.

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Mensagem para resposta à listagem de agentes de dados.

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

Representação JSON
{
  "dataAgents": [
    {
      object (DataAgent)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
dataAgents[]

object (DataAgent)

A lista de DataAgent.

nextPageToken

string

O token da página seguinte ou vazio, se não existir.

unreachable[]

string

Lista não ordenada. Localizações às quais não foi possível aceder.

Âmbitos de autorização

Requer o seguinte âmbito do OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • geminidataanalytics.dataAgents.list

Para mais informações, consulte a documentação do IAM.