{"id":19411528,"url":"https://github.com/volcengine/volcengine-python-sdk","last_synced_at":"2026-04-16T14:00:48.140Z","repository":{"id":42998411,"uuid":"510985041","full_name":"volcengine/volcengine-python-sdk","owner":"volcengine","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-26T12:08:47.000Z","size":16994,"stargazers_count":164,"open_issues_count":5,"forks_count":28,"subscribers_count":5,"default_branch":"master","last_synced_at":"2026-03-27T04:53:25.334Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/volcengine.png","metadata":{"files":{"readme":"README.EN.MD","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE.md","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-07-06T04:17:57.000Z","updated_at":"2026-03-26T12:08:58.000Z","dependencies_parsed_at":"2024-01-18T14:08:26.185Z","dependency_job_id":"b2622a06-b582-43bc-a2f3-9e0a367ad1c3","html_url":"https://github.com/volcengine/volcengine-python-sdk","commit_stats":{"total_commits":62,"total_committers":1,"mean_commits":62.0,"dds":0.0,"last_synced_commit":"92d39a4ef63be6e43898bb988651da24df69f0fb"},"previous_names":[],"tags_count":219,"template":false,"template_full_name":null,"purl":"pkg:github/volcengine/volcengine-python-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolcengine-python-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolcengine-python-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolcengine-python-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolcengine-python-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/volcengine","download_url":"https://codeload.github.com/volcengine/volcengine-python-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolcengine-python-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31888935,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T11:36:10.202Z","status":"ssl_error","status_checked_at":"2026-04-16T11:36:09.652Z","response_time":69,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T12:21:51.677Z","updated_at":"2026-04-16T14:00:48.122Z","avatar_url":"https://github.com/volcengine.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Volcengine SDK for Python\n\n## 非兼容升级通知\n\nVolcengine SDK for Python 非兼容升级通知\n\n影响版本：`3.0.1` 以及后续版本\n\n变更描述:\n\n为了优化SDK包文件目录多长，导致在 `Window` 系统安装失败的问题。\n\n从 `3.0.1` 版本开始，我们对 `transitrouter` 服务下的部分超长的 API model 文件名称进行了缩减，如果您之前依赖并使用了这些 API model 的完整文件名称，将会导致不兼容，建议您按照如下方式使用 API model：\n\n```python\nfrom volcenginesdktransitrouter import TransitRouterBandwidthPackageForDescribeTransitRouterBandwidthPackagesOutput\n\nvar = TransitRouterBandwidthPackageForDescribeTransitRouterBandwidthPackagesOutput()\n```\n\n本次升级影响的云服务和接口：\n\nService： `transitrouter`\n\nVersion:  `2020-04-01`\n\nAPI:\n- DescribeTransitRouterBandwidthPackages\n- DescribeTransitRouterRoutePolicyTables\n- DescribeTransitRouterRoutePolicyEntries\n- DescribeTransitRouterForwardPolicyTables\n- DescribeTransitRouterBandwidthPackagesBilling\n- DescribeTransitRouterDirectConnectGatewayAttachments\n- DescribeTransitRouterRouteTableAssociations\n- DescribeTransitRouterRouteTablePropagations\n- DescribeTransitRouterTrafficQosQueueEntries\n- DescribeTransitRouterTrafficQosQueuePolicies\n- DescribeTransitRouterTrafficQosMarkingEntries\n- DescribeTransitRouterTrafficQosMarkingPolicies\n\n--------\n\n影响版本：`2.0.1` 以及后续版本\n\n变更描述:\n\n从 `2.0.1` 版本开始，发起请求将默认从使用 `HTTP` 协议变成使用 `HTTPS` 协议，请升级到新版本的用户注意是否会产生兼容性风险，做好充分测试。如需继续使用\n`HTTP` 协议，请在发起请求时指定 `scheme` 参数为 `http`(不推荐):\n\n```python\nimport volcenginesdkcore\n\nconfiguration = volcenginesdkcore.Configuration()\nconfiguration.scheme = 'http'\n```\n\n## Table of Contents\n\n* Requirements\n* Install\n* Usage\n* FAQ\n\n### Requirements ###\n\n* Python版本需要不低于2.7。\n* 由于 Windows 系统有最长路径限制，可能会导致安装失败，请按照以下方式设置：\n\n```\n1. 按下 Win+R ，输入 regedit 打开注册表编辑器。\n2. 设置 \\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Control\\FileSystem 路径下的变量 LongPathsEnabled 为 1 即可。\n```\n\n### Install ###\n\nInstall via pip\n\n```sh\npip install volcengine-python-sdk\n```\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n\n(or `sudo python setup.py install` to install the package for all users)\n\n### Configuration Usage ###\n\n步骤一：启动时初始化，配置 Configuration 全局默认参数\n\n```python\nconfiguration = volcenginesdkcore.Configuration()\nconfiguration.client_side_validation = True  # 客户端是否进行参数校验\nconfiguration.schema = \"http\"  # https or http\nconfiguration.debug = False  # 是否开启调试\nconfiguration.logger_file = \"sdk.log\"\n\nvolcenginesdkcore.Configuration.set_default(configuration)\n```\n\n步骤二：获取 Client\n\n```python\ndef get_client(ak, sk, region):\n    # 包含默认属性\n    configuration = volcenginesdkcore.Configuration()\n    configuration.ak = ak\n    configuration.sk = sk\n    configuration.region = region\n    client = volcenginesdkautoscaling.AUTOSCALINGApi(volcenginesdkcore.ApiClient(configuration))\n    return client\n```\n\n### Endpoint 设置 ###\n\n如果您要自定义SDK的Endpoint，可以按照以下示例代码设置：\n\n```python\nconfiguration = volcenginesdkcore.Configuration()\nconfiguration.host = 'ecs.cn-beijing-autodriving.volcengineapi.com'\n```\n\n火山引擎标准的Endpoint规则说明：\n\n| Regional 服务                                                                                                                            | Global 服务                                                                          |\n|----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|\n| `{service}.{region}.volcengineapi.com` \u003cbr\u003e 例如：云服务ecs在cn-beijing-autodriving Region域名为： `ecs.cn-beijing-autodriving.volcengineapi.com` | `{service}.volcengineapi.com` \u003cbr\u003e 例如：访问控制iam为Global服务，域名为：`iam.volcengineapi.com` |\n\n注：\n\n- Service中存在_符号时，Endpoint时需转为-符号。存在大写字母时需转成小写。\n\n### SDK 示例 ###\n\n```python\nfrom __future__ import print_function\nimport volcenginesdkecs\nimport volcenginesdkcore\nfrom pprint import pprint\nfrom volcenginesdkcore.rest import ApiException\n\nif __name__ == '__main__':\n    configuration = volcenginesdkcore.Configuration()\n    configuration.ak = \"Your AK\"\n    configuration.sk = \"Your SK\"\n    configuration.region = \"cn-beijing\"\n    configuration.client_side_validation = True\n    # set default configuration\n    volcenginesdkcore.Configuration.set_default(configuration)\n\n    # use global default configuration\n    api_instance = volcenginesdkecs.ECSApi()\n    # use custom configuration\n    # api_instance = volcenginesdkecs.ECSApi(volcenginesdkcore.ApiClient(configuration))\n\n    try:\n        resp = api_instance.run_instances(\n            volcenginesdkecs.RunInstancesRequest(\n                instance_name=\"insname\",\n                instance_type=\"ecs.g1.large\",\n                zone_id=\"cn-beijing-a\",\n                network_interfaces=[volcenginesdkecs.NetworkInterfaceForRunInstancesInput(\n                    subnet_id=\"subnet-2d68bh73d858ozfekrm8fj\",\n                    security_group_ids=[\"sg-2b3dq7v0ha0w2dx0eg0nhljv\"],\n                )],\n                image_id=\"image-ybvz29l3da4ox5h0m9\",\n                volumes=[volcenginesdkecs.VolumeForRunInstancesInput(\n                    volume_type=\"ESSD\",\n                    size=40,\n                )],\n                key_pair_name=\"vtable\",\n                instance_charge_type=\"PostPaid\"\n            ))\n        pprint(resp)\n    except ApiException as e:\n        print(\"Exception when calling ECSApi-\u003erun_instances: %s\\n\" % e)\n\n```\n\n更多代码示例请参考：[SDK接入文档](./SDK_Integration_zh.md)\n\n### FAQ ###\n\n关于 SDK 使用时碰到的常见问题，请查看 [FAQ](FAQ.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolcengine%2Fvolcengine-python-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvolcengine%2Fvolcengine-python-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolcengine%2Fvolcengine-python-sdk/lists"}