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

Consulta as informações sobre uma função definida pelo usuário (UDF) no Data Studio.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do espaço de trabalho para consultar o ID.\n\n\n\nVocê deve configurar este parâmetro para especificar o espaço de trabalho do DataWorks ao qual a operação de API é aplicada.	10000
Id	string	Sim	O identificador exclusivo da função UDF.\n\n> Este campo é do tipo Long nas versões do SDK anteriores à 8.0.0 e do tipo String na versão 8.0.0 e posteriores do SDK. Essa alteração não afeta o uso normal do SDK; os parâmetros ainda são retornados de acordo com o tipo definido no SDK. Falhas de compilação devido à alteração de tipo podem ocorrer apenas ao atualizar o SDK para uma versão posterior à 8.0.0. Nesse caso, os usuários precisam corrigir manualmente o tipo de dados.	86043887262011****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação.	6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX
Function	object	Os detalhes da função UDF.
ProjectId	integer	O ID do espaço de trabalho do DataWorks ao qual a UDF pertence.	10000
Name	string	O nome da UDF.	Function name
Owner	string	O proprietário da UDF.	110755000425XXXX
CreateTime	integer	A hora em que a UDF foi criada. Este valor é um timestamp UNIX.	1724505917000
ModifyTime	integer	A hora em que a UDF foi modificada pela última vez. Este valor é um timestamp UNIX.	1724506661000
Spec	string	As informações do campo FlowSpec sobre a UDF. Para mais informações, consulte FlowSpec.	{ "version": "1.1.0", "kind": "Function", "spec": { "functions": [ { "name": "Function_Name", "id": "580667964888595XXXX", "script": { "content": "{ \"uuid\": \"580667964888595XXXX\", \"name\": \"Function_Name\", \"datasource\": { \"type\": \"odps\", \"name\": \"odps_first\" }, \"runtimeResource\": { \"resourceGroup\": \"S_res_group_XXXX_XXXX\", \"resourceGroupId\": 6591XXXX }}", "path": "XXX/OpenAPI/Function/Function_Name", "runtime": { "command": "ODPS_FUNCTION" } }, "datasource": { "name": "odps_first", "type": "odps" }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX", "id": "723932906364267XXXX", "resourceGroupId": "6591XXXX" }, "metadata": { "owner": "110755000425XXXX" } } ] } }
Id	string	O identificador exclusivo da função UDF.\n\n> Antes da versão 8.0.0 do SDK, este campo é do tipo Long. Na versão 8.0.0 e posteriores do SDK, ele é do tipo String. Essa alteração não afeta o uso normal do SDK. O parâmetro é retornado com base no tipo definido no SDK. Falhas de compilação causadas pela alteração de tipo podem ocorrer apenas quando você atualiza o SDK para uma versão posterior à 8.0.0. Nesse caso, você deve atualizar manualmente o tipo de dados.	860438872620113XXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX",
  "Function": {
    "ProjectId": 10000,
    "Name": "Function name",
    "Owner": "110755000425XXXX",
    "CreateTime": 1724505917000,
    "ModifyTime": 1724506661000,
    "Spec": "{\n    \"version\": \"1.1.0\",\n    \"kind\": \"Function\",\n    \"spec\": {\n        \"functions\": [\n            {\n                \"name\": \"Function_Name\",\n                \"id\": \"580667964888595XXXX\",\n                \"script\": {\n                    \"content\": \"{  \\\"uuid\\\": \\\"580667964888595XXXX\\\",  \\\"name\\\": \\\"Function_Name\\\",  \\\"datasource\\\": {    \\\"type\\\": \\\"odps\\\",    \\\"name\\\": \\\"odps_first\\\"  },  \\\"runtimeResource\\\": {    \\\"resourceGroup\\\": \\\"S_res_group_XXXX_XXXX\\\",    \\\"resourceGroupId\\\": 6591XXXX  }}\",\n                    \"path\": \"XXX/OpenAPI/Function/Function_Name\",\n                    \"runtime\": {\n                        \"command\": \"ODPS_FUNCTION\"\n                    }\n                },\n                \"datasource\": {\n                    \"name\": \"odps_first\",\n                    \"type\": \"odps\"\n                },\n                \"runtimeResource\": {\n                    \"resourceGroup\": \"S_res_group_XXXX_XXXX\",\n                    \"id\": \"723932906364267XXXX\",\n                    \"resourceGroupId\": \"6591XXXX\"\n                },\n                \"metadata\": {\n                    \"owner\": \"110755000425XXXX\"\n                }\n            }\n        ]\n    }\n}",
    "Id": "860438872620113XXXX\n"
  }
}

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.