1 / 40

其他 Tencent Cloud 产品

类和方法

Waitable 类

命名空间和模块：tencent.cloud.core.waitable

简要

代表一个可等待操作对象的基本类型。借助可等待对象，开发者可以以同步或异步面向对象编程的方式等待一个异步操作真正地完成，例如同步等待一个或多个无服务器云函数资源创建完成。

class Waitable

属性

可等待操作对象类型的实例包含可公开访问的属性如下：

示例

在下文中我们将通过一段 Python 代码片段向您演示如何使用可等待操作对象：

from tencent.cloud.core import errors
from tencent.cloud.core import waitable
from tencent.cloud.serverless import functions

def main():
    client: functions.Client = functions.fetch_client()

    create_operation: waitable.Waitable = 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.zip'
        ),
        layer_runtimes = [
            functions.FunctionRuntime.Python
        ],
        layer_license = 'default license'
    )

    try:
        layer_version: int = create_operation.wait_for_done(
            max_wait_seconds = 15
        )
    except TimeoutError:
        print('error: max time limit exceeded when creating layer resource')
        return
    
    print('info: layer version = {LAYER_VERSION}'.format(
        LAYER_VERSION = layer_version
    ))

if __name__ == '__main__':
    main()

适用于

Tencent Cloud SDK for Python

产品软件包：tencent-cloud-sdk-core >= 0.1.5

wait_for_done 方法

命名空间和模块：tencent.cloud.core.waitable

简要

等待与当前可等待操作相关的操作完成。在可等待操作完成或超时之前，该方法不会返回。

def wait_for_done(self,
    max_wait_seconds: float = 15
) -> object

参数

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

返回值

该方法返回包含与之关联的可等待操作结果的 Object 实例。

异常

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

ValueError

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

TimeoutError

已超出可等待操作的最长等待时间。

示例

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

from tencent.cloud.core import errors
from tencent.cloud.core import waitable
from tencent.cloud.serverless import functions

def main():
    client: functions.Client = functions.fetch_client()

    create_operation: waitable.Waitable = 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.zip'
        ),
        layer_runtimes = [
            functions.FunctionRuntime.Python
        ],
        layer_license = 'default license'
    )

    try:
        layer_version: int = create_operation.wait_for_done(
            max_wait_seconds = 15
        )
    except TimeoutError:
        print('error: max time limit exceeded when creating layer resource')
        return
    
    print('info: layer version = {LAYER_VERSION}'.format(
        LAYER_VERSION = layer_version
    ))

if __name__ == '__main__':
    main()

适用于

Tencent Cloud SDK for Python

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

has_done 方法

命名空间和模块：tencent.cloud.core.waitable

简要

检查与之关联的可等待操作是否已完成。

def has_done(self) -> bool

参数

该方法没有参数。

返回值

如果可等待操作已完成，该方法返回 True。

如果可等待操作未完成或从未开始等待过，该方法返回 False。

异常

该方法不会主动抛出异常。

示例

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

from tencent.cloud.core import errors
from tencent.cloud.core import waitable
from tencent.cloud.serverless import functions

def main():
    client: functions.Client = functions.fetch_client()

    create_operation: waitable.Waitable = 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.zip'
        ),
        layer_runtimes = [
            functions.FunctionRuntime.Python
        ],
        layer_license = 'default license'
    )

    try:
        layer_version: int = create_operation.wait_for_done(
            max_wait_seconds = 15
        )
    except TimeoutError:
        pass
    
    if create_operation.has_done():
        print('info: layer version = {LAYER_VERSION}'.format(
            LAYER_VERSION = layer_version
        ))
    else:
        print('error: the operation did not complete successfully')

if __name__ == '__main__':
    main()

适用于

Tencent Cloud SDK for Python

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

set_result 方法

命名空间和模块：tencent.cloud.core.waitable

简要

设置当前可等待操作的结果，该结果可以通过访问可等待操作对象的 result 属性获得。

def set_result(self,
    wait_result: object
)

值得注意的是，如果方法 wait_for_done 调用成功，可等待操作的结果将被覆盖。

参数

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

返回值

该方法没有返回值。

异常

该方法不会主动抛出异常。

示例

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

from tencent.cloud.core import errors
from tencent.cloud.core import waitable
from tencent.cloud.serverless import functions

def main():
    client: functions.Client = functions.fetch_client()

    create_operation: waitable.Waitable = 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.zip'
        ),
        layer_runtimes = [
            functions.FunctionRuntime.Python
        ],
        layer_license = 'default license'
    )

    create_operation.set_result(
        wait_result = 10
    )

if __name__ == '__main__':
    main()

适用于

Tencent Cloud SDK for Python

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

ErrorManager 类

