中文 | 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

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for volcengine from gravatar.com volcengine

Credits

Author: volc-engine

License expression

Apache-2.0
View SPDX License List

Requires

Python >=2.7

Provides Extra

ark

Tags

volcengine sdk

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

volcengine_python_sdk-5.0.44.tar.gz (10.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

volcengine_python_sdk-5.0.44-py2.py3-none-any.whl (41.6 MB view details)

Uploaded Python 2Python 3

File details

Details for the file volcengine_python_sdk-5.0.44.tar.gz.

File metadata

  • Download URL: volcengine_python_sdk-5.0.44.tar.gz
  • Upload date:
  • Size: 10.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for volcengine_python_sdk-5.0.44.tar.gz
Algorithm Hash digest
SHA256 f32856ecb6bc9d311d622628671f475ec8fa041c6f8267fa73a1ef5a2757f61f
MD5 21174475b0a1aa252e0e3ab8979f0959
BLAKE2b-256 1dbc94354d9785fdbe741c58cee01e582b04edc9d81e109b32ed1c677a1db2cc

See more details on using hashes here.

File details

Details for the file volcengine_python_sdk-5.0.44-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for volcengine_python_sdk-5.0.44-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7cf0277b016d23b8535480589790bc3c67863f36528b1c0f1933eeb60860245d
MD5 b5452dc344d9583e11f780b004288b3e
BLAKE2b-256 69ff6aee446d0aca46b6d02c9b875c9e68aff5be0f647918980004b566d6b800

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

5.0.44

5.0.43

5.0.42

5.0.41

5.0.40

5.0.39 yanked

Reason this release was yanked:

broken endpoint config

5.0.38

5.0.37

5.0.36

5.0.35

5.0.34

5.0.33

5.0.32

5.0.31

5.0.30

5.0.29

5.0.28

5.0.27

5.0.26

5.0.25

5.0.24

5.0.23

5.0.22

5.0.21

5.0.20

5.0.19

5.0.18

5.0.17

5.0.16

5.0.15

5.0.14

5.0.13

5.0.12

5.0.11

5.0.10

5.0.9

5.0.8

5.0.7

5.0.6

5.0.5

5.0.4

5.0.3

5.0.2

5.0.1

4.0.45

4.0.44

4.0.43

4.0.42

4.0.41

4.0.40 yanked

Reason this release was yanked:

No wheel package

4.0.39

4.0.38

4.0.37

4.0.36

4.0.35

4.0.34

4.0.33

4.0.32

4.0.31

4.0.30 yanked

Reason this release was yanked:

ark runtime can't install

4.0.29

4.0.28

4.0.27

4.0.26

4.0.25

4.0.24

4.0.23

4.0.22

4.0.21

4.0.20

4.0.19

4.0.18

4.0.17

4.0.16

4.0.15

4.0.14

4.0.13

4.0.12

4.0.11

4.0.10

4.0.9

4.0.8

4.0.7

4.0.6

4.0.5

4.0.4

4.0.3

4.0.2

4.0.1

3.0.15

3.0.14

3.0.13

3.0.12

3.0.11

3.0.10

3.0.9

3.0.8

3.0.7

3.0.6

3.0.5

3.0.4

3.0.3

3.0.2

3.0.1

2.0.2

2.0.1

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.0.130

1.0.129

1.0.128

1.0.127

1.0.126

1.0.125

1.0.124

1.0.123

1.0.122

1.0.121

1.0.120

1.0.119

1.0.118

1.0.117

1.0.116

1.0.115

1.0.114

1.0.113

1.0.112

1.0.111

1.0.110

1.0.109

1.0.108

1.0.107

1.0.106

1.0.105

1.0.104

1.0.103

1.0.102

1.0.101

1.0.100

1.0.99

1.0.98

1.0.97

1.0.96

1.0.95

1.0.94

1.0.93

1.0.92

1.0.91

1.0.90

1.0.89

1.0.88

1.0.87

1.0.86

1.0.85

1.0.84

1.0.83

1.0.82

1.0.81

1.0.80

1.0.79

1.0.78

1.0.77

1.0.76

1.0.75

1.0.74

1.0.73

1.0.72

1.0.71

1.0.70

1.0.69

1.0.68

1.0.67

1.0.66

1.0.65

1.0.64

1.0.63

1.0.62

1.0.61

1.0.60

1.0.59

1.0.58

1.0.57

1.0.56

1.0.55

1.0.54

1.0.53

1.0.52

1.0.51

1.0.50

1.0.49

1.0.48

1.0.47

1.0.46

1.0.45

1.0.44

1.0.43

1.0.42

1.0.41

1.0.40

1.0.39

1.0.38

1.0.37

1.0.36

1.0.35

1.0.34

1.0.33

1.0.32

1.0.31

1.0.30

1.0.29

1.0.28

1.0.27

1.0.26

1.0.25

1.0.24

1.0.23

1.0.22

1.0.21

1.0.20

1.0.19

1.0.18

1.0.17

1.0.16

1.0.15

1.0.14

1.0.13

1.0.12

1.0.11

1.0.10

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page