Documentation | Function As A Service › Namespaces

Function As A Service

function_as_a_service

Methods

Get Faa S Flavors -> { count, results }

get/v1/faas/flavors/{project_id}/{region_id}

Get FaaS flavors

Get Faa S Runtimes -> { runtimes }

get/v1/faas/runtimes/{project_id}/{region_id}

Get FaaS runtimes

Function As A Service

Keys

function_as_a_service.keys

Methods

Create API Key -> { created_at, functions, name, 4 more... }

post/v1/faas/keys/{project_id}/{region_id}

Create api key

Delete API Key ->

delete/v1/faas/keys/{project_id}/{region_id}/{key_name}

Delete api key

Get API Key ->

FaasAPIKey

get/v1/faas/keys/{project_id}/{region_id}/{key_name}

Get api key

List API Keys -> OffsetPage<

FaasAPIKey

get/v1/faas/keys/{project_id}/{region_id}

List api keys

Change API Key ->

FaasAPIKey

patch/v1/faas/keys/{project_id}/{region_id}/{key_name}

Change api key

Domain types

FaasAPIKey = { created_at, functions, name, 3 more... }

Function As A Service

Namespaces

function_as_a_service.namespaces

Methods

Create Namespace -> { tasks }

post/v1/faas/namespaces/{project_id}/{region_id}

Create namespace

Delete Namespace -> { tasks }

delete/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}

Delete namespace

Get Namespace -> { created_at, functions, functions_deploy_status, 4 more... }

get/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}

Get namespace

List Namespaces -> OffsetPage<{ created_at, functions, functions_deploy_status, 4 more... }>

get/v1/faas/namespaces/{project_id}/{region_id}

List namespaces

Parameters

project_id: number

Project ID

region_id: number

Region ID

limit: number

Optional

(exclusiveMinimum: 0, maximum: 1000)

Optional. Limit the number of returned items

offset: number

Optional

(minimum: 0)

Optional. Offset value is used to exclude the first set of records from the result

order_by: Array<

OrderByChoices

Optional

Ordering fields and directions.

search: string

Optional

Search through which value

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<{ created_at, functions, functions_deploy_status, 4 more... }>

Objects

Request example

curl https://api.gcore.com/cloud/v1/faas/namespaces/$PROJECT_ID/$REGION_ID \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "count": 1,
  "results": [
    {
      "created_at": "2023-08-22T11:21:00Z",
      "functions": [
        {
          "id": "c8a920ad-b5a4-47d5-b8b9-0e6c35cd800f",
          "autoscaling": {
            "max_instances": 2,
            "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.",
          "endpoint": "https://example.com/function-name",
          "flavor": "64m-64MB",
          "main_method": "run",
          "name": "function-name",
          "runtime": "python3.7.12",
          "status": "Running",
          "timeout": 5,
          "enable_api_key": true,
          "envs": {
            "ENV_VAR": "value"
          }
        }
      ],
      "functions_deploy_status": {
        "deployed": 1
      },
      "name": "namespace-name",
      "status": "Active",
      "description": "This is a sample namespace.",
      "envs": {
        "ENV_VAR": "value"
      }
    }
  ]
}

Change Namespace -> { tasks }

patch/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}

Change namespace

Domain types

OrderByChoices = "created_at.asc" | "created_at.desc" | "name.asc" | 1 more...

Function As A Service Namespaces

Functions

function_as_a_service.namespaces.functions

Methods

Create Function -> { tasks }

post/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions

Create function

Delete Function -> { tasks }

delete/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}

Delete function

Get Function -> { id, autoscaling, build_message, 15 more... }

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

Get function

Get Function Logs -> { logs }

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

Path Parameter: project_id (int) -- Project ID region_id (int) -- Region ID namespace_name (str) -- Namespace name function_name (str) -- Function name

Query Parameter: limit (int) -- Optional. Log line limit

HTTP 200 Response: logs (LogsSchema) -- Function logs

Error Response: 404 -- Resource not found

Tags: Function-as-a-Service

Security: Bearer

List Functions -> OffsetPage<{ id, autoscaling, build_message, 15 more... }>

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

List functions

Change Function -> { tasks }

patch/v1/faas/namespaces/{project_id}/{region_id}/{namespace_name}/functions/{function_name}

Change function