所有页面
由 GitBook 提供支持
1 / 35

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Client 类

命名空间和模块:tencent.cloud.serverless.functions

简要

代表无服务器云函数产品客户端的类。利用该类,您可以以同步或异步面向对象编程的方式快速、安全地与无服务器云函数产品交互。

继承:tencent.cloud.serverless.functions.client.AbstractClient 类

兼容性

从产品软件包 tencent-cloud-sdk-serverless-functions 的 0.1.3 版本开始,无服务器云函数产品客户端类型将不再继承自 BaseClient,而是 UniversalClient。

  • tencent.cloud.serverless.functions.Client 类

    • tencent.cloud.serverless.functions.client.AbstractClient 类

      • tencent.cloud.core.client.UniversalClient

构造

该类仅支持构造类实例后使用,构造实例方法继承自父类,其构造实例方法签名如下:

构造实例方法参数和参数描述如下:

兼容性

请注意,对于 Tencent Cloud SDK for Python 0.1.3 或更低版本,参数名称为:

值得注意的是,旧版本除参数名称不同外,与新版本中的参数数据类型和行为是一致的。

属性

该类型的实例包含可被公开访问的属性有:

兼容性

该类型部分可被公开访问的属性可能需要最新的 Tencent Cloud SDK for Python 版本:

示例

在下文中我们将向您演示如何构造一个无服务器云函数产品客户端类实例:

适用于

Tencent Cloud SDK for Python

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

class Client(client.AbstractClient)
类
  • tencent.cloud.core.client.BaseClient 类

是

当前无服务器云函数产品客户端实例所绑定的一个或多个代理服务器配置实例。如果需要修改代理服务器配置,请使用 方法。

请注意,如果当前无服务器云函数产品客户端未设置代理服务器配置,该属性默认值为 None。

参数

类型

必选

描述

access_credentials

Credentials

否

访问凭据类实例。如果该参数被忽略或设置为 None,默认设置为环境凭据或文件凭据。

access_proxies

Proxies

否

代理服务器配置类实例。如果该参数被忽略或设置为 None,默认不使用任何代理服务器。

文档中的参数名

旧的参数名

类型一致

行为一致

access_credentials

credentials_context

是

是

access_proxies

proxies_context

是

是

属性

类型

只读

描述

error_manager

ErrorManager

是

当前无服务云函数产品客户端实例的错误管理器实例。借助错误管理器,您可以自定义对感兴趣地错误的处理方式。

credentials

Credentials

是

当前无服务器云函数产品客户端实例所绑定的访问凭据实例。

proxies

属性

软件包

版本要求

error_manager

tencent-cloud-sdk-core

>= 0.1.2

credentials

tencent-cloud-sdk-core

>= 0.1.2

proxies

tencent-cloud-sdk-core

>= 0.1.3

UniversalClient 类

Proxies

bind_routine 方法

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

简要

将给定无服务器云函数的指定例程绑定在另一个 Python 原生同步或异步函数上。之后对被绑定的 Python 原生同步或异步函数的调用将被重定向为对给定无服务器云函数例程的调用。

该方法是一个装饰器,您应该以 Python 装饰器语法使用它,否则行为是未定义的。

使用例程组织无服务器云函数

参数

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

返回值

该方法返回装饰器处理器函数实例。

被绑定的 Python 原生函数被调用时将在内部调用方法 routine_invoke 实现对给定无服务器云函数的调用,其被绑定的 Python 原生函数的返回值与方法 routine_invoke 的返回值一致。

异常

该方法预期行为不会主动引发任何异常。

示例

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

适用于

Tencent Cloud SDK for Python

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

def __init__(self,
    access_credentials: credentials.Credentials = None,
    access_proxies: proxies.Proxies = None
)
from tencent.cloud.auth import credentials
from tencent.cloud.serverless import functions

# Please replace with your access credentials

access_credentials = credentials.Credentials(
    secret_id = 'AKIDF3sMOAU1pOgkmrKHchX6TZQ1Mo1C5qa7',
    secret_key = 'b4JL8fwxkIgsKMXGi39yYt0ECxZw4wZf'
)

