Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Function as a Service

Get function

Retrieve detailed information about a specific function. Includes function code, configuration, and deployment status.

get/cloud/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

namespace_namestring required

Namespace name

Example:namespace-name

Namespace name

function_namestring required

Function name

Example:function-name

Function name

Response

OK

build_messagestring required

Function build message.

build_statusstring required

Function build status.

code_textstring required

Function code text.

created_atstring required

Function creation date.

dependenciesstring required

Dependencies for the function to install.

deploy_statusobject required

Function deploy status.

descriptionstring required

Description of the function.

enable_api_keyboolean nullable

Enable or disable API key authentication.

endpointstring required

Function endpoint.

envsobject nullable

Environment variables for the function. Keys must match a specific regex pattern and be 1-255 characters long, and values must be 0-255 characters long.

flavorstring required

The name of the flavor associated with the function.

idstring required

Function ID.

main_methodstring required

The main startup method name.

namestring required

Function name.

runtimestring required

Function runtime.

statusstring required

Function status.

timeoutinteger required

Function timeout in seconds.

Example response

{
  "autoscaling": {
    "max_instances": 5,
    "min_instances": 1
  },
  "build_message": "Building",
  "build_status": "Building",
  "code_text": "def main():\n    return 'Hello World'",
  "created_at": "2023-08-22T11:21:00Z",
  "dependencies": "numpy==1.21.0\npandas==1.3.0",
  "deploy_status": {
    "deployed": 1
  },
  "description": "This is a sample function.",
  "enable_api_key": true,
  "endpoint": "https://example.com/function-name",
  "envs": {
    "ENV_VAR": "value"
  },
  "flavor": "64m-64MB",
  "id": "c8a920ad-b5a4-47d5-b8b9-0e6c35cd800f",
  "main_method": "run",
  "name": "function-name",
  "runtime": "python3.7.12",
  "status": "Running",
  "timeout": 5
}