简要

调用当前客户端所绑定 Tencent Cloud 产品的指定 Tencent Cloud API 并获得结果。

def action(self,
    region_id: str,
    action_id: str,
    action_parameters: dict,
    action_version: str,
) -> dict

参数

该方法具有以下参数，其参数、参数类型和参数描述如下：

返回值

该方法返回包含给定 Tencent Cloud API 响应结构的字典实例。

异常

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

ValueError

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

RequestError

Tencent Cloud SDK for Python 请求给定 Tencent Cloud API 时出错，这可能是由于网络原因所引起的。

ResponseError

Tencent Cloud SDK for Python 解析给定 Tencent Cloud API 响应内容结构时出错，这可能是由于响应内容不符合预期所引起的（例如使用非 Tencent Cloud API v3 版本）。

ActionError

给定 Tencent Cloud API 遇到错误，这可能是由于访问凭据无效、参数值或类型不符合预期等引起。

示例

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

action_result: dict = virtual_machine_client.action(
    region_id = 'ap-shanghai',
    action_id = 'DescribeZones',
    action_version = '2017-03-12'
)

适用于

Tencent Cloud SDK for Python

基础软件包：tencent-cloud-sdk-core >= 0.1.1

简要

调用给定 Tencent Cloud 产品的指定 Tencent Cloud API 并获得结果。

与方法 action 或 action_async 不同，该方法提供对多个 Tencent Cloud 产品的 Tencent Cloud API 混合调用的能力。例如我们可以在适用于 Cloud Virtual Machine 产品的通用产品客户端中调用适用于 Serverless Cloud Function 产品的 Tencent Cloud API，而不局限于当前客户端所绑定的 Tencent Cloud 产品 ID 的限制，我们将该高级特性称之为对 Tencent Cloud 产品的混合调用。

def action_for_product(self,
    product_id: str,
    region_id: str,
    action_id: str,
    action_parameters: dict,
    action_version: str,
    action_endpoint: str = None
) -> dict

参数

该方法具有以下参数，其参数、参数类型和参数描述如下：

返回值

该方法返回包含给定 Tencent Cloud API 响应结构的字典实例。

异常

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

ValueError

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

RequestError

Tencent Cloud SDK for Python 请求给定 Tencent Cloud API 时出错，这可能是由于网络原因所引起的。

ResponseError

Tencent Cloud SDK for Python 解析给定 Tencent Cloud API 响应内容结构时出错，这可能是由于响应内容不符合预期所引起的（例如使用非 Tencent Cloud API v3 版本）。

ActionError

给定 Tencent Cloud API 遇到错误，这可能是由于访问凭据无效、参数值或类型不符合预期等引起。

示例

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

action_result: dict = virtual_machine_client.action_for_product(
    product_id = 'scf',
    region_id = 'ap-shanghai',
    action_id = 'Invoke',
    action_parameters = {
        'Namespace': 'default',
        'FunctionName': 'hello'
    },
    action_version = '2018-04-16'
)

您或许已经注意到，我们已在适用于 Cloud Virtual Machine 产品的通用产品客户端中调用 Serverless Cloud Function 产品提供的 Tencent Cloud API。

适用于

Tencent Cloud SDK for Python

基础软件包：tencent-cloud-sdk-core >= 0.1.3

简要

设置当前客户端实例访问 Tencent Cloud API 时使用的代理服务器配置。

请注意，该方法将立即覆盖当前客户端实例已设置的代理服务器配置。

继承：tencent.cloud.core.client.BaseClient.set_access_proxies 方法

参数

该方法具有以下参数，其参数、参数类型和参数描述如下：

返回值

该方法没有返回值。

异常

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

ValueError

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

示例

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

设置代理服务器

移除代理服务器

适用于

Tencent Cloud SDK for Python

基础软件包：tencent-cloud-sdk-core >= 0.1.4

简要

选择一个 Tencent Cloud API 并为其创建可供直接调用的 Python 原生函数实例。

参数

该方法具有以下参数，其参数、参数类型和参数描述如下：

返回值

该方法返回一个可供调用的 Python 原生函数实例。

返回的函数实例包含 2 个参数，其参数、参数类型和参数描述如下：

返回的函数实例在内部将调用 action 方法，其返回值与 action 方法一致。

异常

该方法不会主动引发任何异常。

示例

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

适用于

Tencent Cloud SDK for Python

基础软件包：tencent-cloud-sdk-core >= 0.1.1

简要

为当前通用产品客户端设置（绑定）一个新的 Tencent Cloud 产品 ID。

请注意，使用该方法设置一个新的 Tencent Cloud 产品 ID 后当前客户端所设置的 Tencent Cloud API 请求端点将被对应的默认 Tencent Cloud API 请求端点覆盖。

例如对于无服务器云函数（产品 ID：scf）产品的请求端点为：scf.tencentcloudapi.com

参数

该方法具有以下参数，其参数、参数类型和参数描述如下：

返回值

该方法没有返回值。

异常

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

ValueError

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

示例

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

适用于

Tencent Cloud SDK for Python

基础软件包：tencent-cloud-sdk-core >= 0.1.1

简要

设置当前客户端实例的 Tencent Cloud API 端点主机名。

请注意，该方法将立即覆盖当前客户端实例默认的 Tencent Cloud API 端点主机名。

继承：tencent.cloud.core.client.BaseClient.set_access_endpoint 方法

兼容性

与该方法具有相同行为的一个低级 API 方法将适用于基础软件包 tencent-cloud-sdk-core 小于等于 0.1.3 版本的应用程序：

继承：tencent.cloud.core.client.BaseClient.set_request_endpoint 方法

参数

该方法具有以下参数，其参数、参数类型和参数描述如下：

返回值

该方法没有返回值。

异常

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

ValueError

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

示例

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

适用于

Tencent Cloud SDK for Python

基础软件包：tencent-cloud-sdk-core >= 0.1.3

简要

代表通用产品客户端的类。通过利用该类，您可以以同步或异步面向对象的编程方式快速访问 Tencent Cloud API 并获得结果，而无需关注实现细节。

通常情况下，通用产品客户端用作 Tencent Cloud SDK for Python 暂未提供抽象产品客户端的 Tencent Cloud 产品，其具有直接访问 Tencent Cloud API 的能力。

继承：tencent.cloud.core.client.BaseClient 类

Tips: 从 Tencent Cloud SDK for Python 0.1.4 版本起，所有产品客户端类型应该从 UniversalClient 继承，而不是从 BaseClient 继承。

构造

该类仅支持构造类实例后使用，其构造实例方法签名如下：

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

兼容性

请注意，对于 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

简要

获取包含当前通用或抽象产品客户端上一次 Tencent Cloud API 响应元数据的字典实例。

参数

该方法没有参数。

返回值

该方法返回包含当前通用或抽象产品客户端上一次 Tencent Cloud API 响应元数据的字典实例，其数据类型为 。

异常

该方法不会主动引发任何异常。

示例

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

适用于

Tencent Cloud SDK for Python

基础软件包：tencent-cloud-sdk-core >= 0.1.1

简要

获取当前通用产品客户端所绑定的 Tencent Cloud 产品 ID 字符串。

def get_product_id(self) -> str

参数

该方法没有参数。

返回值

该方法返回当前通用产品客户端所绑定的 Tencent Cloud 产品 ID 字符串。

异常

该方法不会主动引发任何异常。

示例

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

product_id: str = virtual_machine_client.get_product_id()

适用于

Tencent Cloud SDK for Python

基础软件包：tencent-cloud-sdk-core >= 0.1.1