function_client: functions.Client = functions.Client(
    access_credentials = access_credentials,
    access_proxies = None
)
def bind_routine(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_version: str = None,
    function_async: bool = False,
    routine_name: str = None
) -> object
set_access_proxies

是

绑定的无服务器云函数名称。

例如:arithmetic

function_version

str

否

绑定的无服务器云函数版本名称。

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

function_async

bool

否

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

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

routine_name

str

否

绑定的无服务器云函数的例程名称。

如果该参数被忽略或设置为 None,默认为绑定的 Python 原生同步或异步函数的名称。

参数

类型

必选

描述

region_id

str

是

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

例如:ap-shanghai

namespace_name

str

是

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

例如:default

function_name

routine_invoke 方法

str

@function_client.bind_routine(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'arithmetic'
)
def addend(
    value1: int,
    value2: int
) -> int:
    raise NotImplementedError

return_value: int = addend(
    value1 = 10,
    value2 = 20
)

schedule_invoke 方法

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

简要

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

参数

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

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

返回值

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

异常

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

ValueError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

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

是

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

function_event

dict

否

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

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

function_version

str

否

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

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

function_async

bool

否

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

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

invoke_timestamp

int

否

计划调用给定无服务器云函数的本机 UNIX 时间戳。 如果该参数被忽略或设置为 None,默认位于当前本机 UNIX 时间戳 3 秒钟后。

invoked_callback

function

否

计划调用的无服务器云函数调用完成回调函数实例。如果该参数被忽略或设置为 None,给定无服务器云函数调用结果将被丢弃。

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

str

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

get_function_results 方法

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

简要

获取给定无服务器云函数的运行结果,该方法将尝试检索符合条件的所有运行结果记录。

参数

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

返回值

该方法返回一个用于遍历获取符合过滤条件的无服务器云函数运行结果的生成器实例,生成器实例每次迭代返回包含无服务器云函数运行结果的字典实例,其数据类型为 。

该方法在内部维护一个缓冲循环,每次使用 Tencent Cloud API 检索并获取 100 条符合条件的无服务器云函数运行结果。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

def get_function_results(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    requirement_context: dict = None,
    function_version: str = None
) -> object

是

获取的无服务器云函数名称。

requirement_context

否

过滤符号条件的无服务器云函数运行结果的过滤器上下文字典实例。

function_version

str

否

获取的无服务器云函数的版本名称。如果该参数被忽略或设置为 None,默认为最新版本。

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

FunctionResult

str

function_results = function_client.get_function_results(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    requirement_context = {
        'type': functions.FunctionResultType.Succeed
    },
    function_version = '1'
)

# Don't worry, this method won't retrieve and get
# all the running results at this time.

for result in function_results:
    print(result['request_id'])
FunctionResultFilter

create_function 方法

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

简要

调用给定无服务器云函数并获得无服务器云函数的运行结果。

参数

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

返回值

该方法返回可等待操作对象,这将允许您等待无服务器云函数资源真正地创建完成。

兼容性

在 Tencent Cloud SDK for Python 0.1.6 或更低版本中,该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

def create_function(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_description: str,
    function_code: FunctionCode,
    function_runtime: str = 'Python3',
    function_type: str = None,
    function_configure: dict = None
)

是

创建的无服务器云函数名称。

function_description

str

否

创建的无服务器云函数描述正文。

function_code

是

创建的无服务器云函数代码实例。

function_runtime

str

否

创建的无服务器云函数运行时名称。如果该参数被忽略,默认运行时为 Python3。建议使用 枚举器成员。

function_type

str

否

创建的无服务器云函数类型。如果该参数被忽略,默认类型为 Event。建议使用 枚举器成员。

function_configure

否

创建的无服务器云函数配置。如果该参数被忽略或设置为 None,被创建的函数将采用默认配置。

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

Waitable 类

str

select_routine 方法

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

简要

选择一个给定无服务器云函数的指定例程并返回给定无服务器云函数例程的 Python 原生函数实例。对该函数实例的调用等同于对给定无服务器云函数例程的调用,其关键字参数将作为给定无服务器云函数例程的关键字参数。

使用例程组织无服务器云函数

参数

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

返回值

该方法返回给定无服务器云函数例程的 Python 原生函数实例。

