GetFunction - - Centro de documentación de Alibaba Cloud

Consulta la información de una función.

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

fc:GetFunction

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

GET /2021-04-06/services/{serviceName}/functions/{functionName} HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
serviceName	string	Sí	El nombre del servicio.	service_name
functionName	string	Sí	El nombre de la función.	function_name

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
qualifier	string	No	La versión o el alias del servicio.	demoQualifier
X-Fc-Account-Id	string	No	El ID de su cuenta de Alibaba Cloud.	188077086902****
X-Fc-Date	string	No	La hora en la que se invoca la función. El formato del valor es: EEE,d MMM yyyy HH:mm:ss GMT.	Wed, 11 May 2022 09:00:00 GMT
X-Fc-Trace-Id	string	No	El ID de solicitud personalizado.	asdf****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La definición de la función.
codeChecksum	string	El valor CRC-64 del paquete de código de la función.	2825179536350****
codeSize	integer	El tamaño del paquete de código de la función. Unidad: byte.	421
createdTime	string	La hora en la que se creó la función.	2020-04-01T08:15:27Z
description	string	La descripción de la función.	test_description
environmentVariables	object	Las variables de entorno configuradas para la función. Puede obtener los valores de las variables de entorno desde la función. Para más información, consulte Variables de entorno.
	string	Las variables de entorno que configuró para la función.	{"key":"value"}
functionId	string	El ID generado por el sistema para la función. Cada ID de función es único en Function Compute.	aa715851-1c20-4b89-a8fb-***
functionName	string	El nombre de la función.	function_name
handler	string	El controlador de la función. Para más información, consulte Controlador de función.	index.handler
lastModifiedTime	string	La hora en la que se modificó por última vez la función.	2020-04-01T08:15:27Z
memorySize	integer	El tamaño de memoria para la función. Unidad: MB. El valor debe ser un múltiplo de 64. El tamaño de memoria varía según el tipo de instancia de la función. Para más información, consulte Tipos de instancias.	256
runtime	string	El entorno de ejecución de la función. Valores válidos: nodejs20, nodejs18, nodejs16, nodejs14, nodejs12, nodejs10, nodejs8, nodejs6, nodejs4.4, python3.10, python3.9, python3, python2.7, java11, java8, go1, php7.2, dotnetcore2.1, custom.debian10, custom y custom-container.	python3
timeout	integer	El periodo de tiempo de espera para la ejecución de la función. Unidad: segundos. Valor predeterminado: 60. Valores válidos: de 1 a 600. Cuando este periodo expira, la ejecución de la función finaliza.	60
initializationTimeout	integer	El periodo de tiempo de espera para la ejecución del hook Initializer. Unidad: segundos. Valor predeterminado: 3. Valores válidos: de 1 a 300. Cuando este periodo termina, la ejecución del hook Initializer finaliza.	60
initializer	string	El controlador del hook Initializer. El formato del valor depende del lenguaje de programación que utilice. Para más información, consulte Hook Initializer.	index.handler
caPort	integer	El puerto en el que escucha el servidor HTTP para el entorno de ejecución personalizado o el entorno de ejecución de contenedor personalizado.	9000
customContainerConfig	CustomContainerConfigInfo	Las configuraciones del entorno de ejecución Custom Container. Después de configurar el entorno de ejecución Custom Container, puede usar una imagen de contenedor personalizada para ejecutar funciones.
layers	array	La lista de capas (ARN V1). Nota Si existen múltiples capas, estas se fusionan según los subíndices de la matriz en orden descendente. El contenido de una capa con un subíndice menor sobrescribe el de una capa con un subíndice mayor. Nota Este parámetro quedará obsoleto. Utilice layersArnV2.
	string	El nombre del recurso de capa (versión ARN V1).	02f81d283888f5ec63442a88fe82b260#Layer-name#1
