1 / 5

Client 类

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

简要

代表无服务器数据库产品客户端的类。通过利用无服务器数据库产品客户端，您可以以同步或异步面向对象编程的方式快速访问无服务器数据库产品。

class Client(client.UniversalClient)

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

构造

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

def __init__(self,
    access_credentials = None,
    access_proiexs = None
)

参数

类型

必选

描述

access_credentials

Credentials

否

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

access_proiexs

否

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

属性

该类可公开访问的属性继承自通用产品客户端，请参阅 UniversalClient 类的属性：

示例

在下文中，我们将向您演示如何正确地构造一个无服务器数据库客户端实例并使用它：

from tencent.cloud.auth import credentials
from tencent.cloud.serverless import database

# Please replace with your access credentials

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

client: database.Client = database.Client(
    access_credentials = access_credentials
)

instance_info: dict = client.create_instance(
    region_id = 'ap-shanghai',
    zone_id = 'ap-shanghai-2',
    instance_name = 'default',
    instance_configure = {
        'database': {
            'version': '10.4',
            'charset': database.DatabaseCharset.UTF8
        },
        'vpc': {
            'id': 'vpc-f7qfb64q',
            'subnet_id': 'subnet-aieh8myj'
        }
    }
)

print('database instance id: ' + str(instance_info['id']))

通常情况下，建议您使用环境凭证或文件凭证，而不是将访问凭证硬编码。与无服务器云函数产品客户端一样，您可以使用 fetch_client 函数获取适用于当前超线程的无服务器数据库产品客户端实例。

client = database.fetch_client()

适用于

Tencent Cloud SDK for Python

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

create_instance 方法

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

简要

创建一个新的无服务器数据库实例。

def create_instance(self,
    region_id: str,
    zone_id: str,
    instance_name: str,
    instance_configure: dict = None
) -> dict

参数

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

参数

类型

必选

描述

region_id

str

是

创建的无服务器数据库实例目的数据中心园区唯一标识符。

例如：ap-shanghai

zone_id

str

是

创建的无服务器数据库实例目的数据中心可用区唯一标识符。

例如：ap-shanghai-2

instance_name

str

是

创建的无服务器数据库实例名称。

例如：default

instance_configure

否

创建的无服务器数据库实例配置。

返回值

该方法返回包含创建的无服务器数据库实例元数据信息的字典实例，其数据类型为 InstanceInfo。

请注意，受限于 Tencent Cloud API，该方法目前仅支持返回实例 ID。

异常

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

ValueError

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

示例

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

instance_info: dict = client.create_instance(
    region_id = 'ap-shanghai',
    zone_id = 'ap-shanghai-2',
    instance_name = 'unit-test',
    instance_configure = {
        'database': {
            'version': '10.4',
            'charset': database.DatabaseCharset.UTF8
        },
        'vpc': {
            'id': 'vpc-f7qfb64q',
            'subnet_id': 'subnet-aieh8myj'
        }
    }
)

# 请注意，目前字典 instance_info 仅包含成员 'id'。

print(instance_info['id'])

适用于

Tencent Cloud SDK for Python

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

delete_instance 方法

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

简要

删除（销毁）一个已经创建就绪的无服务器数据库实例。

def delete_instance(self,
    region_id: str,
    instance_id: str
)

参数

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

参数

类型

必选

描述

region_id

str

是

删除的无服务器数据库实例所在数据中心园区唯一标识符。

例如：ap-shanghai

instance_id

str

是

删除的无服务器数据库实例唯一标识符。

例如：postgres-8nb6q9hm

返回值

该方法没有返回值。

异常

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

ValueError

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

示例

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

client.delete_instance(
    region_id = 'ap-shanghai',
    instance_id = 'postgres-8nb6q9hm'
)

适用于

Tencent Cloud SDK for Python

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

list_instances 方法

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

简要

列出给定数据中心园区内已创建的无服务器数据库实例信息。

def list_instances(self,
    region_id: str
)

参数

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

参数

类型

必选

描述

region_id

str

是

列出的无服务器数据库实例所在数据中心园区唯一标识符。

例如：ap-shanghai

返回值

