中文 | 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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file volcengine_python_sdk-5.0.46.tar.gz.
File metadata
- Download URL: volcengine_python_sdk-5.0.46.tar.gz
- Upload date:
- Size: 10.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3d7ee12ad559d07bb53a160b4ba98feaeee09f4a03d87a86855b162571ff717a
|
|
| MD5 |
f4edba3e196a8837d315f1c3b2dece6a
|
|
| BLAKE2b-256 |
6ec62094e5ef1303393aa78599cd750f95f32143643ee330ddfe0b23faaf59fd
|
File details
Details for the file volcengine_python_sdk-5.0.46-py2.py3-none-any.whl.
File metadata
- Download URL: volcengine_python_sdk-5.0.46-py2.py3-none-any.whl
- Upload date:
- Size: 43.0 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f73e8f675f9ff545d0fec54b7057436dba0f1c420fcb235848a76a5120e5bf18
|
|
| MD5 |
547d4f703983bb4084113966680a0439
|
|
| BLAKE2b-256 |
e4f0171e760424849eabfe735c4b37e29949b2279555dd1654819db973ee7be7
|
