Invoke Cloud Function

POST 
/v1/functions/:name

Invoke the specified cloud function.

Request

Path Parameters

name stringrequired

Possible values: Value must match regular expression ^[a-zA-Z][a-zA-Z0-9_-]{0,58}[a-zA-Z0-9]$

The name of the function to be invoked

Query Parameters

webfn string

Possible values: [true]

Set to true when invoking a web function. Choose either this parameter or the header parameter X-Tcb-Webfn=true.

Header Parameters

X-Qualifier string

Specifies the function version to invoke. If not provided, the function will be invoked according to grayscale rules.

X-Tcb-Webfn string

Possible values: [true]

Set to true when invoking a web function. Choose either this header or the query parameter webfn=true.

application/json

Body

Request parameters for invoking the function. The request parameters must be a JSON object.

property name* any

Responses

200

Returned on success

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

property name* any

Example (from schema)

{}

Echo

echo

{
  "a": 1,
  "b": 2
}

text/plain

Schema

Schema

string

Text

text

Hello fn

400

Returned on function invocation error

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

code Error code (string)
message Error message (string)
requestId Request ID (string)

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

ExecuteFail

Function execution failed

{
  "code": "FUNCTION_PARAM_INVALID",
  "message": "bad http request body (e1xxxxxx-xxxx-xxxx-xxxx-xxxxxxf7yyyy). For more information, please refer to https://docs.cloudbase.net/error-code/service",
  "requestId": "yyxxxxxx-yyyy-yyyy-zzzz-xxxxxxzzyyyy"
}

default

General error message. See https://docs.cloudbase.net/error-code/service

Response Headers

• X-Request-Id string

  Request ID

application/json

Schema

Schema

code Error code (string)
message Error message (string)
requestId Request ID (string)

Example (from schema)

{
  "code": "string",
  "message": "string",
  "requestId": "string"
}

InvalidHost

Invalid request address

{
  "code": "INVALID_HOST",
  "message": "xxx",
  "requestId": "xxx"
}

Loading...