中文 | English

Volcengine SDK for Python

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.53

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for volcengine-python-sdk 5.0.53
File	Size	Uploaded
volcengine_python_sdk-5.0.53.tar.gz	11.0 MB	Oct 15, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for volcengine-python-sdk 5.0.53
File	Interpreter	ABI	Platform	Reset
volcengine_python_sdk-5.0.53-py2.py3-none-any.whl 44.2 MB Oct 15, 2026	Python 2, Python 3	none	any	Details

Total release size: 55.1 MB

Release files / volcengine_python_sdk-5.0.53.tar.gz

Download URL	volcengine_python_sdk-5.0.53.tar.gz
Size	11.0 MB
Tags	Source
SHA-256 checksum How to use checksums	`451916ef54bd1b7304596ef0f3402d0a0c1d145ff0e87baa78b0066f8c31184f`
BLAKE2b-256 checksum How to use checksums	`db43d67198bb98e1e3eacac913022bc942e21dc61657442afa8b1f57761080b9`
Upload date	Oct 15, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.11.2`

Release files / volcengine_python_sdk-5.0.53-py2.py3-none-any.whl

Download URL	volcengine_python_sdk-5.0.53-py2.py3-none-any.whl
Size	44.2 MB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`3f366992f641c11f9644d00afb10dc372d7b705338c6c53d4187441c389494ea`
BLAKE2b-256 checksum How to use checksums	`07e813d4612e4d1619f2ae227cbd710595064ca5d860bf892e32eb7ccb2d2a05`
Upload date	Oct 15, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.11.2`