Volcengine SDK for Python
Project Links
Meta
Author: volc-engine
Requires Python: >=2.7
Classifiers
中文 | English
Volcengine SDK for Python
目录
- Requirements
- Install
- Usage
- FAQ
Requirements
- Python 版本需要不低于2.7。
- 如使用方舟服务(
arkruntime),Python 版本需要不低于 3.6。
Install
Install via pip
pip install volcengine-python-sdk
如需使用方舟,请安装 Ark 可选依赖:
pip install "volcengine-python-sdk[ark]"
Usage
详细使用文档
SDK 详细使用文档(凭证配置、Endpoint、Transport、超时、重试、异常处理、Debug)请参考:SDK 接入文档
Configuration Usage
步骤一:启动时初始化,配置 Configuration 全局默认参数
import volcenginesdkautoscaling
import volcenginesdkcore
configuration = volcenginesdkcore.Configuration()
configuration.client_side_validation = True # 客户端是否进行参数校验
configuration.scheme = "https" # https or http
configuration.debug = False # 是否开启调试
configuration.logger_file = "sdk.log"
volcenginesdkcore.Configuration.set_default(configuration)
步骤二:获取 Client
def get_client(ak, sk, region):
# 包含默认属性
configuration = volcenginesdkcore.Configuration()
configuration.ak = ak
configuration.sk = sk
configuration.region = region
client = volcenginesdkautoscaling.AUTOSCALINGApi(volcenginesdkcore.ApiClient(configuration))
return client
Endpoint 设置
如果您要自定义SDK的Endpoint,可以按照以下示例代码设置:
configuration = volcenginesdkcore.Configuration()
configuration.host = 'ecs.cn-beijing-autodriving.volcengineapi.com'
火山引擎标准的Endpoint规则说明:
| Regional 服务 | Global 服务 |
|---|---|
{service}.{region}.volcengineapi.com 例如:云服务ecs在cn-beijing-autodriving Region域名为: ecs.cn-beijing-autodriving.volcengineapi.com |
{service}.volcengineapi.com 例如:访问控制iam为Global服务,域名为: iam.volcengineapi.com |
注:
- Service中存在_符号时,Endpoint时需转为-符号。存在大写字母时需转成小写。
完整示例
from __future__ import print_function
import volcenginesdkecs
import volcenginesdkcore
from pprint import pprint
from volcenginesdkcore.rest import ApiException
if __name__ == '__main__':
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "cn-beijing"
configuration.client_side_validation = True
# set default configuration
volcenginesdkcore.Configuration.set_default(configuration)
# use global default configuration
api_instance = volcenginesdkecs.ECSApi()
# use custom configuration
# api_instance = volcenginesdkecs.ECSApi(volcenginesdkcore.ApiClient(configuration))
try:
resp = api_instance.run_instances(
volcenginesdkecs.RunInstancesRequest(
instance_name="insname",
instance_type="ecs.g1.large",
zone_id="cn-beijing-a",
network_interfaces=[volcenginesdkecs.NetworkInterfaceForRunInstancesInput(
subnet_id="subnet-2d68bh73d858ozfekrm8fj",
security_group_ids=["sg-2b3dq7v0ha0w2dx0eg0nhljv"],
)],
image_id="image-ybvz29l3da4ox5h0m9",
volumes=[volcenginesdkecs.VolumeForRunInstancesInput(
volume_type="ESSD",
size=40,
)],
key_pair_name="vtable",
instance_charge_type="PostPaid"
))
pprint(resp)
except ApiException as e:
print("Exception when calling ECSApi->run_instances: %s\n" % e)
FAQ
关于 SDK 使用时碰到的常见问题,请查看 FAQ
Security and privacy
This project takes security seriously. For vulnerability reporting and supported versions, see SECURITY.md
5.0.43
Jul 30, 2026
5.0.42
Jul 23, 2026
5.0.41
Jul 16, 2026
5.0.40
Jul 09, 2026
5.0.39
Jul 09, 2026
5.0.38
Jul 06, 2026
5.0.37
Jul 02, 2026
5.0.36
Jun 26, 2026
5.0.35
Jun 17, 2026
5.0.34
Jun 11, 2026
5.0.33
Jun 04, 2026
5.0.32
Jun 04, 2026
5.0.31
May 29, 2026
5.0.30
May 28, 2026
5.0.29
May 25, 2026
5.0.28
May 21, 2026
5.0.27
May 14, 2026
5.0.26
May 07, 2026
5.0.25
Apr 23, 2026
5.0.24
Apr 16, 2026
5.0.23
Apr 09, 2026
5.0.22
Apr 02, 2026
5.0.21
Mar 26, 2026
5.0.20
Mar 24, 2026
5.0.19
Mar 20, 2026
5.0.18
Mar 19, 2026
5.0.17
Mar 16, 2026
5.0.16
Mar 12, 2026
5.0.15
Mar 10, 2026
5.0.14
Mar 09, 2026
5.0.13
Mar 02, 2026
5.0.12
Feb 27, 2026
5.0.11
Feb 26, 2026
5.0.10
Feb 25, 2026
5.0.9
Feb 05, 2026
5.0.8
Jan 29, 2026
5.0.7
Jan 22, 2026
5.0.6
Jan 15, 2026
5.0.5
Jan 09, 2026
5.0.4
Jan 08, 2026
5.0.3
Dec 30, 2025
5.0.2
Dec 29, 2025
5.0.1
Dec 25, 2025
4.0.45
Dec 25, 2025
4.0.44
Dec 22, 2025
4.0.43
Dec 16, 2025
4.0.42
Dec 11, 2025
4.0.41
Dec 09, 2025
4.0.40
Dec 08, 2025
4.0.39
Dec 05, 2025
4.0.38
Dec 04, 2025
4.0.37
Dec 04, 2025
4.0.36
Nov 27, 2025
4.0.35
Nov 20, 2025
4.0.34
Nov 13, 2025
4.0.33
Nov 06, 2025
4.0.32
Nov 06, 2025
4.0.31
Oct 30, 2025
4.0.30
Oct 30, 2025
4.0.29
Oct 27, 2025
4.0.28
Oct 27, 2025
4.0.27
Oct 23, 2025
4.0.26
Oct 17, 2025
4.0.25
Oct 16, 2025
4.0.24
Oct 13, 2025
4.0.23
Oct 09, 2025
4.0.22
Sep 25, 2025
4.0.21
Sep 18, 2025
4.0.20
Sep 12, 2025
4.0.19
Sep 11, 2025
4.0.18
Sep 11, 2025
4.0.17
Sep 09, 2025
4.0.16
Sep 04, 2025
4.0.15
Aug 28, 2025
4.0.14
Aug 26, 2025
4.0.13
Aug 22, 2025
4.0.12
Aug 21, 2025
4.0.11
Aug 14, 2025
4.0.10
Aug 07, 2025
4.0.9
Aug 01, 2025
4.0.8
Jul 31, 2025
4.0.7
Jul 24, 2025
4.0.6
Jul 17, 2025
4.0.5
Jul 10, 2025
4.0.4
Jul 03, 2025
4.0.3
Jun 30, 2025
4.0.2
Jun 26, 2025
4.0.1
Jun 23, 2025
3.0.15
Jun 19, 2025
3.0.14
Jun 17, 2025
3.0.13
Jun 16, 2025
3.0.12
Jun 13, 2025
3.0.11
Jun 10, 2025
3.0.10
Jun 09, 2025
3.0.9
Jun 05, 2025
3.0.8
Jun 03, 2025
3.0.7
May 29, 2025
3.0.6
May 29, 2025
3.0.5
May 27, 2025
3.0.4
May 23, 2025
3.0.3
May 22, 2025
3.0.2
May 15, 2025
3.0.1
May 14, 2025
2.0.2
May 08, 2025
2.0.1
Apr 28, 2025
1.1.6
Apr 24, 2025
1.1.5
Apr 17, 2025
1.1.4
Apr 14, 2025
1.1.3
Apr 10, 2025
1.1.2
Mar 31, 2025
1.1.1
Mar 27, 2025
1.0.130
Mar 20, 2025
1.0.129
Mar 13, 2025
1.0.128
Mar 06, 2025
1.0.127
Mar 06, 2025
1.0.126
Feb 27, 2025
1.0.125
Feb 20, 2025
1.0.124
Feb 13, 2025
1.0.123
Feb 06, 2025
1.0.122
Jan 23, 2025
1.0.121
Jan 16, 2025
1.0.120
Jan 09, 2025
1.0.119
Jan 02, 2025
1.0.118
Dec 26, 2024
1.0.117
Dec 23, 2024
1.0.116
Dec 20, 2024
1.0.115
Dec 16, 2024
1.0.114
Dec 11, 2024
1.0.113
Dec 10, 2024
1.0.112
Dec 05, 2024
1.0.111
Nov 28, 2024
1.0.110
Nov 21, 2024
1.0.109
Nov 14, 2024
1.0.108
Nov 07, 2024
1.0.107
Oct 31, 2024
1.0.106
Oct 24, 2024
1.0.105
Oct 17, 2024
1.0.104
Oct 10, 2024
1.0.103
Sep 26, 2024
1.0.102
Sep 19, 2024
1.0.101
Sep 12, 2024
1.0.100
Sep 05, 2024
1.0.99
Aug 29, 2024
1.0.98
Aug 22, 2024
1.0.97
Aug 19, 2024
1.0.96
Aug 15, 2024
1.0.95
Aug 08, 2024
1.0.94
Jul 25, 2024
1.0.93
Jul 18, 2024
1.0.92
Jul 11, 2024
1.0.91
Jul 04, 2024
1.0.90
Jun 27, 2024
1.0.89
Jun 25, 2024
1.0.88
Jun 24, 2024
1.0.87
Jun 13, 2024
1.0.86
Jun 06, 2024
1.0.85
Jun 03, 2024
1.0.84
May 30, 2024
1.0.83
May 24, 2024
1.0.82
May 23, 2024
1.0.81
May 20, 2024
1.0.80
May 16, 2024
1.0.79
May 10, 2024
1.0.78
May 09, 2024
1.0.77
Apr 29, 2024
1.0.76
Apr 25, 2024
1.0.75
Apr 18, 2024
1.0.74
Apr 11, 2024
1.0.73
Apr 01, 2024
1.0.72
Mar 25, 2024
1.0.71
Mar 22, 2024
1.0.70
Mar 21, 2024
1.0.69
Mar 14, 2024
1.0.68
Mar 07, 2024
1.0.67
Feb 29, 2024
1.0.66
Feb 22, 2024
1.0.65
Feb 05, 2024
1.0.64
Feb 01, 2024
1.0.63
Jan 18, 2024
1.0.62
Jan 04, 2024
1.0.61
Dec 28, 2023
1.0.60
Dec 21, 2023
1.0.59
Dec 14, 2023
1.0.58
Dec 07, 2023
1.0.57
Nov 30, 2023
1.0.56
Nov 09, 2023
1.0.55
Nov 06, 2023
1.0.54
Nov 02, 2023
1.0.53
Nov 01, 2023
1.0.52
Oct 30, 2023
1.0.51
Oct 20, 2023
1.0.50
Oct 20, 2023
1.0.49
Oct 20, 2023
1.0.48
Oct 19, 2023
1.0.47
Oct 12, 2023
1.0.46
Oct 10, 2023
1.0.45
Sep 28, 2023
1.0.44
Sep 26, 2023
1.0.43
Sep 21, 2023
1.0.42
Sep 11, 2023
1.0.41
Sep 07, 2023
1.0.40
Sep 07, 2023
1.0.39
Aug 29, 2023
1.0.38
Aug 24, 2023
1.0.37
Aug 16, 2023
1.0.36
Aug 16, 2023
1.0.35
Aug 08, 2023
1.0.34
Aug 08, 2023
1.0.33
Aug 01, 2023
1.0.32
Jul 31, 2023
1.0.31
Jul 28, 2023
1.0.30
Jul 27, 2023
1.0.29
Jul 27, 2023
1.0.28
Jul 25, 2023
1.0.27
Jul 24, 2023
1.0.26
Jul 19, 2023
1.0.25
Jul 19, 2023
1.0.24
Jul 18, 2023
1.0.23
Jul 13, 2023
1.0.22
Jul 03, 2023
1.0.21
Jun 28, 2023
1.0.20
Jun 25, 2023
1.0.19
May 31, 2023
1.0.18
May 25, 2023
1.0.17
May 24, 2023
1.0.16
May 16, 2023
1.0.15
May 09, 2023
1.0.14
Apr 25, 2023
1.0.13
Apr 25, 2023
1.0.12
Apr 25, 2023
1.0.11
Apr 18, 2023
1.0.10
Apr 06, 2023
1.0.9
Mar 28, 2023
1.0.8
Mar 14, 2023
1.0.7
Mar 14, 2023
1.0.6
Mar 08, 2023
1.0.5
Mar 06, 2023
1.0.4
Feb 21, 2023
1.0.3
Feb 20, 2023
1.0.2
Jan 18, 2023
1.0.1
Dec 27, 2022
1.0.0
Dec 21, 2022