命名空间和模块：tencent.cloud.core.errors

简要

代表通用客户端、产品客户端的错误管理器的类型。借助错误管理器功能，您可以快速实现对感兴趣的客户端错误处理流程和方式的控制。利用错误管理器所提供的错误处理程序链，您可以编写一个或多个错误处理器函数并对符合特定条件的错误进行处理流程和方式控制，这将进一步增强应用程序可靠性。

class ErrorManager

请注意，错误管理器类型的实例化是隐式的且默认集成在所有客户端，您可以通过客户端实例的 error_manager 属性访问与之关联的错误管理器实例。

属性

错误管理器类型的实例包含可公开访问的属性如下：

示例

在下文中我们将通过一段 Python 代码片段向您演示如何向错误管理器添加一个错误处理器：

from tencent.cloud.core import errors
from tencent.cloud.core import client

function_client: functions.Client = functions.Client()

def error_handler_callback(
    error_manager: errors.ErrorManager,
    error_source: client.BaseClient,
    error_instance: errors.ActionError,
    error_retry_count: int
) -> int:
    if not isinstance(error_instance, errors.ActionError):
        return errors.ErrorHandlerResult.Ignore
    
    if error_instance.action_id == 'FailedOperation':
        return errors.ErrorHandlerResult.Backoff
    else:
        return errors.ErrorHandlerResult.Throw

function_client.error_manager.add_handler(error_handler_callback)

在上文示例代码中我们定义了一个错误处理器函数 error_handler_callback，其参数为：

当与之关联的客户端实例引发 ClientError 异常时，其错误管理器已添加的错误处理器回调函数将根据添加顺序逐个调用。

被回调的错误处理器函数需要返回枚举器 ErrorHandlerResult 的成员值以指示针对该错误的处理方式，错误管理器将根据返回的处理方式对该错误进行处理。

在上文示例代码中，我们定义并添加的错误处理器代码运行逻辑如下：

适用于

Tencent Cloud SDK for Python

产品软件包：tencent-cloud-sdk-core >= 0.1.2

add_handler 方法

命名空间和类：tencent.cloud.core.errors.ErrorManager

简要

向错误管理器实例添加一个错误处理器到错误处理程序链的尾部。

def add_handler(self,
    error_handler: object
)

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

ExistedError

给定错误处理器回调函数已存在。

示例

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

def error_handler_callback(
    error_manager: errors.ErrorManager,
    error_source: client.BaseClient,
    error_instance: errors.ActionError,
    error_retry_count: int
) -> int:
    if not isinstance(error_instance, errors.ActionError):
        return errors.ErrorHandlerResult.Ignore
    
    if error_instance.action_id == 'FailedOperation':
        return errors.ErrorHandlerResult.Backoff
    else:
        return errors.ErrorHandlerResult.Throw

function_client.error_manager.add_handler(
    error_handler = error_handler_callback
)

适用于

Tencent Cloud SDK for Python

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

remove_handler 方法

命名空间和类：tencent.cloud.core.errors.ErrorManager

简要

将给定错误处理器回调函数从错误管理器的错误处理程序链中移除。

def remove_handler(self,
    error_handler: object
)

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

NotFoundError

给定错误处理器回调函数不存在。

示例

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

def error_handler_callback(
    error_manager: errors.ErrorManager,
    error_source: client.BaseClient,
    error_instance: errors.ActionError,
    error_retry_count: int
) -> int:
    if not isinstance(error_instance, errors.ActionError):
        return errors.ErrorHandlerResult.Ignore
    
    if error_instance.action_id == 'FailedOperation':
        return errors.ErrorHandlerResult.Backoff
    else:
        return errors.ErrorHandlerResult.Throw

function_client.error_manager.remove_handler(
    error_handler = error_handler_callback
)

适用于

Tencent Cloud SDK for Python

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

has_handler 方法

命名空间和类：tencent.cloud.core.errors.ErrorManager

简要

检查给定错误处理器回调函数是否已添加到错误处理器的错误处理程序链。

def has_handler(self,
    error_handler: object
)

参数

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

返回值

如果给定错误处理器回调函数存在，则返回 True，否则返回 False。

异常

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

ValueError

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

示例

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

def error_handler_callback(
    error_manager: errors.ErrorManager,
    error_source: client.BaseClient,
    error_instance: errors.ActionError,
    error_retry_count: int
) -> int:
    if not isinstance(error_instance, errors.ActionError):
        return errors.ErrorHandlerResult.Ignore
    
    if error_instance.action_id == 'FailedOperation':
        return errors.ErrorHandlerResult.Backoff
    else:
        return errors.ErrorHandlerResult.Throw

function_client.error_manager.has_handler(
    error_handler = error_handler_callback
)

