easy_invoke 方法

命名空间和类:tencent.cloud.serverless.functions.Client

简要

调用给定无服务器云函数并获得无服务器云函数的实际返回值。

def easy_invoke(self,
region_id: str,
namespace_name: str,
function_name: str,
function_event: dict = None,
function_version: str = None,
function_async: bool = False
) -> object

参数

该方法的参数和参数描述如下:

参数

类型

必选

描述

region_id

str

调用的无服务器云函数所在数据中心的唯一标识符。

namespace_name

str

调用的无服务器云函数所在命名空间的名称。

function_name

str

调用的无服务器云函数名称。

function_event

dict

调用的无服务器云函数事件。

如果该参数被忽略或设置为 None,默认传递空事件。

function_version

str

调用的无服务器云函数版本名称。

如果该参数被忽略或设置为 None,默认调用最新版本。

function_async

bool

调用的无服务器云函数是否以异步的方式运行。

如果该参数被忽略或设置为 None,默认以同步方式运行。

返回值

该方法返回值取决于参数 function_async 的值。如果该参数设置为 False,该方法返回给定无服务器云函数调用结果中的实际返回值;如果该参数设置为 True,该方法返回用于标识给定无服务器云函数调用的唯一标识符(Request ID)字符串。

实际返回值:指给定给定无服务器云函数所运行代码的真实返回值。该方法将尝试推断给定无服务器云函数运行结果中返回值的数据类型,例如给定无服务器云函数返回整形数值,该方法将返回使用 Python 原生数据类型解析包装的 Int 值。

请注意,如果以异步编程方式使用该方法,且参数 function_async 被设置为 True,该方法将返回代表给定无服务器云函数未来实际返回值的 FunctionResultFuture 类实例。

返回的 FunctionResultFuture 实例支持使用 await 关键字等待给定无服务器云函数本次调用的实际返回值。

异常

该方法可能会主动引发以下异常:

ValueError

参数值或类型不符合预期。

InvokeError

给定无服务器云函数在调用过程中遇到错误,这通常是由于无服务器云函数所运行的代码存在异常。

ActionError

Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。

示例

下面我们将通过一段 Python 代码向您演示如何使用该方法:

return_value: int = function_client.easy_invoke(
region_id = 'ap-shanghai',
namespace_name = 'default',
function_name = 'addend',
function_event = {
'value1': 10,
'value2': 20
},
function_version = '1',
function_async = False
)

适用于

Tencent Cloud SDK for Python

产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1