该方法返回一个用于遍历一个或多个无服务器数据库实例信息的生成器实例，生成器实例每次迭代返回包含无服务器数据库实例信息的字典实例，其数据类型为 InstanceInfo。

该方法在内部维护一个缓冲循环，每次使用 Tencent Cloud API 检索并获取 20 条符合条件的无服务器数据库信息。

异常

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

ValueError

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

示例

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

for info in client.list_instances('ap-shanghai'):
    print(info)

适用于

Tencent Cloud SDK for Python

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

set_instance_extranet 方法

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

简要

设置给的无服务器数据库实例是否允许通过外联网（公网）访问。

def set_instance_extranet(self,
    region_id: str,
    instance_id: str,
    instance_extranet: bool = True
)

参数

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

参数

类型

必选

描述

region_id

str

是

设置的无服务器数据库实例所在数据中心园区唯一标识符。

例如：ap-shanghai

instance_id

str

是

设置的无服务器数据库实例唯一标识符。

例如：postgres-8nb6q9hm

instance_extranet

bool

否

无服务器数据库实例是否允许通过外联网（公网）访问。

如果忽略该参数，默认值为 True。

返回值

该方法没有返回值。

异常

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

ValueError

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

示例

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

client.set_instance_extranet(
    region_id = 'ap-shanghai',
    instance_id = 'postgres-8nb6q9hm',
    instance_extranet = True
)

适用于

Tencent Cloud SDK for Python

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

create_instance 方法

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

简要

创建一个新的无服务器数据库实例。

def create_instance(self,
    region_id: str,
    zone_id: str,
    instance_name: str,
    instance_configure: dict = None
) -> dict

参数

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

参数

类型

必选

描述

region_id

str

是

创建的无服务器数据库实例目的数据中心园区唯一标识符。

例如：ap-shanghai

zone_id

str

是

创建的无服务器数据库实例目的数据中心可用区唯一标识符。

例如：ap-shanghai-2

instance_name

str

是

创建的无服务器数据库实例名称。

例如：default

instance_configure

否

创建的无服务器数据库实例配置。

返回值

该方法返回包含创建的无服务器数据库实例元数据信息的字典实例，其数据类型为 InstanceInfo。

请注意，受限于 Tencent Cloud API，该方法目前仅支持返回实例 ID。

异常

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

ValueError

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

示例

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

instance_info: dict = client.create_instance(
    region_id = 'ap-shanghai',
    zone_id = 'ap-shanghai-2',
    instance_name = 'unit-test',
    instance_configure = {
        'database': {
            'version': '10.4',
            'charset': database.DatabaseCharset.UTF8
        },
        'vpc': {
            'id': 'vpc-f7qfb64q',
            'subnet_id': 'subnet-aieh8myj'
        }
    }
)

# 请注意，目前字典 instance_info 仅包含成员 'id'。

print(instance_info['id'])

适用于

Tencent Cloud SDK for Python

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

Client 类

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

简要

代表无服务器数据库产品客户端的类。通过利用无服务器数据库产品客户端，您可以以同步或异步面向对象编程的方式快速访问无服务器数据库产品。

class Client(client.UniversalClient)

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

构造

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

def __init__(self,
    access_credentials = None,
    access_proiexs = None
)

参数

类型

必选

描述

access_credentials

Credentials

否

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

access_proiexs

否

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

属性

该类可公开访问的属性继承自通用产品客户端，请参阅 UniversalClient 类的属性：

UniversalClient 类

示例

在下文中，我们将向您演示如何正确地构造一个无服务器数据库客户端实例并使用它：

from tencent.cloud.auth import credentials
from tencent.cloud.serverless import database

# Please replace with your access credentials

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

client: database.Client = database.Client(
    access_credentials = access_credentials
)

instance_info: dict = client.create_instance(
    region_id = 'ap-shanghai',
    zone_id = 'ap-shanghai-2',
    instance_name = 'default',
    instance_configure = {
        'database': {
            'version': '10.4',
            'charset': database.DatabaseCharset.UTF8
        },
        'vpc': {
            'id': 'vpc-f7qfb64q',
            'subnet_id': 'subnet-aieh8myj'
        }
    }
)

print('database instance id: ' + str(instance_info['id']))

client = database.fetch_client()

适用于

Tencent Cloud SDK for Python

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