返回的函数实例将在内部调用方法 routine_invoke 实现对给定无服务器云函数例程的调用,其函数实例的返回值与方法 routine_invoke 的返回值一致。

异常

该方法预期行为不会主动引发任何异常。

示例

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

适用于

Tencent Cloud SDK for Python

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

easy_invoke 方法

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

简要

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

参数

function_client.create_function(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_description = 'Addition function',
    function_code = functions.FunctionCode().use_object_storage_bucket(
        region_id = 'ap-shanghai-1',
        bucket_id = 'scf-code',
        object_name = 'source.zip'
    ),
    function_runtime = functions.FunctionRuntime.Python,
    function_type = functions.FunctionType.Event,
    function_configure = {
        'handler': 'index.main',
        'memory_size': 128,
        'time_out': 3
    }
)
def select_routine(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    routine_name: str,
    function_version: str = None,
    function_async: bool = False
)
FunctionCode
FunctionRuntime
FunctionType
FunctionConfigure

是

选择的无服务器云函数名称。

例如:arithmetic

routine_name

str

是

选择的无服务器云函数的例程的名称。

例如:addend

function_version

str

否

选择的无服务器云函数版本名称。

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

function_async

bool

否

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

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

参数

类型

必选

描述

region_id

str

是

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

例如:ap-shanghai

namespace_name

str

是

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

例如:default

function_name

routine_invoke 方法

str

addend = function_client.select_routine(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'arithmetic',
    routine_name = 'addend'
)

return_value: int = addend(
    value1 = 10,
    value2 = 20
)
该方法的参数和参数描述如下:

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

返回值

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

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

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

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

异常

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

ValueError

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

InvokeError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

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
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
)

str

是

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

function_event

dict

否

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

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

function_version

str

否

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

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

function_async

bool

否

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

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

bind_function 方法

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

简要

将给定无服务器云函数绑定在另一个 Python 原生函数、类方法或类实例方法上。之后对被绑定可调用对象的调用将被重定向为对给定无服务器云函数的调用。

该方法是一个装饰器,您应该以 Python 装饰器语法使用它,否则行为是未定义的。

参数

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

返回值

该方法返回装饰器处理器函数实例。

被绑定可调用对象被调用时将在内部调用方法 实现对给定无服务器云函数的调用,其被绑定可调用对象的返回值与方法 的返回值一致。

异常

该方法预期行为不会主动引发任何异常。

示例

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

适用于

Tencent Cloud SDK for Python

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

def bind_function(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_version: str = None,
    function_async: bool = False,
    include_attributes: list = None
) -> object

是

绑定的无服务器云函数名称。

function_version

str

否

绑定的无服务器云函数版本名称。

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

function_async

bool

否

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

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

include_attributes

list<str>

否

需要包含当前实例的属性名称列表实例,这些属性将被优先添加到绑定的无服务器云函数调用事件。如果被绑定的可调用对象不是类方法或类实例方法,该参数将被忽略。

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

easy_invoke
easy_invoke

str

@function_client.bind_function(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_version = '1',
    function_async = False,
    include_attributes = None
)
def addend(
    value1: int,
    value2: int
) -> int:
    raise NotImplementedError

return_value: int = addend(
    value1 = 10,
    value2 = 20
)

select_function 方法

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

简要

选择一个无服务器云函数并返回给定无服务器云函数的 Python 原生函数实例。对该函数实例的调用等同于对给定无服务器云函数的调用,其关键字参数将作为给定无服务器云函数的事件。

参数

routine_invoke 方法

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

简要

调用给定无服务器云函数的指定例程,并获取例程的实际返回值。

参数

delete_function 方法

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

简要

删除一个已创建的给定无服务器云函数。

参数

run_schedule 方法

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

简要

运行所有已创建的定时无服务器云函数调用任务,直到没有仍未调用的定时任务存在时该方法返回。这些任务通常由实例方法 创建。

请注意,该方法仅适用于同步编程方式,异步编程方式无需手动调用该方法。

兼容性

该实例方法在产品软件包 tencent-cloud-sdk-serverless-functions - 0.1.2 版本中新增。如果产品软件包低于适用版本,应该使用底层级 API 模拟实现:

