Python SDK--存储迁移服务-火山引擎

文档中心

导航

Python SDK

最近更新时间：2024.12.31 11:38:21首次发布时间：2024.10.30 10:16:31

本文介绍 Python SDK 的注意事项、安装方式和初始化示例。

注意事项

Python 需要至少 2.7 或以上版本。
由于 Windows 系统有最长路径限制，可能会导致安装失败，请按照以下方式设置：

1. 按下 Win+R ，输入 regedit 打开注册表编辑器。
2. 设置 \HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem 路径下的变量 LongPathsEnabled 为 1。

SDK 地址

您可以使用 Python SDK 调用 OpenAPI，关于 Python SDK 地址，请参见 Python SDK。

安装 Python SDK

执行以下命令，通过 pip 安装 Python SDK。

pip install volcengine-python-sdk

配置长期访问凭证

初始化 SDK 前，您需要先配置长期访问凭证。本章节介绍不同操作系统下配置长期访问凭证的操作步骤。

macOS

Linux

Windows

打开终端并执行以下命令打开文件。

nano ~/.bash_profile

在文件末尾添加 AKSK 信息。

export TOS_ACCESS_KEY=AKTPYmI1Z****
export TOS_SECRET_KEY=T1dJM01UU****

保存文件并退出。
执行以下命令生效配置信息。

source ~/.bash_profile

执行以下命令验证配置信息。

echo $TOS_ACCESS_KEY
echo $TOS_SECRET_KEY

如果配置成功，则返回如下示例：

AKTPYmI1Z****
T1dJM01UU****

打开终端并执行以下命令打开文件。

sudo vim /etc/profile

在文件末尾添加 AKSK 信息。

export TOS_ACCESS_KEY=AKTPYmI1Z****
export TOS_SECRET_KEY=T1dJM01UU****

保存文件并退出。
执行以下命令生效配置信息。

source /etc/profile

执行以下命令验证配置信息。

echo $TOS_ACCESS_KEY
echo $TOS_SECRET_KEY

如果配置成功，则返回如下示例：

AKTPYmI1Z****
T1dJM01UU****

打开命令行工具，执行以下命令，添加 AKSK 信息。

set TOS_ACCESS_KEY=AKTPYmI1Z****
set TOS_SECRET_KEY=T1dJM01UU****

执行以下命令生效配置信息。

setx TOS_ACCESS_KEY "%TOS_ACCESS_KEY%"
setx TOS_SECRET_KEY "%TOS_SECRET_KEY%"

重启命令行工具，然后执行以下命令验证配置信息。

echo %TOS_ACCESS_KEY%
echo %TOS_SECRET_KEY%

如果配置成功，则返回如下示例：

AKTPYmI1Z****
T1dJM01UU****

初始化示例

from __future__ import print_function
import volcenginesdkdms
import volcenginesdkcore
from pprint import pprint
from volcenginesdkcore.rest import ApiException

if __name__ == '__main__':
    configuration = volcenginesdkcore.Configuration()
    configuration.ak = os.getenv("AK")
    configuration.sk = os.getenv("SK")
    configuration.region = "the region your target bucket in"
    configuration.client_side_validation = True

    # set default configuration
    volcenginesdkcore.Configuration.set_default(configuration)

    # use global default configuration
    api_instance = volcenginesdkdms.DMSApi()
    # use custom configuration
    # api_instance = volcenginesdkecs.ECSApi(volcenginesdkcore.ApiClient(configuration))

    try:
        resp = api_instance.list_data_migrate_task(volcenginesdkdms.ListDataMigrateTaskRequest(offset=0,limit=10))
        pprint(resp)
    except ApiException as e:
        print("Exception when calling DMSApi->list_data_migrate_task: %s\n" % e)