This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 5.0.53 instead.
中文 | English
Volcengine SDK for Python
目录
- Requirements
- Install
- Usage
- FAQ
Requirements
- Python 版本需要不低于2.7。
- 如使用方舟服务(
arkruntime),Python 版本需要不低于 3.10。
Install
Install via pip
pip install volcengine-python-sdk
volcengine-python-sdk 是安装全部服务的兼容元包。仅使用单个产品时可按需安装,
例如 ECS:
pip install volcenginesdk-ecs
分包不会改变 Python 导入路径,已有的 import volcenginesdkecs 无需修改。
完整设计、包名映射和发布流程见分包设计。
如需使用方舟,请安装官方 Ark Runtime 包:
pip install arkruntime
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
Metadata
Release files for volcengine-python-sdk 5.0.51.post1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| volcengine_python_sdk-5.0.51.post1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Release files / volcengine_python_sdk-5.0.51.post1-py2.py3-none-any.whl
| Download URL | volcengine_python_sdk-5.0.51.post1-py2.py3-none-any.whl |
|---|---|
| Size | 8.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
024da6d7720af66c92383124897dd138e90eb647908bd1c980d87a4678b350e9
|
|
BLAKE2b-256 checksum How to use checksums |
01d7ce8117afbf0be5f6db435c89667a524d03b3f8cb78f1f07cdbe7b234797c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.2
|