schedule_invoke 方法

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

简要

计划在给定本机 UNIX 时间戳调用给定无服务器云函数。

def schedule_invoke(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_event: dict = None,
    function_version: str = None,
    function_async: bool = False,
    invoke_timestamp: int = None,
    invoked_callback: object = None
) -> FunctionSchedule

参数

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

参数	类型	必选	描述
region_id	str	是	计划调用的无服务器云函数所在数据中心的唯一标识符。
namespace_name	str	是	计划调用的无服务器云函数所在命名空间的名称。
function_name	str	是	计划调用的无服务器云函数名称。
function_event	dict	否	计划调用的无服务器云函数事件。 如果该参数被忽略或设置为 None，默认传递空事件。
function_version	str	否	计划调用的无服务器云函数版本名称。 如果该参数被忽略或设置为 None，默认调用最新版本。
function_async	bool	否	计划调用的无服务器云函数是否以异步的方式运行。 如果该参数被忽略或设置为 None，默认以同步方式运行。
invoke_timestamp	int	否	计划调用给定无服务器云函数的本机 UNIX 时间戳。 如果该参数被忽略或设置为 None，默认位于当前本机 UNIX 时间戳 3 秒钟后。
invoked_callback	function	否	计划调用的无服务器云函数调用完成回调函数实例。如果该参数被忽略或设置为 None，给定无服务器云函数调用结果将被丢弃。

请注意，参数 invoke_timestamp 给定的 UNIX 时间戳必须与本机时间同步，否则实际调用给定无服务器云函数的时间可能与预期不同。

返回值

该方法返回代表给定无服务器云函数计划调用任务的 FunctionSchedule 类实例。如果参数 invoked_callback 被设置为有效的函数实例，其函数实例回调时将传入该方法的返回值。

异常

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

ValueError

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

示例

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

import time

def schedule_callback(
    schedule_task: functions.FunctionSchedule
):
    if not schedule_task.is_successful:
        raise schedule_task.exception
    
    print(schedule_task.return_value)
    print(schedule_task.result)

schedule_task = function_client.schedule_invoke(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_event = {
        'value1': 10,
        'value2': 20
    },
    function_version = '1',
    function_async = False,
    invoke_timestamp = int(time.time()) + 5,
    invoked_callback = schedule_callback
)

# schedule_task.cancel()    # Cancel schedule

适用于

Tencent Cloud SDK for Python

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