python-sdk
PYTHON-SDK
1. PYTHON-SDK概述
基于PYTHON语言的SDK提供给用户通过PYTHON代码管理项目、云服务器、边界安全云服务器、网络、云硬盘、vSAN、标签的能力。
2. PYTHON-SDK包结构说明
PYTHON-SDK主要包括以下几个package:
| package | 描述 |
|---|---|
| yovolecloud\common | 提供PYTHON-SDK所需的公共类 |
| yovolecloud\project | 提供项目相关模型，如项目查询、项目创建、项目成员管理等 |
| yovolecloud\compute | 提供云服务器相关模型，如云服务器实例、边界安全云服务器实例、镜像、安全组、SSH密钥、安置组等 |
| yovolecloud\network | 提供网络相关模型，如VPC与子网、EIP、NAT、内网VIP、VPC互联、安全组等 |
| yovolecloud\storage | 提供云硬盘、vSAN管理相关模型 |
| yovolecloud\tag | 提供标签管理相关模型 |
| yovolecloud\examples | 提供项目管理、云服务器管理、边界安全云服务器管理、网络管理、云硬盘管理、标签管理相关操作示例 |
相关的实例代码，请参考examples目录中对应的代码。
3. PYTHON-SDK环境要求
请使用Python2.7,3.6至3.9版本。执行命令python --version 可以查看PYTHON版本。
请安装requests模块，安装命令: pip install requests
4. PYTHON-SDK版本更新记录
当前版本为1.0.3。
| 版本 | 更新内容 | 发布日期 |
|---|---|---|
| 1.0.3 | 提供边界安全云服务器相关接口。 | 2022-11-24 |
| 1.0.2 | VPC创建、列表、详情接口增加VPC类型属性。 | 2022-10-30 |
| 1.0.1 | 提供vSAN相关接口。 | 2022-09-27 |
| 1.0.0 | 提供管理项目、云服务器、网络、云硬盘、标签等相关接口。 | 2022-05-06 |
5. PYTHON-SDK下载
| 版本 | 下载地址 | MD5 |
|---|---|---|
| 1.0.3 | python-sdk-1.0.3.tar.gz | 9c30193b42de9515c774d6fa8260c051 |
| 1.0.2 | python-sdk-1.0.2.tar.gz | 0e2ed415a9d7babaa189f1bbbe88591a |
| 1.0.1 | python-sdk-1.0.1.tar.gz | ffb298a32ebb5ebe2abcb14f09936172 |
| 1.0.0 | python-sdk-1.0.0.tar.gz | 9af93dea40b3f237ff51c534e42a28f5 |
6. PYTHON-SDK配置说明
修改common下的settings.py文件
配置您自己的APP_ID、APP_SECRET、CURRENT_PROJECT_ID。
此外，settings.py文件中提供了部分可用区Region（华东1区，华北1区与华南2区）的endpoint作为示例，如果您需要创建资源的可用区Region不在示例中，需要手动添加您的可用区的endpoint（您可以从帮助文档的api文档的云控制台api/云控制台api介绍/服务地址(EndPoint)说明，查找可配置的区域服务地址endpoint）。
settings.py文件配置完成后，记得进行保存（部分ide可能没有开启自动保存），配置如下图所示：
QuickStart（以examples路径下的compute_example.py文件举例）：
import引入settings.py文件中的endpoint，并根据您想使用的可用区Region修改client = ComputeApi(xxx)中传入的endpoint变量。根据您的使用场景，修改方法中的参数，最后写一个main入口函数调用方法去请求即可。
7. PYTHON-SDK FAQ
如何寻找自己账号的APP_ID、APP_SECRET：
如果您是主账号，从“我的业务”进入“基础云业务”，点击右上角用户名，选择“Accesskey管理”，AccessKey ID就是APP_ID，AccessKeySecret就是APP_SECRET。
如果您是子账号，您需要找主账号要AccessKey ID和AccessKeySecret，且需要主账号需要放开您这个子账号的api权限（如下图：主账号进入“访问控制中心”，点击“更多”，选择“API权限”，根据需要给子账号创建api密钥或者给子账号启用或禁用api密钥）。
如何寻找自己项目的CURRENT_PROJECT_ID：
配置完您的APP_ID、APP_SECRET后，保存一下settings.py文件（部分ide可能没有开启自动保存）。然后打开examples路径下的project_example.py文件，写一个main入口函数调用list_project方法去请求，就可以得到您的projectid了。
