GetFunction - DataWorks - Centro de documentación de Alibaba Cloud

Consulta los detalles de una función definida por el usuario (UDF) en Data Studio.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:*

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks y acceder a la página de configuración del espacio de trabajo para consultar el ID. Debe configurar este parámetro para especificar el espacio de trabajo de DataWorks al que se aplica la operación de API.	10000
Id	string	Sí	El identificador único de la función UDF. Nota Este campo es de tipo Long en las versiones del SDK anteriores a la 8.0.0 y de tipo String en la versión 8.0.0 del SDK y posteriores. Este cambio no afecta el uso normal del SDK; los parámetros se siguen devolviendo según el tipo definido en el SDK. Solo se pueden producir errores de compilación debido al cambio de tipo cuando la actualización del SDK cruza la versión 8.0.0; en ese caso, debe corregir manualmente el tipo de datos.	86043887262011****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
RequestId	string	El ID de la solicitud.	6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX
Function	object	Los detalles de la función UDF.
ProjectId	integer	El ID del espacio de trabajo de DataWorks al que pertenece la UDF.	10000
Name	string	El nombre de la UDF.	Function name
Owner	string	El propietario de la UDF.	110755000425XXXX
CreateTime	integer	La hora en que se creó la UDF. Este valor es una marca de tiempo UNIX.	1724505917000
ModifyTime	integer	La hora en que se modificó por última vez la UDF. Este valor es una marca de tiempo UNIX.	1724506661000
Spec	string	La información de los campos de FlowSpec sobre la UDF. Para obtener más información, 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	El identificador único de la función UDF. Nota En las versiones del SDK anteriores a la 8.0.0, este campo es de tipo Long. En la versión 8.0.0 del SDK y posteriores, es de tipo String. Este cambio no afecta el uso normal del SDK. El parámetro se devuelve según el tipo definido en el SDK. Solo se pueden producir errores de compilación causados por el cambio de tipo cuando la actualización del SDK cruza la versión 8.0.0. En este caso, debe actualizar manualmente el tipo de datos.	860438872620113XXXX

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX",
  "Function": {
    "ProjectId": 10000,
    "Name": "Nombre de la función",
    "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"
  }
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.