instanceConcurrency	integer	El número de solicitudes que una sola instancia puede procesar simultáneamente.	10
instanceSoftConcurrency	integer	La concurrencia suave de la instancia. Puede usar este parámetro para implementar un escalado gradual de instancias. Si el número de solicitudes concurrentes en una instancia es mayor que el valor de concurrencia suave, se activa un escalado de la instancia. Por ejemplo, si su instancia requiere mucho tiempo para iniciarse, puede especificar una concurrencia suave adecuada para iniciar la instancia con anticipación. El valor debe ser menor o igual al del parámetro instanceConcurrency.	5
instanceType	string	El tipo de instancia de la función. Valores válidos: e1: instancias elásticas c1: instancias de rendimiento fc.gpu.tesla.1: instancias aceleradas por GPU con tarjetas de la serie Tesla fc.gpu.ampere.1: instancias aceleradas por GPU con tarjetas de la serie Ampere fc.gpu.ada.1: instancias aceleradas por GPU con tarjetas de la serie Ada g1: igual que fc.gpu.tesla.1	e1
instanceLifecycleConfig	InstanceLifecycleConfig	Las configuraciones del ciclo de vida de las instancias.
customDNS	CustomDNS	La configuración personalizada del Sistema de Nombres de Dominio (DNS) de la función.
customRuntimeConfig	CustomRuntimeConfig	Las configuraciones de la función que se ejecuta en el entorno de ejecución personalizado.
customHealthCheckConfig	CustomHealthCheckConfig	Las configuraciones personalizadas de comprobación de estado de la función. Este parámetro solo es aplicable a entornos de ejecución personalizados y entornos de ejecución Custom Container.
layersArnV2	array	La lista de capas (ARN V2). Nota Si existen múltiples capas, estas se fusionan según los subíndices de la matriz en orden descendente. El contenido de una capa con un subíndice menor sobrescribe el de una capa con un subíndice mayor.
	string	El nombre del recurso de capa (versión ARN V2).	acs:fc:{region}:{accountID}:layers/{layerName}/versions/{layerVersion}
cpu	number	El número de vCPU de la función. El valor debe ser un múltiplo de 0.05.	1.5
diskSize	integer	El tamaño del disco de la función. Unidad: MB. Valores válidos: 512 y 10240.	512
gpuMemorySize	integer	La capacidad de memoria GPU para la función. Unidad: MB. El valor es un múltiplo de 1,024.	2048

Ejemplos

Respuesta exitosa

JSON Formato

{
  "codeChecksum": "2825179536350****",
  "codeSize": 421,
  "createdTime": "2020-04-01T08:15:27Z",
  "description": "test_description",
  "environmentVariables": {
    "key": "{\"key\":\"value\"}"
  },
  "functionId": "aa715851-1c20-4b89-a8fb-***",
  "functionName": "function_name",
  "handler": "index.handler",
  "lastModifiedTime": "2020-04-01T08:15:27Z",
  "memorySize": 256,
  "runtime": "python3",
  "timeout": 60,
  "initializationTimeout": 60,
  "initializer": "index.handler",
  "caPort": 9000,
  "customContainerConfig": {
    "args": "[\"-arg1\", \"value1\"]",
    "command": "[\"/code/myserver\"]",
    "image": "registry-vpc.cn-hangzhou.aliyuncs.com/fc-demo/helloworld:v1beta1",
    "accelerationType": "Default",
    "accelerationInfo": {
      "status": "Preparing"
    },
    "instanceID": "cri-xxxxxxxxxx",
    "webServerMode": true
  },
  "layers": [
    "02f81d283888f5ec63442a88fe82b260#Layer-name#1"
  ],
  "instanceConcurrency": 10,
  "instanceSoftConcurrency": 5,
  "instanceType": "e1",
  "instanceLifecycleConfig": {
    "preFreeze": {
      "handler": "index.preStop",
      "timeout": 10
    },
    "preStop": {
      "handler": "index.preStop",
      "timeout": 10
    }
  },
  "customDNS": {
    "nameServers": [
      "8.8.x.x"
    ],
    "searches": [
      "ns1.svc.cluster-domain.example"
    ],
    "dnsOptions": [
      {
        "name": "ndots",
        "value": "2"
      }
    ]
  },
  "customRuntimeConfig": {
    "command": [
      "/code/myBootstrap"
    ],
    "args": [
      "args1"
    ]
  },
  "customHealthCheckConfig": {
    "httpGetUrl": "/ready",
    "initialDelaySeconds": 1,
    "periodSeconds": 1,
    "timeoutSeconds": 2,
    "failureThreshold": 1,
    "successThreshold": 2
  },
  "layersArnV2": [
    "acs:fc:{region}:{accountID}:layers/{layerName}/versions/{layerVersion}"
  ],
  "cpu": 1.5,
  "diskSize": 512,
  "gpuMemorySize": 2048
}

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.