否则,已创建的定时无服务器云函数调用任务可能永远不会被运行。

参数

该方法没有参数。

返回值

该方法没有返回值。

异常

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

StatusError

没有已创建的定时调用任务需要运行或正在运行。

示例

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

适用于

Tencent Cloud SDK for Python

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

schedule_invoke
def run_schedule(self)
function_client.get_event_loop().run_forever()
function_client.run_schedule()
该方法的参数和参数描述如下:

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

返回值

该方法返回给定无服务器云函数的 Python 原生函数实例。

返回的函数实例将在内部调用方法 easy_invoke 实现对给定无服务器云函数的调用,其函数实例的返回值与方法 easy_invoke 的返回值一致。

异常

该方法预期行为不会主动引发任何异常。

示例

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

适用于

Tencent Cloud SDK for Python

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

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

参数

类型

必选

描述

region_id

str

是

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

例如:ap-shanghai

namespace_name

str

是

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

例如:default

function_name

返回值

该方法返回给定无服务器云函数的指定例程调用的实际返回值。返回值视参数的值不同而异,详情请参阅方法 easy_invoke 的返回值描述。

异常

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

ValueError

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

InvokeError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

使用例程组织无服务器云函数
easy_invoke 方法
该方法的参数和参数描述如下:

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

def select_function(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_version: str = None,
    function_async: bool = False
) -> function
addend = function_client.select_function(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_version = '1',
    function_async = False
)

return_value: int = addend(
    value1 = 10,
    value2 = 20
)
def routine_invoke(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    routine_name: str,
    routine_parameter: dict = None,
    function_version: str = None,
    function_async: bool = False
) -> object
return_value: int = function_client.routine_invoke(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'arithmetic',
    routine_name = 'addend',
    routine_parameter = {
        'value1': 10,
        'value2': 20
    }
)
def delete_function(self,
    region_id: str,
    namespace_name: str,
    function_name: str
)
function_client.delete_function(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend'
)

str

是

选择的无服务器云函数名称。

function_version

str

否

选择的无服务器云函数版本名称。

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

function_async

bool

否

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

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

str

是

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

例如:arithmetic

routine_name

str

是

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

例如:addend

routine_parameter

dict

否

调用的无服务器云函数关键字参数。

例如:{ 'value1': 10, 'value2': 20 }

function_version

str

否

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

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

function_async

bool

否

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

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

str

是

删除的无服务器云函数名称。

invoke 方法

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

简要

调用给定无服务器云函数并获得无服务器云函数的运行结果。

参数

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

返回值

返回包含给定无服务器云函数运行结果的字典实例,其数据类型为 。

异常

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

ValueError

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

InvokeError

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

ActionError

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

ActionResultError

Tencent Cloud API 返回结果是非预期的,该异常通常情况下不会引发。

示例

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

适用于

Tencent Cloud SDK for Python

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

update_function_configure 方法

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

简要

更新给定无服务器云函数的配置。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

get_function_info 方法

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

简要

获取给定无服务器云函数的基本信息。

参数

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

返回值

返回包含给定无服务器云函数基本信息的字典实例,其数据类型为 。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

get_function_result_by_request_id 方法

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

简要

获取给定无服务器云函数指定 Request ID 的运行结果。

参数

update_function_code 方法

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

简要

更新给定无服务器云函数的源代码。

参数

copy_function 方法

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

简要

为给定无服务器云函数创建一个拷贝副本函数。

参数

def invoke(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_event: dict = None,
    function_version: str = None,
    function_async: bool = False
) -> dict
def update_function_configure(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_description: str = None,
    function_configure: dict = None
)
def get_function_info(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_version: str = None
) -> dict

是

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

function_event

dict

否

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

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

function_version

str

否

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

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

function_async

bool

否

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

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

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

FunctionResult

str

是

获取的无服务器云函数名称。

function_version

str

否

获取的无服务器云函数版本名称。

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

FunctionInfoEx

str

return_result: str = function_client.invoke(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_event = {
        'value1': 10,
        'value2': 20
    },
    function_version = '1',
    function_async = False
)
function_info: dict = function_client.get_function_info(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_version = '1'
)

是

更新的无服务器云函数名称。

function_description

str

否

