## 目录
- [版本规范](#pip版本说明)
- [构建步骤](#构建pip包步骤 )
- [参考链接](#参考链接)
- [使用方法](#使用方法)
    - [账单明细SDK使用方法](#账单明细sdk使用方法)
    - [ECS资源统计SDK使用方法](#ecs资源统计sdk使用方法)
    - [NAT网关SDK使用方法](#nat网关sdk使用方法)

## pip版本说明
```bash
1.0.0 → 1.1.0  # 新增其他模块
1.1.0 → 1.1.1  # 修复bug
1.1.1 → 2.0.0  # 架构变更或不兼容更新
```

## 构建pip包步骤
```bash
# 安装构建工具
pip install build

# 构建包
python -m build

# 本地安装测试（xxx.whl为构建生成的包名）
python -m pip install dist/xxx.whl
```

## 参考链接
- SDK文档：
    - 账单明细(bill)：https://api.volcengine.com/api-docs/view?serviceCode=billing&version=2022-01-01&action=ListBillDetail
- Devpi文档：
    - 发布pip包方法：https://ahcjhj8bu4.feishu.cn/wiki/FbkEweSj1inCupktomBcr1eFnxd


## 使用方法
```python
# 所有sdk使用前都需要先初始化
sdk = VolcOpsSDK(
    ak="your_ak", 
    sk="your_sk", 
    region="cn-beijing"
)
```
---
### 账单明细SDK使用方法
```python
import json
from volc_ops_sdk import VolcOpsSDK 

# 初始化SDK
sdk = VolcOpsSDK(
    ak="your_ak", 
    sk="your_sk", 
    region="cn-beijing"
)

bill_data = sdk.bill.list_bill_detail("2025-09", "2025-09-07")
print(json.dumps(bill_data, ensure_ascii=False))
```
---
### ECS资源统计SDK使用方法
```python
import json
from volc_ops_sdk import VolcOpsSDK 

# 初始化SDK
sdk = VolcOpsSDK(
    ak="your_ak", 
    sk="your_sk", 
    region="cn-beijing"
)

# 获取ECS资源汇总
ecs_data = sdk.ecs.get_resource_summary()
print(json.dumps(ecs_data, ensure_ascii=False))
```
---
### NAT网关SDK使用方法
```python
import json
from volc_ops_sdk import VolcOpsSDK 

# 初始化SDK
sdk = VolcOpsSDK(
    ak="your_ak", 
    sk="your_sk", 
    region="cn-beijing"
)

# 获取NAT网关列表
nat_data = sdk.nat.list_nat_gateways()
print(json.dumps(nat_data, ensure_ascii=False))
```
---