调用云函数

POST 
/v1/functions/:name

调用指定云函数。

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

需要调用的函数名称

Query Parameters

webfn string

Possible values: [true]

当调用的函数为 web 函数时需要指定为 true，与 header 参数 X-Tcb-Webfn=true 二选一

Header Parameters

X-Qualifier string

指定调用函数的版本，不填则按灰度规则调用

X-Tcb-Webfn string

Possible values: [true]

当调用的函数为 web 函数时需要指定为 true，与 query 参数 webfn=true 二选一

application/json

Body

调用函数的请求参数，请求参数需为 JSON 对象

property name* any

Responses

200

调用成功时返回

Response Headers

• X-Request-Id string

  请求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

函数调用出错时返回

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

code 错误码 (string)
message 错误信息 (string)
requestId 请求 ID (string)

Example (from schema)

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

ExecuteFail

函数执行失败

{
  "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

通用报错信息，详见 https://docs.cloudbase.net/error-code/service

Response Headers

• X-Request-Id string

  请求ID

application/json

Schema

Schema

code 错误码 (string)
message 错误信息 (string)
requestId 请求 ID (string)

Example (from schema)

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

InvalidHost

请求地址异常

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

Loading...