更新的无服务器云函数描述正文。如果该参数被忽略或设置为 None,默认不更新描述正文。

function_configure

否

更新的无服务器云函数配置字典实例。如果该参数被忽略或设置为 None,默认不更新函数配置。

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

str

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

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

返回值

该方法返回给定无服务器云函数指定 Request ID 的运行结果字典实例,其数据类型为 FunctionResult。

异常

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

ValueError

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

ActionError

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

NotFoundError

给定无服务器云函数的 Request ID 无效或未找到运行结果。如果 Request ID 有效,则给定无服务器云函数可能还在运行或运行结果仍未完成收集。

示例

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

适用于

Tencent Cloud SDK for Python

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

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

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

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

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

publish_function_version 方法

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

简要

为给定无服务器云函数发布一个新的版本。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

create_namespace 方法

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

简要

创建一个新的命名空间。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

Tencent Cloud API 错误。例如访问凭据无效、给定命名空间已存在等均会引发该异常。

示例

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

适用于

Tencent Cloud SDK for Python

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

create_trigger 方法

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

简要

为给定无服务器云函数创建一个触发器。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

list_function_versions 方法

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

简要

获取给定无服务器云函数的所有版本信息。

参数

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

返回值

该方法返回一个用于遍历获取无服务器云函数版本信息的生成器实例,生成器实例每次迭代返回包含无服务器云函数版本信息的字典实例,其数据类型为 。

由于 Tencent Cloud API 不支持分页游标检索并获取,因此该方法将尝试一次性获取无服务器云函数的所有版本信息。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

delete_trigger 方法

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

简要

将给定触发器从指定无服务器云函数上删除。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

update_namespace 方法

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

简要

更新给定命名空间的基本信息。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

Tencent Cloud API 错误。例如访问凭据无效、给定命名空间已存在等均会引发该异常。

示例

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

适用于

Tencent Cloud SDK for Python

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

list_functions 方法

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

简要

获取给定命名空间内的无服务器云函数基本信息,该方法将尝试检索符合条件的无服务器云函数项。

参数

get_layer_info 方法

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

简要

获取一个已创建层的指定层版本的信息。

参数

function_client.update_function_configure(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_description = 'New function description',
    function_configure = {
        'memory_size': 256
    }
)
def get_function_result_by_request_id(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_request_id: str,
    function_version: str = None
) -> dict
function_client.get_function_result_by_request_id(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_request_id = 'effae55e-480e-11ea-b078-5254007aa7a1',
    function_version = '1'
)
def update_function_code(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_code: FunctionCode,
    function_handler: str
)
function_client.update_function_code(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_code = functions.FunctionCode().use_object_storage_bucket(
        region_id = 'ap-shanghai-1',
        bucket_id = 'scf-code',
        object_name = 'source.zip'
    ),
    function_handler = 'index.main'
)
def copy_function(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    target_region_id: str,
    target_namespace_name: str,
    target_function_name: str,
    allow_override: bool = False,
    copy_configure: bool = True
)
function_client.copy_function(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    target_region_id = 'ap-guangzhou',
    target_namespace_name = 'default',
    target_function_name = 'addend',
    allow_override = True,
    copy_configure = True
)
def publish_function_version(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    version_description: str = None
)
def create_namespace(self,
    region_id: str,
    namespace_name: str,
    namespace_description: str = None
)
def create_trigger(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_trigger: FunctionTrigger,
    function_version: str = None
)
def list_function_versions(self,
    region_id: str,
    namespace_name: str,
    function_name: str
) -> object
def delete_trigger(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_trigger: FunctionTrigger,
    function_version: str = None
)
def update_namespace(self,
    region_id: str,
    namespace_name: str,
    namespace_description: str
)

str

是

获取的无服务器云函数名称。

function_request_id

str

是

获取的无服务器云函数 Request ID 字符串。

function_version

str

否

获取的无服务器云函数的版本名称。如果该参数被忽略或设置为 None,默认为最新版本。

str

是

更新的无服务器云函数名称。

function_code

FunctionCode

是

更新的无服务器云函数代码实例。

function_handler

str

是

更新的无服务器云函数的入口函数符号名。

str

是

当前无服务器云函数名称。

target_region_id

