Skip to main content

Invoke cloud function

POST 
/v1/functions/:name

Invoke the specified cloud function.

Function invocation permissions are subject to cloud function security rules and identity authentication. Ensure the requesting identity has the required permissions to invoke the target cloud function.

For cloud function security rules, see Cloud Function Security Rules.

💡 Tip: If function invocation is blocked by security rules, you may encounter the error code: EXCEED_AUTHORITY

💡 Tip: If function invocation is blocked by the identity authentication mechanism, you may encounter the error code: ACTION_FORBIDDEN

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]$

    Name of the function to invoke

Query Parameters

    webfn string

    Possible values: [true]

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

Header Parameters

    X-Qualifier string

    Specify the function version to invoke. If omitted, the request follows the canary release rules.

    X-Tcb-Webfn string

    Possible values: [true]

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

Body

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

    property name* any

Responses​

Returned when the invocation succeeds

Response Headers
  • X-Request-Id string

    Request ID

Schema
    property name* any
Loading...