适用于

Tencent Cloud SDK for Python

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

clear_all_handler 方法

命名空间和类：tencent.cloud.core.errors.ErrorManager

简要

将错误管理器中已添加的错误处理器回调函数全部移除。

def clear_all_handler(self)

参数

该方法没有参数。

返回值

该方法没有返回值。

异常

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

示例

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

function_client.error_manager.clear_all_handler()

适用于

Tencent Cloud SDK for Python

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

UniversalClient 类

命名空间和模块：tencent.cloud.core.client

简要

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

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

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

请注意，通用产品客户端仅适用于支持 TC3-HMAC-SHA256 签名方法的 Tencent Cloud API v3 版本，较旧的签名方法或 Tencent Cloud API 版本暂不支持。

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

action 方法

命名空间和模块：tencent.cloud.core.client.UniversalClient

简要

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

参数

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

返回值

该方法返回包含给定 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 代码向您演示如何使用该方法：

适用于

Tencent Cloud SDK for Python

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

action_for_product 方法

命名空间和模块：tencent.cloud.core.client.UniversalClient

简要

调用给定 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

select_action 方法

命名空间和模块：tencent.cloud.core.client.UniversalClient

简要

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

参数

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

返回值

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

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

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

异常

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

示例

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

适用于

Tencent Cloud SDK for Python

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

get_product_id 方法

命名空间和模块：tencent.cloud.core.client.UniversalClient

简要

获取当前通用产品客户端所绑定的 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

set_product_id 方法

命名空间和模块：tencent.cloud.core.client.UniversalClient

简要

为当前通用产品客户端设置（绑定）一个新的 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

set_access_endpoint 方法

命名空间和模块：tencent.cloud.core.client.BaseClient

简要

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

def set_access_endpoint(self,
    access_endpoint: str
)

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

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

兼容性

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

def set_request_endpoint(self,
    request_endpoint: str
)

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

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

示例

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

virtual_machine_client.set_access_endpoint(
    action_endpoint = 'scf.tencentcloudapi.com'
)

适用于

Tencent Cloud SDK for Python

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

set_access_proxies 方法

命名空间和模块：tencent.cloud.core.client.BaseClient

简要

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

def set_access_proxies(self,
    access_proxies: proxies.Proxies
)

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

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

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

示例

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

设置代理服务器

virtual_machine_client.set_access_proxies(
    access_proxies = proxies.Proxies(
        proxy_name = 'default',
        proxy_type = proxies.ProxyType.Https,
        proxy_endpoint = '127.0.0.1',
        proxy_auth = {
            'username': 'root',
            'password': 'root'
        }
    )
)

移除代理服务器

virtual_machine_client.set_access_proxies(
    access_proxies = None
)

适用于

Tencent Cloud SDK for Python

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

get_last_response_metadata 方法

命名空间和模块：tencent.cloud.core.client.BaseClient

简要

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

def get_last_response_metadata(self) -> dict

参数

该方法没有参数。

返回值

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

异常

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

示例

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

request_id: str = virtual_machine_client.get_last_response_metadata(
    )['request_id']

适用于

Tencent Cloud SDK for Python

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

Proxies 类

命名空间和模块：tencent.cloud.core.proxies

简要

代表一个或多个代理服务器配置的类。通过利用该类，您可以快速为通用或抽象产品客户端配置代理服务器，而无需关注实现细节。

class Proxies

构造

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

def __init__(self,
    proxy_name: str,
    proxy_type: str,
    proxy_endpoint: str,
    proxy_auth: dict = None
)

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

示例

在下文中我们将向您演示如何构造一个通用产品客户端类实例：

from tencent.cloud.core import client
from tencent.cloud.core import proxies

virtual_machine_client: client.UniversalClient = client.UniversalClient(
    product_id = 'cvm',
    access_credentials = ...,
    access_proiexs = proxies.Proxies(
        proxy_name = 'default',
        proxy_type = proxies.ProxyType.Http,
        proxy_endpoint = '127.0.0.1:1081',
        proxy_auth = {
            'username': 'root',
            'password': 'default-password'
        }
    )
)

适用于

Tencent Cloud SDK for Python

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

use_proxy_server 方法

命名空间和模块：tencent.cloud.core.proxies.Proxies

简要

使用一个已经添加的代理服务器作为首选代理服务器配置。

def use_proxy_server(self,
    proxy_name: str
)

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

NotFoundError

代理服务器组中不存在给定代理服务器配置。

适用于

Tencent Cloud SDK for Python

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

remove_proxy_server 方法

命名空间和模块：tencent.cloud.core.proxies.Proxies

简要

将一个已添加的代理服务器配置从代理服务器组中移除。

