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

Obtém uma lista paginada de funções UDF no Data Studio. Você também pode usar condições de filtro para filtrar funções UDF.

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:*

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de Gerenciamento de Espaços de Trabalho para obter o ID. Este parâmetro especifica o espaço de trabalho do DataWorks para esta operação de chamada de API.	12345
Owner	string	Não	A condição de filtro: o ID do proprietário da função UDF.	110755000425XXXX
Type	string	Não	A condição de filtro: o tipo de função. Valores válidos: Math: função de operação matemática Aggregate: funções de agregação String: função de processamento de cadeia de caracteres Date: função de data Analytic: função de janela Other: outra função	Math
Name	string	Não	A condição de filtro: o nome da função UDF. Há suporte para correspondência aproximada.	test
PageNumber	integer	Não	O número da página. Valor padrão: 1. Valor mínimo: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação. Usado para solução de problemas quando ocorre um erro.	89FB2BF0-EB00-5D03-9C34-05931001XXXX
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas que atendem às condições de filtro.	294
PageNumber	integer	O número da página dos dados retornados. Usado para paginação.	1
PageSize	integer	O número de entradas por página.	10
Functions	array<object>	A lista de funções.
	array<object>	As informações sobre uma função na lista.
Name	string	O nome da função UDF.	Function name
CreateTime	integer	O timestamp em que a função UDF foi criada.	1655953028000
ProjectId	integer	O ID do projeto ao qual a função UDF pertence.	307XXX
Owner	string	O proprietário da função UDF.	110755000425XXXX
Type	string	O tipo da função UDF. Valores válidos: Math: função de operação matemática Aggregate: funções de agregação String: função de processamento de cadeia de caracteres Date: função de data Analytic: função de janela Other: outra função	Math
ModifyTime	integer	A hora de modificação. O valor é um número de 13 dígitos, como `1655953028000`.	1655953028000
ClassName	string	O nome de classe totalmente qualificado da função UDF.	com.demo.Main
ArmResource	string	A lista de arquivos de recursos para o cluster ARM.	xxx.jar,yyy.jar
FileResource	string	O código de implementação da função. A lista de arquivos de recursos.	xxx.jar,yyy.jar
Description	string	A descrição geral da função.	Description
CommandDescription	string	A descrição do comando.	testUdf(xx,yy)
ParameterDescription	string	A descrição do parâmetro.	xx: parameter information XXX yy: parameter information YYY
ReturnValueDescription	string	A descrição do valor de retorno.	The return value is a string.
ExampleDescription	string	A descrição do exemplo.	Example description >>> select tsetUdf(xx,yy); abc
EmbeddedCodeType	string	O tipo de código incorporado. Valores válidos: Python2 Python3 Java8 Java11 Java17	Python2
EmbeddedResourceType	string	O tipo de recurso incorporado. Valores válidos: File: arquivo de recurso comum Embedded: recurso incorporado	File
EmbeddedCode	string	O conteúdo do código da função incorporada.	print('hello,world!')
DatabaseName	string	O nome do banco de dados. Este campo é usado apenas quando o tipo de função é EMR Function.	EMR_lake
DataSource	object	As informações da fonte de dados da função UDF.
Name	string	O nome da fonte de dados.	odps_first
Type	string	O tipo da fonte de dados.	odps
Script	object	As informações de script da função UDF.
Path	string	O caminho do script.	XXX/OpenAPI/function/function_name
Runtime	object	O runtime.
Command	string	O comando.	ODPS_FUNCTION
Id	string	O ID do script. Importante Este campo era do tipo Long nas versões do SDK anteriores à 8.0.0 e é do tipo String no SDK 8.0.0 e posterior. Esta alteração não afeta o uso normal do SDK. O parâmetro ainda é retornado no tipo definido no SDK. Somente ao atualizar o SDK para uma versão posterior à 8.0.0, a alteração de tipo pode causar falhas na compilação do projeto, sendo necessário corrigir manualmente o tipo de dados.	652567824470354XXXX
RuntimeResource	object	As informações do grupo de recursos de runtime.
ResourceGroupId	string	O ID do grupo de recursos de runtime.	S_resgrop_xxx
Id	string	O identificador exclusivo da função UDF. Importante Este campo era do tipo Long nas versões do SDK anteriores à 8.0.0 e é do tipo String no SDK 8.0.0 e posterior. Esta alteração não afeta o uso normal do SDK. O parâmetro ainda é retornado no tipo definido no SDK. Somente ao atualizar o SDK para uma versão posterior à 8.0.0, a alteração de tipo pode causar falhas na compilação do projeto, sendo necessário corrigir manualmente o tipo de dados.	580667964888595XXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "89FB2BF0-EB00-5D03-9C34-05931001XXXX",
  "PagingInfo": {
    "TotalCount": 294,
    "PageNumber": 1,
    "PageSize": 10,
    "Functions": [
      {
        "Name": "Nome da função",
        "CreateTime": 1655953028000,
        "ProjectId": 0,
        "Owner": "110755000425XXXX",
        "Type": "Math",
        "ModifyTime": 1655953028000,
        "ClassName": "com.demo.Main",
        "ArmResource": "xxx.jar,yyy.jar",
        "FileResource": "xxx.jar,yyy.jar",
        "Description": "Descrição",
        "CommandDescription": "testUdf(xx,yy)",
        "ParameterDescription": "xx: informações do parâmetro XXX",
        "ReturnValueDescription": "O valor de retorno é uma string",
        "ExampleDescription": "Descrição do exemplo >>> select tsetUdf(xx,yy);",
        "EmbeddedCodeType": "Python2",
        "EmbeddedResourceType": "File",
        "EmbeddedCode": "print('hello,world!')",
        "DatabaseName": "EMR_lake",
        "DataSource": {
          "Name": "odps_first",
          "Type": "odps"
        },
        "Script": {
          "Path": "XXX/OpenAPI/function/function_name",
          "Runtime": {
            "Command": "ODPS_FUNCTION"
          },
          "Id": "652567824470354XXXX"
        },
        "RuntimeResource": {
          "ResourceGroupId": "S_resgrop_xxx"
        },
        "Id": "580667964888595XXXX"
      }
    ]
  }
}

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.