Python SDK

最近更新时间：2023.06.08 19:53:06

首次发布时间：2023.06.02 17:29:58

本文介绍了如何安装 Python SDK。

执行以下命令安装 Python SDK：

pip install --user volcengine

如果您已经安装了该 SDK 包，可以使用以下命令对其进行升级：

pip install --upgrade volcengine

您可以通过下面的表格查看 Python SDK 的示例代码。
具体的参数解释，请参考相应 API 文档。

说明

Python SDK 的示例代码存放于 example 目录下。如需设置 Access Key，请使用 example 目录下的 __init__.py 文件。如需获取账号的 Access Key，请参考 Access Key（密钥）管理。

功能	示例代码（GitHub 链接）	参数解释（API 文档链接）
创建边缘服务	create_cloudserver.py	CreateCloudServer
创建边缘实例	create_instance.py	CreateInstance
删除边缘服务	delete_cloudserver.py	DeleteCloudServer
查询边缘服务	get_cloudserver.py	GetCloudServer
获取边缘实例详情	get_instance.py	GetInstance
获取边缘实例的云盘信息	get_instance_cloud_disk_info.py	GetInstanceCloudDiskInfo
获取某实例规格可开通的区域和运营商	list_available_resource_info.py	ListAvailableResourceInfo
获取边缘服务列表	list_cloudservers.py	ListCloudServers
获取可开通的实例规格	list_instance_types.py	ListInstanceTypes
获取边缘实例列表	list_instances.py	ListInstances
删除边缘实例	offline_instances.py	OfflineInstances
重启边缘服务	reboot_cloudserver.py	RebootCloudServer
重启边缘实例	reboot_instances.py	RebootInstances
重置边缘实例密码	reset_login_credential.py	ResetLoginCredential
扩容边缘实例的云盘	scale_instance_cloud_disk_capacity.py	ScaleInstanceCloudDiskCapacity
编辑边缘实例名称	set_instance_name.py	SetInstanceName
启动边缘服务	start_cloudserver.py	StartCloudServer
启动边缘实例	start_instances.py	StartInstances
停止边缘服务	stop_cloudserver.py	StopCloudServer
停止边缘实例	stop_instances.py	StopInstances

前提条件

安装步骤

示例代码