def remove_proxy_server(self,
    proxy_name: str
)

请注意，移除正在使用的代理服务器将引发 OccupiedError 异常。

参数

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

返回值

该方法没有返回值。

异常

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

ValueError

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

OccupiedError

正在移除的代理服务器配置正在使用。

适用于

Tencent Cloud SDK for Python

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

数据类型

ResponseMetadata 类型

命名空间和模块：tencent.cloud.core.client.BaseClient

简要

包含 Tencent Cloud API 响应元数据的字典类型。

{
    'request_id': '3c140219-cfe9-470e-b241-907877d6fb03'
}

成员

该数据类型包含的成员和成员描述如下：

适用于

Tencent Cloud SDK for Python

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

ProxyAuth 类型

命名空间和模块：tencent.cloud.core.proxies

简要

包含代理服务器访问凭据上下文的字典实例。

{
    'username': 'root',
    'password': 'default-password'
}

成员

该数据类型包含的成员和成员描述如下：

适用于

Tencent Cloud SDK for Python

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

ProxyType 枚举器

命名空间和模块：tencent.cloud.core.proxies

简要

包含受支持代理服务器类型名称成员的枚举器。

ErrorHandlerResult 枚举器

命名空间和模块：tencent.cloud.core.errors

简要

包含受支持错误处理器处理方式成员的枚举器。

成员

错误处理程序链短路是指当前错误处理器将是最后一个被调用的，错误管理器不再将该错误传递给后面的错误处理器（如果有）。

WaitableStatus 枚举器

命名空间和模块：tencent.cloud.core.errors

简要

包含受支持可等待操作对象状态成员的枚举器。

成员

异常

Error 异常

命名空间和模块：tencent.cloud.core.errors

简要

该异常类型为 Tencent Cloud SDK for Python 所有异常的基类，任何 Tencent Cloud SDK for Python 所主动引发的异常类型均基于该异常类型。

class Error(Exception)

继承：Exception 类

请注意，直接捕获该异常不是一个好主意。相反，您应该捕获您预期之内的异常并处理它。

属性

该异常类包含的可公开访问属性和属性描述如下：

适用于

Tencent Cloud SDK for Python

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

NotFoundError 异常

命名空间和模块：tencent.cloud.core.errors

简要

该异常指示给定资源不存在。

例如尝试切换 Proxies 实例的代理服务器时，给定的代理服务器名称不存在将引发此异常。

继承：tencent.cloud.core.errors.Error 类

适用于

Tencent Cloud SDK for Python

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

ExistedError 异常

命名空间和模块：tencent.cloud.core.errors

简要

该异常指示正在添加或创建的资源已存在。

例如尝试向 Proxies 实例添加重复名称的代理服务器时将引发此异常。

class ExistedError(Error)

继承：tencent.cloud.core.errors.Error 类

适用于

Tencent Cloud SDK for Python

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

OccupiedError 异常

命名空间和模块：tencent.cloud.core.errors

简要

该异常指示正在操作的资源正在使用（被占用）。

例如尝试将 Proxies 实例中正在使用的默认代理服务器移除时将引发此异常。

继承：tencent.cloud.core.errors.Error 类

适用于

Tencent Cloud SDK for Python

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

ClientError 异常

命名空间和模块：tencent.cloud.core.errors

简要

该异常指示 Tencent Cloud SDK for Python 提供的通用或抽象产品客户端错误，与其客户端相关联的异常类型将基于此异常类型。

继承：tencent.cloud.core.errors.Error 类

请注意，除非必要，否则直接捕获该异常或许并不是一个好主意。相反，您应该捕获您预期之内的异常并处理它。

适用于

Tencent Cloud SDK for Python

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

RequestError 异常

命名空间和模块：tencent.cloud.core.errors

简要

该异常指示 Tencent Cloud SDK for Python 提供的通用或抽象产品客户端在请求 Tencent Cloud API 时遇到错误，这通常是由于互联网连接原因所引起的。

class RequestError(ClientError)

继承：tencent.cloud.core.errors.ClientError 类

互联网连接正常？请尝试重试几次，如果依旧遇到该问题，请向我们的问题跟踪器提交一个缺陷。

适用于

Tencent Cloud SDK for Python

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

ResponseError 异常

命名空间和模块：tencent.cloud.core.errors

简要

该异常指示 Tencent Cloud SDK for Python 所提供的通用或抽象产品客户端请求 Tencent Cloud API 成功，但 Tencent Cloud API 响应内容结构不符合预期。

class ResponseError(ClientError)

继承：tencent.cloud.core.errors.ClientError 类

属性

该异常类包含的可公开访问属性和属性描述如下：

适用于

Tencent Cloud SDK for Python

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