ListCustomAgents - DataWorks: Central de Documentação do Alibaba Cloud

Lista agentes personalizados com paginação.

Descrição da operação

Descrição da solicitação

Palavra-chave de pesquisa: Use o parâmetro Q para realizar uma correspondência aproximada nos nomes dos agentes.
Filtro de nível de visibilidade: Use o parâmetro Visibility para filtrar os resultados por nível de visibilidade, como TENANT, PROJECT ou USER.
Informações de paginação: Use os parâmetros MaxResults e NextToken para implementar uma consulta paginada. O parâmetro NextToken é usado para recuperar a próxima página de dados.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:ListCustomAgents

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
MaxResults	integer	Não	O número máximo de entradas a serem retornadas para esta solicitação.	20
NextToken	string	Não	O token de paginação. Não especifique este parâmetro para a primeira consulta. Para consultas subsequentes, especifique o valor de `NextToken` retornado da consulta anterior para recuperar a próxima página.	12345
Q	string	Não	A palavra-chave de pesquisa usada para realizar uma correspondência aproximada nos nomes dos agentes.	analysis
Visibility	array	Não	Os níveis de visibilidade usados para filtrar resultados. Você pode especificar vários valores.	-
	string	Não	O nível de visibilidade. Valores válidos: PROJECT : Project. USER : User. TENANT : Tenant.	TENANT

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas que atendem às condições da consulta.	100
MaxResults	integer	O número máximo de entradas retornadas nesta resposta.	20
NextToken	string	O token para a próxima página. Um valor vazio indica que a última página foi alcançada.	5
Agents	array<object>	A lista de agentes personalizados.
	object	A lista de agentes.
Name	string	O nome do agente.	my-agent
DisplayName	string	O nome de exibição.	My Assistant
Description	string	A descrição.	Data analytics assistant
CreatorId	string	O ID do criador.	123456
ModifierId	string	O ID do último modificador.	123456
Visibility	string	O nível de visibilidade.	TENANT
GmtCreateTime	string	A hora de criação (timestamp UNIX em milissegundos).	1780555634000
GmtModifiedTime	string	A hora da última modificação (timestamp UNIX em milissegundos).	1780555634000

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "PagingInfo": {
    "TotalCount": 100,
    "MaxResults": 20,
    "NextToken": "5",
    "Agents": [
      {
        "Name": "my-agent",
        "DisplayName": "My Assistant",
        "Description": "Data analytics assistant",
        "CreatorId": "123456",
        "ModifierId": "123456",
        "Visibility": "TENANT",
        "GmtCreateTime": "1780555634000",
        "GmtModifiedTime": "1780555634000"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.