str

是

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

target_namespace_name

str

是

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

target_function_name

str

是

目标无服务器云函数名称。

allow_override

bool

否

如果目标无服务器云函数已存在,是否允许将其覆盖。如果该参数被忽略或设置为 None,默认不允许覆盖。

copy_configure

bool

否

是否将当前无服务器云函数配置拷贝给目标无服务器云函数。如果该参数被忽略或设置为 None,默认不拷贝当前函数配置。

FunctionConfigure

是

发布的无服务器云函数名称。

version_description

str

否

发布的无服务器云函数版本的描述正文。

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

str

否

创建的命名空间描述正文。

参数

类型

必选

描述

region_id

str

是

创建的命名空间所在数据中心的唯一标识符。

namespace_name

str

是

创建的命名空间名称。

namespace_description

str

是

获取的无服务器云函数名称。

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

FunctionVersionInfo

str

是

更新的命名空间描述正文。

参数

类型

必选

描述

region_id

str

是

更新的命名空间所在数据中心的唯一标识符。

namespace_name

str

是

更新的命名空间名称。

namespace_description

str

function_client.publish_function_version(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    version_description = 'New addition calculation function version'
)
function_client.create_namespace(
    region_id = 'ap-shanghai',
    namespace_name = 'test',
    namespace_description = 'New namespace'
)
function_version_set = function_client.list_function_versions(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend'
)

for info in function_version_set :
    print(info['name'])
function_client.update_namespace(
    region_id = 'ap-shanghai',
    namespace_name = 'test',
    namespace_description = 'Update namespace'
)

是

创建触发器的无服务器云函数名称。

function_trigger

是

代表无服务器云函数触发器配置的 FunctionTrigger 实例。

function_version

str

否

创建触发器的无服务器云函数版本名称。

参数

类型

必选

描述

region_id

str

是

创建触发器的无服务器云函数所在数据中心的唯一标识符。

namespace_name

str

是

创建触发器的无服务器云函数所在命名空间的名称。

function_name

str

是

删除触发器的无服务器云函数名称。

function_trigger

是

代表无服务器云函数触发器配置的 FunctionTrigger 实例。

function_version

str

否

删除触发器的无服务器云函数版本名称。

参数

类型

必选

描述

region_id

str

是

删除触发器的无服务器云函数所在数据中心的唯一标识符。

namespace_name

str

是

删除触发器的无服务器云函数所在命名空间的名称。

function_name

str

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

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

requirement_context

返回值

该方法返回一个用于遍历获取符合过滤条件的无服务器云函数基本信息的生成器实例,生成器实例每次迭代返回包含无服务器云函数基本信息的字典实例,其数据类型为 FunctionInfo。

该方法在内部维护一个缓冲循环,每次使用 Tencent Cloud API 检索并获取 100 条符合条件的无服务器云函数运行结果。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

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

参数

类型

必选

描述

region_id

str

是

层的数据中心唯一标识符。

例如:ap-shanghai

layer_name

str

是

层的唯一名称。

例如:default

layer_version

返回值

该方法返回包含层信息的字典实例,其数据类型为 LayerInfo。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

list_namespaces 方法

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

简要

获取给定数据中心已创建的命名空间基本信息。

参数

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

返回值

该方法返回一个用于遍历获取命名空间基本信息的生成器实例,生成器实例每次迭代返回包含命名空间基本信息的字典实例,其数据类型为 。

该方法在内部维护一个缓冲循环,每次使用 Tencent Cloud API 检索并获取 20 条符合条件的无服务器云函数运行结果。

异常

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

ValueError

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

ActionError

Tencent Cloud API 错误。例如访问凭据无效、给定命名空间不存在等均会引发该异常。

示例

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

适用于

Tencent Cloud SDK for Python

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

get_function_code_download_url 方法

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

简要

获取给定无服务器云函数的源代码 ZIP 档案下载 URL 字符串。

参数

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

返回值

返回给定无服务器云函数的源代码 ZIP 档案下载 URL 字符串。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

delete_namespace 方法

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

简要

将给定命名空间删除。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

Tencent Cloud API 错误。例如访问凭据无效、给定命名空间不存在等均会引发该异常。

示例

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

