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...
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...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
本节将引导您进一步了解 Tencent Cloud SDK for Python 所提供的更多功能和高级特性
阅读 Tencent Cloud SDK for Python 技术文档之前,强烈建议您先阅读入门文档。
Tencent Cloud SDK for Python 建立在全异步 API 支持的基础之上,这意味着所有 API 均以异步编程方式编写。不过,我们仍为同步编程方式提供兼容 API 支持,这些适用于同步编程方式的兼容 API 将在内部调用其适用于异步编程方式的 API 版本。
适用于异步编程方式的 API 命名均以 _async
结尾。
例如我们在无服务器云函数产品客户端中使用的方法 easy_invoke,其具有适用于同步和异步编程方式共 2 个 API 版本,其方法符号名分别为:
同步编程方式:easy_invoke
异步编程方式:easy_invoke_async
在 API 文档中我们将以便于理解的同步编程方式向您介绍和演示,其适用于异步编程方式的 API 版本在行为和参数定义上与适用于同步编程方式的 API 版本一致。
请注意,适用于同步编程方式的 API 不支持在异步编程方式中使用,否则行为是未定义的。
Tencent Cloud SDK for Python 面向开发者提供低级 API 和高级 API。除非必要或拥有 API 文档的兼容性承诺,否则您应该始终使用高级 API 编写应用程序。
低级 API 通常是 Tencent Cloud SDK for Python 为面向内部高级 API 实现提供的底层 API 实现,低级 API 签名和行为可能会因 Tencent Cloud SDK for Python 的版本更新而改变甚至废止、删除,这将导致依赖低级 API 的应用程序无法在集成更高版本的 Tencent Cloud SDK for Python 时正确工作。
例如高级 API 方法 tencent.cloud.core.client.UniversalClient.action
在内部调用低级 API 方法 tencent.cloud.core.client.BaseClient._request_action_async
以实现对 Tencent Cloud API 的调用并获得结果。
请注意,如果一个高级 API 未在 API 文档中声明,表明该 API 可能是实验性的并可能会在未来的某一个版本中被废止、删除,应该谨慎在应用程序中使用。
目前 Tencent Cloud SDK for Python 面向以下 Tencent Cloud 产品提供抽象的产品客户端:
您需要集成并使用的 Tencent Cloud 产品未列出?没关系,您仍然可以使用 Tencent Cloud SDK for Python 提供的通用客户端直接快速、安全地访问 Tencent Cloud API 并获得结果,Tencent Cloud SDK for Python 将代您管理 Tencent Cloud API 身份验证和签名、底层互联网通信和请求与响应解析等实现细节:
请注意,目前 Tencent Cloud SDK for Python 所有类型均不是线程安全的。在多线程应用程序模型中,您应该在每一条超线程上下文中实例化一个或多个独立的类型实例。
命名空间和类:tencent.cloud.serverless.functions.Client
将给定无服务器云函数绑定在另一个 Python 原生函数、类方法或类实例方法上。之后对被绑定可调用对象的调用将被重定向为对给定无服务器云函数的调用。
该方法是一个装饰器,您应该以 Python 装饰器语法使用它,否则行为是未定义的。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
绑定的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
绑定的无服务器云函数所在命名空间的名称。
function_name
str
是
绑定的无服务器云函数名称。
function_version
str
否
绑定的无服务器云函数版本名称。
如果该参数被忽略或设置为 None
,默认为最新版本。
function_async
bool
否
绑定的无服务器云函数是否以异步的方式运行。
如果该参数被忽略或设置为 None
,默认以同步方式运行。
include_attributes
list<str>
否
需要包含当前实例的属性名称列表实例,这些属性将被优先添加到绑定的无服务器云函数调用事件。如果被绑定的可调用对象不是类方法或类实例方法,该参数将被忽略。
该方法返回装饰器处理器函数实例。
被绑定可调用对象被调用时将在内部调用方法 easy_invoke
实现对给定无服务器云函数的调用,其被绑定可调用对象的返回值与方法 easy_invoke
的返回值一致。
该方法预期行为不会主动引发任何异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
调用给定无服务器云函数并获得无服务器云函数的实际返回值。
该方法的参数和参数描述如下:
该方法返回值取决于参数 function_async
的值。如果该参数设置为 False
,该方法返回给定无服务器云函数调用结果中的实际返回值;如果该参数设置为 True
,该方法返回用于标识给定无服务器云函数调用的唯一标识符(Request ID)字符串。
实际返回值:指给定给定无服务器云函数所运行代码的真实返回值。该方法将尝试推断给定无服务器云函数运行结果中返回值的数据类型,例如给定无服务器云函数返回整形数值,该方法将返回使用 Python 原生数据类型解析包装的 Int 值。
请注意,如果以异步编程方式使用该方法,且参数 function_async
被设置为 True
,该方法将返回代表给定无服务器云函数未来实际返回值的 FunctionResultFuture
类实例。
返回的 FunctionResultFuture
实例支持使用 await
关键字等待给定无服务器云函数本次调用的实际返回值。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
给定无服务器云函数在调用过程中遇到错误,这通常是由于无服务器云函数所运行的代码存在异常。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
命名空间和类:tencent.cloud.serverless.functions.Client
调用给定无服务器云函数的指定例程,并获取例程的实际返回值。
该方法的参数和参数描述如下:
该方法返回给定无服务器云函数的指定例程调用的实际返回值。返回值视参数的值不同而异,详情请参阅方法 easy_invoke
的返回值描述。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
给定无服务器云函数在调用过程中遇到错误,这通常是由于无服务器云函数所运行的代码存在异常。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.5
命名空间和类:tencent.cloud.serverless.functions.Client
将给定无服务器云函数的指定例程绑定在另一个 Python 原生同步或异步函数上。之后对被绑定的 Python 原生同步或异步函数的调用将被重定向为对给定无服务器云函数例程的调用。
该方法是一个装饰器,您应该以 Python 装饰器语法使用它,否则行为是未定义的。
该方法的参数和参数描述如下:
该方法返回装饰器处理器函数实例。
被绑定的 Python 原生函数被调用时将在内部调用方法 routine_invoke
实现对给定无服务器云函数的调用,其被绑定的 Python 原生函数的返回值与方法 routine_invoke
的返回值一致。
该方法预期行为不会主动引发任何异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.5
命名空间和模块: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.core.client.BaseClient
类
该类仅支持构造类实例后使用,构造实例方法继承自父类,其构造实例方法签名如下:
构造实例方法参数和参数描述如下:
请注意,对于 Tencent Cloud SDK for Python 0.1.3 或更低版本,参数名称为:
值得注意的是,旧版本除参数名称不同外,与新版本中的参数数据类型和行为是一致的。
该类型的实例包含可被公开访问的属性有:
该类型部分可被公开访问的属性可能需要最新的 Tencent Cloud SDK for Python 版本:
在下文中我们将向您演示如何构造一个无服务器云函数产品客户端类实例:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.3
返回的函数实例将在内部调用方法 实现对给定无服务器云函数的调用,其函数实例的返回值与方法 的返回值一致。
参数
类型
必选
描述
access_credentials
Credentials
否
访问凭据类实例。如果该参数被忽略或设置为 None
,默认设置为环境凭据或文件凭据。
access_proxies
否
代理服务器配置类实例。如果该参数被忽略或设置为 None
,默认不使用任何代理服务器。
文档中的参数名
旧的参数名
类型一致
行为一致
access_credentials
credentials_context
是
是
access_proxies
proxies_context
是
是
属性
类型
只读
描述
error_manager
ErrorManager
是
当前无服务云函数产品客户端实例的错误管理器实例。借助错误管理器,您可以自定义对感兴趣地错误的处理方式。
credentials
Credentials
是
当前无服务器云函数产品客户端实例所绑定的访问凭据实例。
proxies
Proxies
是
当前无服务器云函数产品客户端实例所绑定的一个或多个代理服务器配置实例。如果需要修改代理服务器配置,请使用 set_access_proxies
方法。
请注意,如果当前无服务器云函数产品客户端未设置代理服务器配置,该属性默认值为 None
。
属性
软件包
版本要求
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
参数
类型
必选
描述
region_id
str
是
调用的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
调用的无服务器云函数所在命名空间的名称。
function_name
str
是
调用的无服务器云函数名称。
function_event
dict
否
调用的无服务器云函数事件。
如果该参数被忽略或设置为 None
,默认传递空事件。
function_version
str
否
调用的无服务器云函数版本名称。
如果该参数被忽略或设置为 None
,默认调用最新版本。
function_async
bool
否
调用的无服务器云函数是否以异步的方式运行。
如果该参数被忽略或设置为 None
,默认以同步方式运行。
参数
类型
必选
描述
region_id
str
是
选择的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
选择的无服务器云函数所在命名空间的名称。
function_name
str
是
选择的无服务器云函数名称。
function_version
str
否
选择的无服务器云函数版本名称。
如果该参数被忽略或设置为 None
,默认为最新版本。
function_async
bool
否
选择的无服务器云函数是否以异步的方式运行。
如果该参数被忽略或设置为 None
,默认以同步方式运行。
命名空间和类:tencent.cloud.serverless.functions.Client
运行所有已创建的定时无服务器云函数调用任务,直到没有仍未调用的定时任务存在时该方法返回。这些任务通常由实例方法 schedule_invoke 创建。
请注意,该方法仅适用于同步编程方式,异步编程方式无需手动调用该方法。
该实例方法在产品软件包 tencent-cloud-sdk-serverless-functions - 0.1.2 版本中新增。如果产品软件包低于适用版本,应该使用底层级 API 模拟实现:
否则,已创建的定时无服务器云函数调用任务可能永远不会被运行。
该方法没有参数。
该方法没有返回值。
该方法可能会主动引发以下异常:
没有已创建的定时调用任务需要运行或正在运行。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.2
命名空间和类:tencent.cloud.serverless.functions.Client
计划在给定本机 UNIX 时间戳调用给定无服务器云函数。
该方法的参数和参数描述如下:
参数
类型
必选
描述
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
被设置为有效的函数实例,其函数实例回调时将传入该方法的返回值。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
获取给定无服务器云函数指定 Request ID 的运行结果。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
获取的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
获取的无服务器云函数所在命名空间的名称。
function_name
str
是
获取的无服务器云函数名称。
function_request_id
str
是
获取的无服务器云函数 Request ID 字符串。
function_version
str
否
获取的无服务器云函数的版本名称。如果该参数被忽略或设置为 None,默认为最新版本。
该方法返回给定无服务器云函数指定 Request ID 的运行结果字典实例,其数据类型为 FunctionResult。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
给定无服务器云函数的 Request ID 无效或未找到运行结果。如果 Request ID 有效,则给定无服务器云函数可能还在运行或运行结果仍未完成收集。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
参数
类型
必选
描述
region_id
str
是
调用的无服务器云函数所在数据中心的唯一标识符。
例如:ap-shanghai
namespace_name
str
是
调用的无服务器云函数所在命名空间的名称。
例如:default
function_name
str
是
调用的无服务器云函数名称。
例如:arithmetic
routine_name
str
是
调用的无服务器云函数的例程名称。
例如:addend
routine_parameter
dict
否
调用的无服务器云函数关键字参数。
例如:{ 'value1': 10, 'value2': 20 }
function_version
str
否
调用的无服务器云函数版本名称。
如果该参数被忽略或设置为 None
,默认调用最新版本。
function_async
bool
否
调用的无服务器云函数是否以异步的方式运行。
如果该参数被忽略或设置为 None
,默认以同步方式运行。
参数
类型
必选
描述
region_id
str
是
绑定的无服务器云函数所在数据中心的唯一标识符。
例如:ap-shanghai
namespace_name
str
是
绑定的无服务器云函数所在命名空间的名称。
例如:default
function_name
str
是
绑定的无服务器云函数名称。
例如:arithmetic
function_version
str
否
绑定的无服务器云函数版本名称。
如果该参数被忽略或设置为 None
,默认为最新版本。
function_async
bool
否
绑定的无服务器云函数是否以异步的方式运行。
如果该参数被忽略或设置为 None
,默认以同步方式运行。
routine_name
str
否
绑定的无服务器云函数的例程名称。
如果该参数被忽略或设置为 None,默认为绑定的 Python 原生同步或异步函数的名称。
命名空间和类:tencent.cloud.serverless.functions.Client
调用给定无服务器云函数并获得无服务器云函数的运行结果。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
创建的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
创建的无服务器云函数所在命名空间的名称。
function_name
str
是
创建的无服务器云函数名称。
function_description
str
否
创建的无服务器云函数描述正文。
function_code
是
创建的无服务器云函数代码实例。
function_runtime
str
否
function_type
str
否
function_configure
否
创建的无服务器云函数配置。如果该参数被忽略或设置为 None
,被创建的函数将采用默认配置。
该方法返回可等待操作对象,这将允许您等待无服务器云函数资源真正地创建完成。
在 Tencent Cloud SDK for Python 0.1.6 或更低版本中,该方法没有返回值。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.6
命名空间和类:tencent.cloud.serverless.functions.Client
调用给定无服务器云函数并获得无服务器云函数的运行结果。
该方法的参数和参数描述如下:
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
给定无服务器云函数在调用过程中遇到错误,这通常是由于无服务器云函数所运行的代码存在异常。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
Tencent Cloud API 返回结果是非预期的,该异常通常情况下不会引发。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
创建的无服务器云函数运行时名称。如果该参数被忽略,默认运行时为 Python3
。建议使用 枚举器成员。
创建的无服务器云函数类型。如果该参数被忽略,默认类型为 Event
。建议使用 枚举器成员。
返回包含给定无服务器云函数运行结果的字典实例,其数据类型为 。
参数
类型
必选
描述
region_id
str
是
调用的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
调用的无服务器云函数所在命名空间的名称。
function_name
str
是
调用的无服务器云函数名称。
function_event
dict
否
调用的无服务器云函数事件。
如果该参数被忽略或设置为 None
,默认传递空事件。
function_version
str
否
调用的无服务器云函数版本名称。
如果该参数被忽略或设置为 None
,默认调用最新版本。
function_async
bool
否
调用的无服务器云函数是否以异步的方式运行。
如果该参数被忽略或设置为 None
,默认以同步方式运行。
参数
类型
必选
描述
region_id
str
是
更新的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
更新的无服务器云函数所在命名空间的名称。
function_name
str
是
更新的无服务器云函数名称。
function_code
是
更新的无服务器云函数代码实例。
function_handler
str
是
更新的无服务器云函数的入口函数符号名。
命名空间和类:tencent.cloud.serverless.functions.Client
为给定无服务器云函数发布一个新的版本。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
发布的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
发布的无服务器云函数所在命名空间的名称。
function_name
str
是
发布的无服务器云函数名称。
version_description
str
否
发布的无服务器云函数版本的描述正文。
该方法没有返回值。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
为给定无服务器云函数创建一个拷贝副本函数。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
当前无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
当前无服务器云函数所在命名空间的名称。
function_name
str
是
当前无服务器云函数名称。
target_region_id
str
是
目标无服务器云函数所在数据中心的唯一标识符。
target_namespace_name
str
是
目标无服务器云函数所在命名空间的名称。
target_function_name
str
是
目标无服务器云函数名称。
allow_override
bool
否
如果目标无服务器云函数已存在,是否允许将其覆盖。如果该参数被忽略或设置为 None
,默认不允许覆盖。
copy_configure
bool
否
是否将当前无服务器云函数配置拷贝给目标无服务器云函数。如果该参数被忽略或设置为 None
,默认不拷贝当前函数配置。
该方法没有返回值。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
选择一个给定无服务器云函数的指定例程并返回给定无服务器云函数例程的 Python 原生函数实例。对该函数实例的调用等同于对给定无服务器云函数例程的调用,其关键字参数将作为给定无服务器云函数例程的关键字参数。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
选择的无服务器云函数所在数据中心的唯一标识符。
例如:ap-shanghai
namespace_name
str
是
选择的无服务器云函数所在命名空间的名称。
例如:default
function_name
str
是
选择的无服务器云函数名称。
例如:arithmetic
routine_name
str
是
选择的无服务器云函数的例程的名称。
例如:addend
function_version
str
否
选择的无服务器云函数版本名称。
如果该参数被忽略或设置为 None
,默认为最新版本。
function_async
bool
否
选择的无服务器云函数是否以异步的方式运行。
如果该参数被忽略或设置为 None
,默认以同步方式运行。
该方法返回给定无服务器云函数例程的 Python 原生函数实例。
返回的函数实例将在内部调用方法 routine_invoke
实现对给定无服务器云函数例程的调用,其函数实例的返回值与方法 routine_invoke
的返回值一致。
该方法预期行为不会主动引发任何异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.5
命名空间和类:tencent.cloud.serverless.functions.Client
命名空间和类:tencent.cloud.serverless.functions.Client
获取给定无服务器云函数的运行结果,该方法将尝试检索符合条件的所有运行结果记录。
该方法的参数和参数描述如下:
该方法在内部维护一个缓冲循环,每次使用 Tencent Cloud API 检索并获取 100 条符合条件的无服务器云函数运行结果。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
命名空间和类:tencent.cloud.serverless.functions.Client
获取给定无服务器云函数的源代码 ZIP 档案下载 URL 字符串。
该方法的参数和参数描述如下:
返回给定无服务器云函数的源代码 ZIP 档案下载 URL 字符串。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
该方法返回一个用于遍历获取符合过滤条件的无服务器云函数运行结果的生成器实例,生成器实例每次迭代返回包含无服务器云函数运行结果的字典实例,其数据类型为 。
参数
类型
必选
描述
region_id
str
是
删除的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
删除的无服务器云函数所在命名空间的名称。
function_name
str
是
删除的无服务器云函数名称。
参数
类型
必选
描述
region_id
str
是
获取的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
获取的无服务器云函数所在命名空间的名称。
function_name
str
是
获取的无服务器云函数名称。
requirement_context
否
过滤符号条件的无服务器云函数运行结果的过滤器上下文字典实例。
function_version
str
否
获取的无服务器云函数的版本名称。如果该参数被忽略或设置为 None,默认为最新版本。
参数
类型
必选
描述
region_id
str
是
更新的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
更新的无服务器云函数所在命名空间的名称。
function_name
str
是
更新的无服务器云函数名称。
function_description
str
否
更新的无服务器云函数描述正文。如果该参数被忽略或设置为 None
,默认不更新描述正文。
function_configure
否
更新的无服务器云函数配置字典实例。如果该参数被忽略或设置为 None
,默认不更新函数配置。
参数
类型
必选
描述
region_id
str
是
获取的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
获取的无服务器云函数所在命名空间的名称。
function_name
str
是
获取的无服务器云函数名称。
function_version
str
否
获取的无服务器云函数版本名称。
命名空间和类:tencent.cloud.serverless.functions.Client
获取给定无服务器云函数的所有版本信息。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
获取的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
获取的无服务器云函数所在命名空间的名称。
function_name
str
是
获取的无服务器云函数名称。
该方法返回一个用于遍历获取无服务器云函数版本信息的生成器实例,生成器实例每次迭代返回包含无服务器云函数版本信息的字典实例,其数据类型为 FunctionVersionInfo。
由于 Tencent Cloud API 不支持分页游标检索并获取,因此该方法将尝试一次性获取无服务器云函数的所有版本信息。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
获取给定无服务器云函数的基本信息。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
获取的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
获取的无服务器云函数所在命名空间的名称。
function_name
str
是
获取的无服务器云函数名称。
function_version
str
否
获取的无服务器云函数版本名称。
返回包含给定无服务器云函数基本信息的字典实例,其数据类型为 FunctionInfoEx。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
获取给定命名空间内的无服务器云函数基本信息,该方法将尝试检索符合条件的无服务器云函数项。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
获取的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
获取的无服务器云函数所在命名空间的名称。
requirement_context
否
包含检索过滤条件的字典实例。
该方法返回一个用于遍历获取符合过滤条件的无服务器云函数基本信息的生成器实例,生成器实例每次迭代返回包含无服务器云函数基本信息的字典实例,其数据类型为 FunctionInfo。
该方法在内部维护一个缓冲循环,每次使用 Tencent Cloud API 检索并获取 100 条符合条件的无服务器云函数运行结果。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
将给定触发器从指定无服务器云函数上删除。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
删除触发器的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
删除触发器的无服务器云函数所在命名空间的名称。
function_name
str
是
删除触发器的无服务器云函数名称。
function_trigger
是
代表无服务器云函数触发器配置的 FunctionTrigger 实例。
function_version
str
否
删除触发器的无服务器云函数版本名称。
该方法没有返回值。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
为给定无服务器云函数创建一个触发器。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
创建触发器的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
创建触发器的无服务器云函数所在命名空间的名称。
function_name
str
是
创建触发器的无服务器云函数名称。
function_trigger
是
代表无服务器云函数触发器配置的 FunctionTrigger 实例。
function_version
str
否
创建触发器的无服务器云函数版本名称。
该方法没有返回值。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
命名空间和类:tencent.cloud.serverless.functions.Client
命名空间和类:tencent.cloud.serverless.functions.Client
参数
类型
必选
描述
region_id
str
是
创建的命名空间所在数据中心的唯一标识符。
namespace_name
str
是
创建的命名空间名称。
namespace_description
str
否
创建的命名空间描述正文。
参数
类型
必选
描述
region_id
str
是
创建的命名空间所在数据中心的唯一标识符。
namespace_name
str
是
创建的命名空间名称。
参数
类型
必选
描述
region_id
str
是
下载源代码的无服务器云函数所在数据中心的唯一标识符。
namespace_name
str
是
下载源代码的无服务器云函数所在命名空间的名称。
function_name
str
是
下载源代码的无服务器云函数名称。
function_version
str
否
下载源代码的无服务器云函数版本名称。
download_file_name
str
否
存储源代码 ZIP 档案的本机文件名。如果该参数被忽略或设置为 None,默认下载到当前工作目录,文件名以 function-code-{FUNCTION_NAME}-{FUNCTION_VERSION}.zip
命名。
命名空间和类:tencent.cloud.serverless.functions.Client
更新给定命名空间的基本信息。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
更新的命名空间所在数据中心的唯一标识符。
namespace_name
str
是
更新的命名空间名称。
namespace_description
str
是
更新的命名空间描述正文。
该方法没有返回值。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定命名空间已存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
获取给定数据中心已创建的命名空间基本信息。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
获取的命名空间所在数据中心的唯一标识符。
该方法返回一个用于遍历获取命名空间基本信息的生成器实例,生成器实例每次迭代返回包含命名空间基本信息的字典实例,其数据类型为 NamespaceInfo。
该方法在内部维护一个缓冲循环,每次使用 Tencent Cloud API 检索并获取 20 条符合条件的无服务器云函数运行结果。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定命名空间不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
获取一个已创建层的指定层版本的信息。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
层的数据中心唯一标识符。
例如:ap-shanghai
layer_name
str
是
层的唯一名称。
例如:default
layer_version
int
是
层的版本编号。
例如:1
该方法返回包含层信息的字典实例,其数据类型为 LayerInfo。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.2
命名空间和类:tencent.cloud.serverless.functions.Client
删除一个已创建就绪的层或层的指定版本。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
删除的层的数据中心唯一标识符。
例如:ap-shanghai
layer_name
str
是
删除的层的唯一名称。
例如:default
layer_version
int
否
删除的层的版本编号。
如果该参数被忽略或设置为 None
,默认批量删除所有层版本。
例如:1
在 Tencent Cloud SDK for Python 0.1.6 或更低版本中,参数 layer_version
必须提供。
该方法没有返回值。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.6
命名空间和类:tencent.cloud.serverless.functions.Client
创建一个新层或已存在层的新版本。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
创建层的数据中心唯一标识符。
例如:ap-shanghai
layer_name
str
是
创建的层的唯一名称。
例如:default
layer_description
str
是
创建的层的描述正文。
例如:default layer
layer_content
是
包含创建的层的数据的 LayerContent 实例。
例如:LayerContent().use_local_zip_archive(...)
layer_runtimes
list
是
包含创建的层兼容的无服务器云函数运行时名称的列表实例。
例如:[ FunctionRuntime.Python ]
layer_license
str
否
创建的层的许可正文。
例如:default license
该方法返回可等待操作对象,这将允许您等待层或层版本资源真正地创建完成。返回的可等待对操作对象包含操作结果,其指示新创建的层或层版本的版本编号。
在 Tencent Cloud SDK for Python 0.1.6 或更低版本中,该方法返回新创建的层或层版本的版本编号。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.6
命名空间和类:tencent.cloud.serverless.functions.Client
获取已创建的所有层的最新层版本信息。
该方法的参数和参数描述如下:
参数
类型
必选
描述
region_id
str
是
层的数据中心唯一标识符。
例如:ap-shanghai
requirement_context
dict
否
该方法返回一个用于遍历获取符合过滤条件的层信息的生成器实例,生成器实例每次迭代返回包含层信息的字典实例,其数据类型为 LayerInfo。
该方法在内部维护一个缓冲循环,每次使用 Tencent Cloud API 检索并获取 20 条符合条件的层信息。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.2
命名空间和模块:tencent.cloud.serverless.functions
获取适用于当前超线程的内建无服务器云函数产品客户端实例。
如果在当前超线程中从未创建过内建无服务器云函数产品客户端实例,默认创建新的客户端实例并将其设置为适用于当前超线程的内置客户端实例,反之复用已创建的客户端实例。
该函数不允许指定被创建无服务器云函数产品客户端的访问凭据,这意味着您的应用程序只能使用可被自动查找并设置的环境凭据或文件凭据,详情请参阅最佳实践篇:
在 Tencent Cloud SDK for Python 0.1.3 或更低版本中,您可以考虑使用非公开实验性 API 替代该函数:
请注意,函数 get_builtin_client
与 fetch_client
不同,它试图在多个超线程上下文中共享同一个内建地无服务器云函数产品客户端实例,这可能会在多线程模型的应用程序中产生意外的脏数据。
最佳实践是升级并集成最新的 Tencent Cloud SDK for Python 版本。
该函数没有参数。
该函数返回适用于当前超线程的内置无服务器云函数产品客户端实例。如果在相同的超线程上下文中多次调用该函数,每次调用返回的无服务器云函数产品客户端实例是相同的。
该函数可能会主动引发以下异常类型:
没有找到可用的文件凭据或环境凭据。
查找到的文件凭据缺失必要的访问凭据字段。
接下来我们将通过一段 Python 代码向您演示如何使用该函数:
如果当前复用的无服务器云函数产品客户端实例不再干净,您可以考虑使用函数 destroy_client
销毁适用于当前超线程的内置无服务器云函数产品客户端实例。
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.3
命名空间和类:tencent.cloud.serverless.functions.Client
包含层过滤器上下文的字典实例,其数据类型为 。
成员
类型
必选
描述
name
str
是
层唯一名称。
description
str
是
层描述正文。
version
int
是
层版本编号。
runtimes
list<str>
是
包含层兼容的运行时名称的列表实例。 与之关联的是 FunctionRuntime 枚举器。
license
str
是
层许可正文。
create_time
str
是
层创建时间字符串。
content
dict
否
包含层数据相关信息的字典实例。
content.url
str
是
层数据 ZIP 档案下载 URL。
content.hash
str
是
层数据 ZIP 档案 SHA256 校验字符串。
status
str
是
层状态。 与之关联的是 LayerStatus 枚举器。
参数
类型
必选
描述
region_id
str
是
无服务器云函数所在数据中心的唯一标识符。
例如:ap-shanghai
namespace_name
str
是
无服务器云函数所在命名空间的唯一名称。
例如:default
function_name
str
是
无服务器云函数的唯一名称。
例如:hello
indicator_name
str
是
上报的自定义指标唯一名称。
例如:number_of_invokes
indicator_value
int
是
上报的自定义指标对应的数据值。
例如:1
function_version
str
否
无服务器云函数版本唯一名称。
例如:$LATEST
成员
类型
必选
描述
info
是
包含无服务器云函数基本信息的字典实例。
configure
是
包含无服务器云函数配置信息的字典实例。
命名空间和模块:tencent.cloud.serverless.functions
代表无服务器云函数定时调用任务的类。
请注意,您不应该直接构造该类的类实例,而是应该使用 Client 类的类实例方法 schedule_invoke 获得一个该类的实例,否则行为可能是未定义的。
该类包含的可公开访问属性和属性描述如下:
属性
类型
描述
is_successful
bool
该属性指示无服务器云函数是否成功调用、运行。
exception
Exception
该属性指示无服务器云函数调用过程中所引发(如果有)的异常类型。
result
dict
该属性包含无服务器云函数的运行结果,其数据类型为 。
return_value
...
该属性包含无服务器云函数的实际返回值,请参阅类 Client 的实例方法 的返回值说明。
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.serverless.functions.Client
获取已创建就绪的层的所有层版本信息。
该方法的参数和参数描述如下:
该方法返回一个用于遍历获取符合过滤条件的层信息的生成器实例,生成器实例每次迭代返回包含层信息的字典实例,其数据类型为 。
请注意,由于该方法背后的 Tencent Cloud API 不支持分页检索,该方法将试图一次性获取所有符合条件的层信息。
该方法可能会主动引发以下异常:
参数值或类型不符合预期。
Tencent Cloud API 错误。例如访问凭据无效、给定无服务器云函数不存在等均会引发该异常。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.2
参数
类型
必选
描述
region_id
str
是
获取的层的数据中心唯一标识符。
例如:ap-shanghai
layer_name
str
时
获取的层的唯一名称。
requirement_context
dict
否
包含层过滤器上下文的字典实例,其数据类型为 LayerFilter。
命名空间和模块:tencent.cloud.serverless.functions.client.FunctionTrigger
配置使用定时触发器。什么是定时触发器?
该方法具有以下参数,其参数、参数类型和参数描述如下:
参数
类型
必选
描述
timer_name
str
是
定时触发器的唯一名称。 绑定该触发器的无服务器云函数可通过触发事件获得该触发器的唯一名称。
timer_cron
str
是
定时触发器触发周期标准 Cron 表达式。
该方法返回当前代表触发器配置的 FunctionTrigger 类实例本身。
该方法可能会主动引发的异常类型如下:
参数值或类型不符合预期。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和模块:tencent.cloud.serverless.functions.client.FunctionTrigger
命名空间和模块:tencent.cloud.serverless.functions.client.FunctionTrigger
配置使用对象存储桶触发器。什么是对象存储桶触发器?
该方法具有以下参数,其参数、参数类型和参数描述如下:
参数
类型
必选
描述
bucket_endpoint
str
是
对象存储桶的 XML API 访问端点主机名。
bucket_requirement_context
是
包含对象存储桶触发器事件过滤描述结构的字典实例。
该方法返回当前代表触发器配置的 FunctionTrigger 类实例本身。
该方法可能会主动引发的异常类型如下:
参数值或类型不符合预期。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和模块:tencent.cloud.serverless.functions.client.FunctionTrigger
配置使用消息队列主题触发器。什么是消息队列主题触发器?
该方法具有以下参数,其参数、参数类型和参数描述如下:
参数
类型
必选
描述
topic_name
str
是
消息队列主题名称。
topic_instance_id
str
否
消息队列主题所属的消息队列实例唯一标识符。
topic_requirement_context
否
包含消息队列主题消息过滤描述结构的字典实例。
请注意,该方法参数 topic_instance_id 和 topic_requirement_context 是保留参数,这些参数应始终忽略或设置为 None,否则将引发 NotImplementedError 异常。
该方法返回当前代表触发器配置的 FunctionTrigger 类实例本身。
该方法可能会主动引发的异常类型如下:
参数值或类型不符合预期。
保留参数被设置为非预期值。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和模块:tencent.cloud.serverless.functions.client.FunctionCode
配置使用本机硬盘上的 ZIP 压缩档案文件作为无服务器云函数源代码来源。
该方法具有以下参数,其参数、参数类型和参数描述如下:
参数
类型
必选
描述
local_file_path
str
是
本机硬盘上的 ZIP 压缩档案文件路径。
该方法返回当前代表无服务器云函数源代码配置的 FunctionCode 类实例本身。
该方法可能会主动引发的异常类型如下:
参数值或类型不符合预期。
给定 ZIP 压缩档案文件不存在或无法读取。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和模块:tencent.cloud.serverless.functions.client.FunctionCode
配置使用给定 Git 仓库作为无服务器云函数源代码来源。
该方法具有以下参数,其参数、参数类型和参数描述如下:
参数
类型
必选
描述
git_url
str
是
Git 仓库 URL 字符串。
git_branch_name
str
否
Git 仓库中已创建的分支名称。
git_directory_name
str
否
Git 仓库中包含用于无服务器云函数源代码的目录名称。
git_commit_id
str
否
Git 仓库中包含用于无服务器云函数源代码的提交 ID。
git_username
str
否
拥有给定 Git 仓库访问权限的用户名。
git_password
str
否
拥有给定 Git 仓库访问权限用户的密码。
该方法返回当前代表无服务器云函数源代码配置的 FunctionCode 类实例本身。
该方法可能会主动引发的异常类型如下:
参数值或类型不符合预期。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和模块:tencent.cloud.serverless.functions.client.FunctionCode
命名空间和模块:tencent.cloud.core.errors
代表通用客户端、产品客户端的错误管理器的类型。借助错误管理器功能,您可以快速实现对感兴趣的客户端错误处理流程和方式的控制。利用错误管理器所提供的错误处理程序链,您可以编写一个或多个错误处理器函数并对符合特定条件的错误进行处理流程和方式控制,这将进一步增强应用程序可靠性。
请注意,错误管理器类型的实例化是隐式的且默认集成在所有客户端,您可以通过客户端实例的 error_manager
属性访问与之关联的错误管理器实例。
错误管理器类型的实例包含可公开访问的属性如下:
属性
类型
只读
描述
enabled
bool
否
指示是否已启用错误管理器。
将该属性的值设置为 False
,将立即禁用错误管理器。
max_backoff_interval
int
否
指示错误管理器指数退避重试处理方式每次重试的最大间隔秒数。该属性的值默认为 64
秒。
max_number_of_retries
int
否
指示错误管理器重试引发错误的操作时最大可重试的次数。
该属性的值默认为 10
次。
在下文中我们将通过一段 Python 代码片段向您演示如何向错误管理器添加一个错误处理器:
在上文示例代码中我们定义了一个错误处理器函数 error_handler_callback
,其参数为:
参数
类型
必选
描述
error_manager
是
调用错误处理器函数的错误管理器实例。
error_source
是
引发该错误的客户端实例。
error_instance
是
引发的错误对应的异常类型实例。
error_retry_count
int
是
该错误已重试次数。
当与之关联的客户端实例引发 ClientError 异常时,其错误管理器已添加的错误处理器回调函数将根据添加顺序逐个调用。
被回调的错误处理器函数需要返回枚举器 ErrorHandlerResult 的成员值以指示针对该错误的处理方式,错误管理器将根据返回的处理方式对该错误进行处理。
在上文示例代码中,我们定义并添加的错误处理器代码运行逻辑如下:
产品软件包:tencent-cloud-sdk-core >= 0.1.2
命名空间和模块:tencent.cloud.serverless.functions.client.FunctionCode
配置使用对象存储桶作为无服务器云函数源代码来源。
该方法具有以下参数,其参数、参数类型和参数描述如下:
参数
类型
必选
描述
region_id
str
是
对象存储桶所在数据中心园区的可用区唯一标识符。
bucket_name
str
是
对象存储桶的完全名称,例如 scf-code-1000000000
。
object_name
str
是
对象存储桶中用于作为无服务器云函数源代码 ZIP 档案文件的对象名称。
该方法返回当前代表无服务器云函数源代码配置的 FunctionCode 类实例本身。
该方法可能会主动引发的异常类型如下:
参数值或类型不符合预期。
下面我们将通过一段 Python 代码向您演示如何使用该方法:
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和类:tencent.cloud.core.errors.ErrorManager
命名空间和模块:tencent.cloud.serverless.functions
为当前无服务器云函数使用例程派发器框架。
当该函数的参数 override_handler
被忽略或值设置为 True
时,该函数将尝试查找本次函数调用是由哪一个 Python 模块发起,并在来源 Python 模块中创建或覆盖名为 main
的无服务器云函数执行方法。
请注意,请确保当前无服务器云函数的执行方法名为 main,并且仅在包含执行方法定义的 Python 模块中调用一次该函数,否则该函数可能无法正常工作。
如果您的无服务器云函数已确定使用适用于无服务器云函数集成调用的例程派发器框架,您将无需为该无服务器云函数编写名为 main
的执行方法。
该函数拥有的参数、参数类型和参数描述如下:
参数
类型
必选
描述
override_handler
bool
否
是否创建或覆盖调用该函数的模块中的无服务器云函数 main
函数。
该函数返回适用于无服务器云函数集成调用的例程派发器 IntegrateDispatch
实例。
该函数可能会主动引发以下异常类型:
参数值或类型不符合预期。
该函数无法确定当前函数调用来自于哪一个 Python 模块。
接下来我们将通过一段 Python 代码片段向您演示如何使用该函数:
现在,Python 原生函数 addend
已向例程派发器注册并对外提供可名为 addend
的可调用例程。
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.5
命名空间和模块:tencent.cloud.serverless.functions.client
成员
类型
必选
描述
namespace_name
str
是
无服务器云函数所属的命名空间名称。
status
str
是
无服务器云函数的当前状态。
type
str
是
无服务器云函数的类型。
id
str
是
无服务器云函数的唯一标识符。
name
str
是
无服务器云函数的名称。
description
str
是
无服务器云函数的描述正文。
runtime
str
是
无服务器云函数的运行时名称。
tags
dict
是
无服务器云函数已标记的标签对。
<name>: <value>
last_modified_time
str
是
无服务器云函数的最后修改时间字符串。
create_time
str
是
无服务器云函数的创建时间字符串。
命名空间和模块:tencent.cloud.serverless.functions
包含无服务器云函数运行结果的字典类型。
该数据类型包含的成员和成员描述如下:
成员
类型
必选
描述
function_name
str
否
无服务器云函数的名称
return_result
str
是
无服务器云函数的包装返回值。
is_successful
bool
是
无服务器云函数是否成功运行和结束。
start_time
str
是
无服务器云函数的运行开始时间字符串。
run_duration
int
是
无服务器云函数的运行时长(毫秒)。
bill_duration
int
是
无服务器云函数的计费时长(毫秒)。
usage_memory_size
int
是
无服务器云函数运行时最高占用内存(MBytes)。
run_log
str
否
无服务器云函数的运行日志。
log_level
str
否
无服务器云函数的运行日志等级。
log_source
str
否
无服务器云函数的运行日志来源。
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和模块:tencent.cloud.serverless.functions
命名空间和模块:tencent.cloud.serverless.functions
包含无服务器云函数项过滤条件的字典类型。
该数据类型包含的成员和成员描述如下:
成员
类型
必选
描述
search
dict
否
根据符合条件的关键词过滤。
search.function_name
str
是
根据符合条件的无服务器云函数名称关键字过滤。
tags
list
否
根据符合条件的资源标签过滤。
tags[index]
dict
否
根据符合条件的资源标签过滤。
tags[index].name
str
是
根据符合条件的资源标签名称过滤。
tags[index].values
list<str>
是
根据符合条件的资源标签值过滤。
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和模块:tencent.cloud.serverless.functions
包含无服务器云函数配置的字典类型。
该数据类型包含的成员和成员描述如下:
成员
类型
必选
描述
handler
str
否
无服务器云函数的入口函数符号名。
memory_size
int
否
无服务器云函数的运行时内存上限(MBytes)。
time_out
int
否
无服务器云函数的运行时长上限(秒)。
vpc_configure
dict
否
无服务器云函数的内网访问配置字典实例。
vpc_configure.vpc_id
str
是
无服务器云函数运行时所在私有网络 ID。
vpc_configure.subnet_id
str
是
无服务器云函数运行时所在私有网络的子网 ID。
role_id
str
否
无服务器云函数的运行角色 ID。
log_configure
dict
否
无服务器云函数的日志服务配置字典实例。
log_configure.logset_id
str
是
存储无服务器云函数日志的日志集 ID。
log_configure.topic_id
str
是
存储无服务器云函数日志的日志主题 ID。
environments
dict
否
无服务器云函数运行时环境变量字典实例。
eip_configure
dict
否
包含无服务器云函数弹性公网 IP 配置的字典实例。
eip_configure.enabled
bool
是
是否启用无服务器云函数公网访问时固定弹性公网 IP 功能。
eip_configure.addresses
list<str>
是
包含无服务器云函数公网访问弹性公网 IP 的列表实例。
access_configure
dict
否
包含无服务器云函数 HTTP 访问端点配置的字典实例。
access_configure.hostname
str
是
无服务器云函数 HTTP 访问端点主机名。
access_configure.ip_address
str
是
无服务器云函数 HTTP 访问主机的 VIP 地址。
layers
list<dict>
否
dead_letter
dict
否
包含无服务器云函数死信队列配置的字典实例。
dead_letter.type
str
是
无服务器云函数死信队列类型。
dead_letter.name
str
是
无服务器云函数死信队列名称。
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和模块:tencent.cloud.serverless.functions
包含无服务器云函数已关联层信息的列表实例,其成员的数据类型为 。
包含受支持运行结果类型的有 枚举器。
命名空间和模块:tencent.cloud.serverless.functions
命名空间和模块:tencent.cloud.serverless.functions.client
命名空间和模块:tencent.cloud.serverless.functions.errors
该异常指示被调用无服务器云函数在运行时出现错误所导致的调用失败,这通常是由于无服务器云函数所运行的代码存在异常。
继承:tencent.cloud.core.errors.ClientError
类
该异常类仅支持构造异常类实例后使用,其构造实例方法签名如下:
构造实例方法参数和参数描述如下:
参数
类型
必选
描述
error_message
str
是
错误描述。
request_id
str
是
出错的无服务器云函数调用唯一标识符(Request ID)字符串。
该异常类包含的可公开访问属性和属性描述如下:
属性
类型
描述
error_message
str
错误描述。
request_id
str
出错的无服务器云函数调用唯一标识符(Request ID)字符串。
产品软件包:tencent-cloud-sdk-serverless-functions >= 0.1.1
命名空间和模块:tencent.cloud.serverless.functions.errors
命名空间和模块:tencent.cloud.serverless.database.client
代表无服务器数据库产品客户端的类。通过利用无服务器数据库产品客户端,您可以以同步或异步面向对象编程的方式快速访问无服务器数据库产品。
继承:tencent.cloud.core.client.UniversalClient
类
该类仅支持构造类实例后使用,其构造实例方法签名如下:
参数
类型
必选
描述
access_credentials
Credentials
否
访问凭据类实例。如果该参数被忽略或设置为 None
,默认设置为环境凭据或文件凭据。
access_proiexs
否
代理服务器配置类实例。如果该参数被忽略或设置为 None
,默认不使用任何代理服务器。
该类可公开访问的属性继承自通用产品客户端,请参阅 UniversalClient 类的属性:
在下文中,我们将向您演示如何正确地构造一个无服务器数据库客户端实例并使用它:
通常情况下,建议您使用环境凭证或文件凭证,而不是将访问凭证硬编码。与无服务器云函数产品客户端一样,您可以使用 fetch_client
函数获取适用于当前超线程的无服务器数据库产品客户端实例。
产品软件包:tencent-cloud-sdk-serverless-database >= 0.1.1
命名空间和模块:tencent.cloud.serverless.database.client
设置给的无服务器数据库实例是否允许通过外联网(公网)访问。
该方法具有以下参数,其参数名、参数类型和参数描述如下:
参数
类型
必选
描述
region_id
str
是
设置的无服务器数据库实例所在数据中心园区唯一标识符。
例如:ap-shanghai
instance_id
str
是
设置的无服务器数据库实例唯一标识符。
例如:postgres-8nb6q9hm
instance_extranet
bool
否
无服务器数据库实例是否允许通过外联网(公网)访问。
如果忽略该参数,默认值为 True
。
该方法没有返回值。
该方法可能会主动引发以下异常类型:
参数值或类型不符合预期。
接下来我们将通过一段 Python 代码向您演示如何使用该方法:
基础软件包:tencent-cloud-sdk-serverless-database >= 0.1.1
命名空间和模块:tencent.cloud.serverless.database.client
创建一个新的无服务器数据库实例。
该方法具有以下参数,其参数名、参数类型和参数描述如下:
参数
类型
必选
描述
region_id
str
是
创建的无服务器数据库实例目的数据中心园区唯一标识符。
例如:ap-shanghai
zone_id
str
是
创建的无服务器数据库实例目的数据中心可用区唯一标识符。
例如:ap-shanghai-2
instance_name
str
是
创建的无服务器数据库实例名称。
例如:default
instance_configure
否
创建的无服务器数据库实例配置。
该方法返回包含创建的无服务器数据库实例元数据信息的字典实例,其数据类型为 InstanceInfo。
请注意,受限于 Tencent Cloud API,该方法目前仅支持返回实例 ID。
该方法可能会主动引发以下异常类型:
参数值或类型不符合预期。
接下来我们将通过一段 Python 代码向您演示如何使用该方法:
基础软件包:tencent-cloud-sdk-serverless-database >= 0.1.1
命名空间和模块:tencent.cloud.serverless.database.client
删除(销毁)一个已经创建就绪的无服务器数据库实例。
该方法具有以下参数,其参数名、参数类型和参数描述如下:
参数
类型
必选
描述
region_id
str
是
删除的无服务器数据库实例所在数据中心园区唯一标识符。
例如:ap-shanghai
instance_id
str
是
删除的无服务器数据库实例唯一标识符。
例如:postgres-8nb6q9hm
该方法没有返回值。
该方法可能会主动引发以下异常类型:
参数值或类型不符合预期。
接下来我们将通过一段 Python 代码向您演示如何使用该方法:
基础软件包:tencent-cloud-sdk-serverless-database >= 0.1.1
命名空间和模块:tencent.cloud.serverless.database.client
包含无服务器数据库实例配置的字典实例。
该数据类型包含的成员和成员描述如下:
成员
类型
必选
描述
vpc
dict
否
包含无服务器数据库实例 VPC 配置的字典。
vpc.id
str
是
无服务器数据库实例 VPC 唯一标识符。
vpc.subnet_id
str
是
无服务器数据库实例 VPC 子网唯一标识符。
database
dict
否
包含无服务器数据库实例数据库配置的字典。
database.version
str
是
无服务器数据库实例数据库版本号。
database.charset
str
是
project_id
int
否
无服务器数据库实例所属项目 ID。
产品软件包:tencent-cloud-sdk-serverless-database >= 0.1.1
命名空间和模块:tencent.cloud.serverless.database.client
列出给定数据中心园区内已创建的无服务器数据库实例信息。
该方法具有以下参数,其参数名、参数类型和参数描述如下:
该方法返回一个用于遍历一个或多个无服务器数据库实例信息的生成器实例,生成器实例每次迭代返回包含无服务器数据库实例信息的字典实例,其数据类型为 。
该方法在内部维护一个缓冲循环,每次使用 Tencent Cloud API 检索并获取 20 条符合条件的无服务器数据库信息。
该方法可能会主动引发以下异常类型:
参数值或类型不符合预期。
接下来我们将通过一段 Python 代码向您演示如何使用该方法:
基础软件包:tencent-cloud-sdk-serverless-database >= 0.1.1
无服务器数据库实例数据库字符集。 与之相关的是 枚举器。
参数
类型
必选
描述
region_id
str
是
列出的无服务器数据库实例所在数据中心园区唯一标识符。
例如:ap-shanghai
命名空间和模块:tencent.cloud.serverless.database
获取适用于当前超线程的内建无服务器数据库产品客户端实例。
如果在当前超线程中从未创建过内建无服务器数据库产品客户端实例,默认创建新的客户端实例并将其设置为适用于当前超线程的内置客户端实例,反之复用已创建的客户端实例。
该函数不允许指定被创建无服务器数据库产品客户端的访问凭据,这意味着您的应用程序只能使用可被自动查找并设置的环境凭据或文件凭据,详情请参阅最佳实践篇:
该函数没有参数。
该函数返回适用于当前超线程的内置无服务器数据库产品客户端实例。如果在相同的超线程上下文中多次调用该函数,每次调用返回的无服务器数据库产品客户端实例是相同的。
该函数可能会主动引发以下异常类型:
没有找到可用的文件凭据或环境凭据。
查找到的文件凭据缺失必要的访问凭据字段。
接下来我们将通过一段 Python 代码向您演示如何使用该函数:
产品软件包:tencent-cloud-sdk-serverless-database >= 0.1.1
命名空间和模块:tencent.cloud.core.waitable
代表一个可等待操作对象的基本类型。借助可等待对象,开发者可以以同步或异步面向对象编程的方式等待一个异步操作真正地完成,例如同步等待一个或多个无服务器云函数资源创建完成。
可等待操作对象类型的实例包含可公开访问的属性如下:
属性
类型
只读
描述
status
int
是
result
object
是
指示可等待操作对象对应的可等待操作的返回值。
如果可等待操作没有返回值,该属性的值默认为 None
。
在下文中我们将通过一段 Python 代码片段向您演示如何使用可等待操作对象:
产品软件包:tencent-cloud-sdk-core >= 0.1.5
指示可等待操作对象的状态。 与该属性的值相关的是 枚举器。
命名空间和模块:tencent.cloud.serverless.database.client
包含无服务器数据库实例信息的字典实例。
该数据类型包含的成员和成员描述如下:
成员
类型
必选
描述
id
str
是
无服务器数据库实例唯一标识符。
name
str
否
无服务器数据库实例名称。
status
str
否
无服务器数据库实例状态。
region_id
str
否
无服务器数据库实例所在数据中心园区唯一标识符。
zone_id
str
否
五服务器数据库实例所在数据中心可用区唯一标识符。
project_id
int
否
无服务器数据库实例所属项目 ID。
vpc
dict
否
包含无服务器数据库实例 VPC 配置的字典。
vpc.id
str
是
无服务器数据库实例所在 VPC 唯一标识符。
vpc.subnet_id
str
是
无服务器数据库实例所在 VPC 子网唯一标识符。
database
dict
否
包含无服务器数据库实例数据库配置的字典。
database.version
str
是
无服务器数据库实例数据库版本号。
database.charset
str
是
无服务器数据库实例数据库字符集名称。
database.names
list<str>
否
包含无服务器数据库实例数据库名称的列表。
create_time
str
否
无服务器数据库实例创建时间字符串。
networks
list<dict>
否
包含无服务器数据库实例网络配置的列表。
networks[...].type
str
是
无服务器数据库实例网络配置类型。
networks[...].status
str
是
无服务器数据库实例网络配置状态。
networks[...].address
dict
是
包含无服务器数据库实例网络地址配置的字典。
networks[...].address.ip
str
否
无服务器数据库实例网络 IP 地址字符串。
networks[...].address.port
int
否
无服务器数据库实例网络端口。
users
list
否
包含无服务器数据库实例用户配置的列表。
users[...].name
str
是
无服务器数据库实例用户名称。
users[...].password
str
是
无服务器数据库实例用户密码。
产品软件包:tencent-cloud-sdk-serverless-database >= 0.1.1
命名空间和模块:tencent.cloud.core.waitable
参数
类型
必选
描述
max_wait_seconds
float
否
最长等待秒数。
如果该参数被忽略,默认值为 15 秒。
如果该参数被设置为 None
,则直到操作完成。
命名空间和模块:tencent.cloud.core.waitable
设置当前可等待操作的结果,该结果可以通过访问可等待操作对象的 result
属性获得。
值得注意的是,如果方法 wait_for_done
调用成功,可等待操作的结果将被覆盖。
该方法具有以下参数,其参数、参数类型和参数描述如下:
参数
类型
必选
描述
wait_result
object
是
包含可等待操作结果的 Object 实例,该参数允许被设置为 None
。
该方法没有返回值。
该方法不会主动抛出异常。
接下来我们将通过一段 Python 代码向您演示如何使用该方法:
基础软件包:tencent-cloud-sdk-core >= 0.1.5