Metadata-Version: 2.4
Name: volcengine-python-sdk
Version: 5.0.51.post2
Summary: Volcengine SDK for Python (all services)
Home-page: https://github.com/volcengine/volcengine-python-sdk
Author: volc-engine
Author-email: volc-sdk-team@bytedance.com
License: Apache License 2.0
Platform: any
Requires-Python: >=2.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt
License-File: NOTICE.md
Requires-Dist: volcenginesdk-acep==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-advdefence==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-advdefence20230308==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-aidap==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-aiotvideo==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-aiotvideo20231001==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-alb==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-apig==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-apig20221112==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-apmplusserver==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-ark==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-arkclaw==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcengine-ark-runtime==5.0.51.post2; python_version >= "3.10"
Requires-Dist: volcenginesdk-autoscaling==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-billing==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-bio==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-bmq==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-bmq20240901==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-bytehousece20240831==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cbr==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cdn==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cen==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-certificateservice==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cfs==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-clawsentry==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-clb==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cloudcontrol==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-clouddetect==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-clouddetect20251031==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cloudidentity==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cloudmonitor==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cloudmonitor20251201==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cloudtrail==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cloudtrail20180101==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-config==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-core==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-coze20250601==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cp==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cpaas==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cr==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-cv20240606==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-dataleap==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-dataleap20260301==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-dbw==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-directconnect==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-dms==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-dms20250101==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-dns==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-dramart==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-dts==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-dts20180101==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-ecs==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-edx==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-efs==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-emr==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-escloud==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-fasttrack==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-filenas==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-flink20250101==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-fwcenter==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-ga==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-graph==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-graph20250815==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-gtm==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-hbase==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-httpdns==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-i18nopenapi==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-iam==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-iam20210801==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-id==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-insight==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-kafka==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-kms==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-livesaas==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-livesaas20230801==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-llmscan==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-llmshield==5.0.51.post2; python_version >= "3.8"
Requires-Dist: volcenginesdk-mcdn==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-mcs==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-mem0==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-metakms==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-milvus==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-mlplatform20240701==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-mongodb==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-na==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-natgateway==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-nta==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-organization==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-origindefence==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-partner==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-pca==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-pca20251001==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-privatelink==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-privatezone==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-quota==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-rabbitmq==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-rcs5g==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-rdsmssql==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-rdsmysql==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-rdsmysqlv2==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-rdspostgresql==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-redis==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-resourcecenter==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-resourceshare==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-rocketmq==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-secagent==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-seccenter==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-seccenter20240508==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-smc==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-spark==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-speechsaasprod==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-speechsaasprod20250521==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-sqs==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-storageebs==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-sts==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-tag==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-tidb==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-tis==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-transitrouter==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-translate20250301==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vedbm==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-veenedge==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vefaas==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vefaasdev==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-veiapi==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vepfs==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vikingdb==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vke==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vmp==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vms==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vod20250101==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vod20260101==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-volcobserve==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-volcsms==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vpc==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-vpn==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-waf==5.0.51.post2; python_version >= "2.7"
Requires-Dist: volcenginesdk-wafruntime==5.0.51.post2; python_version >= "2.7"
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

中文 | [English](README.EN.MD)

# Volcengine SDK for Python

## 目录

* Requirements
* Install
* Usage
* FAQ

### Requirements ###

* Python 版本需要不低于2.7。
* 如使用方舟服务（`arkruntime`），Python 版本需要不低于 3.10。

### Install ###

Install via pip

```sh
pip install volcengine-python-sdk
```

`volcengine-python-sdk` 是安装全部服务的兼容元包。仅使用单个产品时可按需安装，
例如 ECS：

```sh
pip install volcenginesdk-ecs
```

分包不会改变 Python 导入路径，已有的 `import volcenginesdkecs` 无需修改。
完整设计、包名映射和发布流程见[分包设计](./docs/package-splitting-zh.md)。

如需使用方舟，请安装官方 Ark Runtime 包：

```sh
pip install arkruntime
```

### Usage ###

#### 详细使用文档 ####

SDK 详细使用文档（凭证配置、Endpoint、Transport、超时、重试、异常处理、Debug）请参考：[SDK 接入文档](./docs/0-Overview-zh.md)

#### Configuration Usage ####

步骤一：启动时初始化，配置 Configuration 全局默认参数

```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

```python
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，可以按照以下示例代码设置：

```python
configuration = volcenginesdkcore.Configuration()
configuration.host = 'ecs.cn-beijing-autodriving.volcengineapi.com'
```

火山引擎标准的Endpoint规则说明：

| Regional 服务                                                                                                                            | Global 服务                                                                          |
|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
| `{service}.{region}.volcengineapi.com` <br> 例如：云服务ecs在cn-beijing-autodriving Region域名为： `ecs.cn-beijing-autodriving.volcengineapi.com` | `{service}.volcengineapi.com` <br> 例如：访问控制iam为Global服务，域名为：`iam.volcengineapi.com` |

注：

- Service中存在_符号时，Endpoint时需转为-符号。存在大写字母时需转成小写。

#### 完整示例 ####

```python
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](FAQ.md)

## Security and privacy
This project takes security seriously. 
For vulnerability reporting and supported versions, see [SECURITY.md](SECURITY.md)