适用于

Tencent Cloud SDK for Python

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

download_function_code 方法

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

简要

下载给定无服务器云函数的源代码 ZIP 档案文件到本机硬盘。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

submit_monitor_indicator 方法

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

简要

向 Tencent Cloud 云监控产品上报给定无服务器云函数的自定义监控指标数据。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

create_layer 方法

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

简要

创建一个新层或已存在层的新版本。

参数

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

返回值

该方法返回可等待操作对象,这将允许您等待层或层版本资源真正地创建完成。返回的可等待对操作对象包含操作结果,其指示新创建的层或层版本的版本编号。

兼容性

在 Tencent Cloud SDK for Python 0.1.6 或更低版本中,该方法返回新创建的层或层版本的版本编号。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

list_layer_versions 方法

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

简要

获取已创建就绪的层的所有层版本信息。

参数

delete_layer 方法

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

简要

删除一个已创建就绪的层或层的指定版本。

参数

list_layers 方法

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

简要

获取已创建的所有层的最新层版本信息。

参数

function_client.create_trigger(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_trigger = functions.FunctionTrigger().use_timer(
        timer_name = 'default',
        timer_cron = '* * * * *'
    ),
    function_version = '1'
)
function_client.delete_trigger(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_trigger = functions.FunctionTrigger().use_timer(
        timer_name = 'default',
        timer_cron = '* * * * *'
    ),
    function_version = '1'
)
def list_functions(self,
    region_id: str,
    namespace_name: str,
    requirement_context: dict = None
) -> object
function_set = function_client.list_functions(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    requirement_context = {
        'search': {
            'function_name': 'add'
        }
    }
)

for info in function_set:
    print(info['name'])
def get_layer_info(self,
    region_id: str,
    layer_name: str,
    layer_version: int
) -> dict
layer_info: dict = function_client.get_layer_info(
    region_id = 'ap-shanghai',
    layer_name = 'default',
    layer_version = 1
)
def list_namespaces(self,
    region_id: str
)
def get_function_code_download_url(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_version: str = None
) -> dict
def delete_namespace(self,
    region_id: str,
    namespace_name: str
)
def download_function_code(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    function_version: str = None,
    download_file_name: str = None
) -> dict
def submit_monitor_indicator(self,
    region_id: str,
    namespace_name: str,
    function_name: str,
    indicator_name: str,
    indicator_value: int,
    function_version: str = None
)
def create_layer(self,
    region_id: str,
    layer_name: str,
    layer_description: str,
    layer_content: LayerContent,
    layer_runtimes: list,
    layer_license: str = None
) -> int

FunctionFilter

否

包含检索过滤条件的字典实例。

int

是

层的版本编号。

例如:1

FunctionTrigger
FunctionTrigger

参数

类型

必选

描述

region_id

str

是

获取的命名空间所在数据中心的唯一标识符。

NamespaceInfo

是

获取的无服务器云函数名称。

function_version

str

否

获取的无服务器云函数版本名称。

参数

类型

必选

描述

region_id

str

是

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

namespace_name

str

是

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

function_name

str

参数

类型

必选

描述

region_id

str

是

创建的命名空间所在数据中心的唯一标识符。

namespace_name

str

是

创建的命名空间名称。

是

下载源代码的无服务器云函数名称。

function_version

str

否

下载源代码的无服务器云函数版本名称。

download_file_name

str

否

存储源代码 ZIP 档案的本机文件名。如果该参数被忽略或设置为 None,默认下载到当前工作目录,文件名以 function-code-{FUNCTION_NAME}-{FUNCTION_VERSION}.zip 命名。

参数

类型

必选

描述

region_id

str

是

下载源代码的无服务器云函数所在数据中心的唯一标识符。

namespace_name

str

是

下载源代码的无服务器云函数所在命名空间的名称。

function_name

str

是

无服务器云函数的唯一名称。

例如:hello

indicator_name

str

是

上报的自定义指标唯一名称。

例如:number_of_invokes

indicator_value

int

是

上报的自定义指标对应的数据值。

例如:1

function_version

str

否

无服务器云函数版本唯一名称。

例如:$LATEST

参数

类型

必选

描述

region_id

str

是

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

例如:ap-shanghai

namespace_name

str

是

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

例如:default

function_name

str

for namespace_info in function_client.list_namespaces(
    region_id = 'ap-shanghai'
):
    print(namespace_info['name'])
download_url: str = function_client.get_function_code_download_url(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_version = '1'
)
function_client.delete_namespace(
    region_id = 'ap-shanghai',
    namespace_name = 'test',
)
download_url: str = function_client.download_function_code(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'addend',
    function_version = '1',
    download_file_name = './source.zip'
)
function_client.submit_monitor_indicator(
    region_id = 'ap-shanghai',
    namespace_name = 'default',
    function_name = 'hello',
    indicator_name = 'number_of_invokes',
    indicator_value = 1
)

是

创建的层的描述正文。

例如:default layer

layer_content

是

包含创建的层的数据的 LayerContent 实例。

例如:LayerContent().use_local_zip_archive(...)

layer_runtimes

list

是

包含创建的层兼容的无服务器云函数运行时名称的列表实例。

例如:[ FunctionRuntime.Python ]

layer_license

str

否

创建的层的许可正文。

例如:default license

参数

类型

必选

描述

region_id

str

是

创建层的数据中心唯一标识符。

例如:ap-shanghai

layer_name

str

是

创建的层的唯一名称。

例如:default

layer_description

Waitable 类

str

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

参数

类型

必选

描述

region_id

str

是

获取的层的数据中心唯一标识符。

例如:ap-shanghai

layer_name

str

时

获取的层的唯一名称。

requirement_context

返回值

该方法返回一个用于遍历获取符合过滤条件的层信息的生成器实例,生成器实例每次迭代返回包含层信息的字典实例,其数据类型为 LayerInfo。

请注意,由于该方法背后的 Tencent Cloud API 不支持分页检索,该方法将试图一次性获取所有符合条件的层信息。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

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

参数

类型

必选

描述

region_id

str

是

删除的层的数据中心唯一标识符。

例如:ap-shanghai

layer_name

str

是

删除的层的唯一名称。

例如:default

layer_version

兼容性

在 Tencent Cloud SDK for Python 0.1.6 或更低版本中,参数 layer_version 必须提供。

返回值

该方法没有返回值。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

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

参数

类型

必选

描述

region_id

str

是

层的数据中心唯一标识符。

例如:ap-shanghai

requirement_context

dict

否

包含层过滤器上下文的字典实例,其数据类型为 。

返回值

该方法返回一个用于遍历获取符合过滤条件的层信息的生成器实例,生成器实例每次迭代返回包含层信息的字典实例,其数据类型为 LayerInfo。

该方法在内部维护一个缓冲循环,每次使用 Tencent Cloud API 检索并获取 20 条符合条件的层信息。

异常

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

ValueError

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

ActionError

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

示例

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

适用于

Tencent Cloud SDK for Python

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

layer_version: int = functions_client.create_layer(
    region_id = 'ap-shanghai',
    layer_name = 'default',
    layer_description = 'default layer',
    layer_content = functions.LayerContent().use_local_zip_archive(
        local_file_path = './layer-data.zip'
    ),
    layer_runtimes = [
        functions.FunctionRuntime.Python,
        functions.FunctionRuntime.Java
    ],
    layer_license = 'default license'
).result
def list_layer_versions(self,
    region_id: str,
    layer_name: str,
    requirement_context: dict = None
)
for layer_info in function_client.list_layer_versions(
    region_id = 'ap-shanghai',
    layer_name = 'default'
):
    print(layer_info['version'])
def delete_layer(self,
    region_id: str,
    layer_name: str,
    layer_version: int = None
)
function_client.delete_layer(
    region_id = 'ap-shanghai',
    layer_name = 'default',
    layer_version = 1
)
def list_layers(self,
    region_id: str,
    requirement_context: dict = None
)
for layer_info in function_client.list_layers(
    region_id = 'ap-shanghai'
):
    print(layer_info['name'])

dict

否

包含层过滤器上下文的字典实例,其数据类型为 LayerFilter。

int

否

删除的层的版本编号。 如果该参数被忽略或设置为 None,默认批量删除所有层版本。

例如:1

LayerContent
LayerFilter