Files
rainyun-cli/doc/provider/rainyun.md
T

277 lines
11 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 雨云 (Rainyun) Provider
> API 文档:https://api.rainyun.com | OpenAPI Spec:https://api.rainyun.com/openapi.json
> 认证方式:`X-Api-Key` Header | Base URL:`https://api.v2.rainyun.com`
---
## 接入状态
| 图标 | 含义 |
|------|------|
| ✅ | 已接入 CLI |
| ⬜ | 未接入 |
| 🚫 | 不在计划(非主流场景) |
---
## 云服务器 RCS
> `ry server <action>`
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| GET | `/product/rcs/` | 获取云服务器列表 | ✅ `server list` |
| POST | `/product/rcs/` | 创建云服务器 | ⬜ |
| GET | `/product/rcs/:id/` | 获取 RCS 详情 | ✅ `server get` |
| POST | `/product/rcs/:id/backup/` | 创建备份 | ⬜ |
| DELETE | `/product/rcs/:id/backup/:bid/` | 删除备份 | ⬜ |
| POST | `/product/rcs/:id/backup/:bid/cancel` | 取消备份 | ⬜ |
| POST | `/product/rcs/:id/backup/:bid/restore` | 还原备份 | ⬜ |
| PATCH | `/product/rcs/:id/backup/setting` | 设置备份选项 | ⬜ |
| POST | `/product/rcs/:id/bridge_setintip` | 桥接模式设置内网 | ⬜ |
| POST | `/product/rcs/:id/changeos` | 重装系统 | ✅ `server reinstall` |
| POST | `/product/rcs/:id/edisk/` | 管理弹性云盘 | ⬜ |
| POST | `/product/rcs/:id/eip/` | 创建绑定弹性 IP | ⬜ |
| POST | `/product/rcs/:id/eip/change` | 更换 IP | ⬜ |
| POST | `/product/rcs/:id/eip/description` | 设置 IP 描述 | ⬜ |
| POST | `/product/rcs/:id/eip/discard` | 放弃 IP | ⬜ |
| POST | `/product/rcs/:id/fai-send` | 快速安装 APP | ⬜ |
| POST | `/product/rcs/:id/firewall/mode` | 设置防火墙规则 | ⬜ |
| GET | `/product/rcs/:id/firewall/rule` | 获取防火墙规则 | ⬜ |
| POST | `/product/rcs/:id/firewall/rule` | 创建防火墙规则 | ⬜ |
| DELETE | `/product/rcs/:id/firewall/rule/:ruleId` | 删除防火墙规则 | ⬜ |
| PUT | `/product/rcs/:id/firewall/rule/:ruleId/pos` | 移动防火墙优先级 | ⬜ |
| GET | `/product/rcs/:id/firewall/sync_time` | 防火墙同步时间 | ⬜ |
| POST | `/product/rcs/:id/free` | 释放 | ⬜ |
| GET | `/product/rcs/:id/monitor` | 监控数据 | ⬜ |
| DELETE | `/product/rcs/:id/nat` | 删除 NAT 映射 | ⬜ |
| GET | `/product/rcs/:id/nat` | 添加 NAT 映射 | ⬜ |
| POST | `/product/rcs/:id/reboot` | 重启 | ✅ `server reboot` |
| GET | `/product/rcs/:id/renew/` | 续费价格 | ⬜ |
| POST | `/product/rcs/:id/renew/` | 续费 | ⬜ |
| POST | `/product/rcs/:id/renew/option` | 自动续费选项 | ⬜ |
| POST | `/product/rcs/:id/reset-password` | 重置密码 | ✅ `server reset-password` |
| POST | `/product/rcs/:id/start` | 开机 | ✅ `server start` |
| POST | `/product/rcs/:id/stop` | 关机 | ✅ `server stop` |
| PATCH | `/product/rcs/:id/tag` | 设置标签 | ⬜ |
| POST | `/product/rcs/:id/to-bridge` | 转桥接 | ⬜ |
| POST | `/product/rcs/:id/toggle_dgpu` | 充流量 | ⬜ |
| POST | `/product/rcs/:id/toggle_primary_gpu` | 充流量 | ⬜ |
| POST | `/product/rcs/:id/traffic/charge` | 充流量 | ⬜ |
| POST | `/product/rcs/:id/traffic/limit` | 限流 | ⬜ |
| POST | `/product/rcs/:id/upgrade` | 升级 | ✅ `server upgrade` |
| GET | `/product/rcs/:id/usage` | 使用情况 | ⬜ |
| GET | `/product/rcs/:id/vnc` | VNC 连接 | ✅ `server vnc` |
| PATCH | `/product/rcs/:id/vnet` | 子网改名 | ⬜ |
| POST | `/product/rcs/:id/vnet` | 创建子网 | ⬜ |
| POST | `/product/rcs/:id/webbar/charge` | 充流量 | ⬜ |
| GET | `/product/rcs/discount-percent` | 折扣比率 | ⬜ |
| GET | `/product/rcs/os-templates` | 操作系统列表 | ⬜ |
| GET | `/product/rcs/plans` | 套餐列表 | ⬜ |
| GET | `/product/rcs/price` | 价格 | ⬜ |
| GET | `/product/rcs/usage` | 使用情况列表 | ⬜ |
---
## 域名 Domain
> `ry domain <action>`
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| GET | `/product/domain/` | 域名列表 | ✅ `domain list` |
| GET | `/product/domain/:id` | 域名详情 | ⬜ |
| GET | `/product/domain/:id/cert` | 下载证书 | ⬜ |
| PATCH | `/product/domain/:id/dns` | 修改 DNS | ⬜ |
| POST | `/product/domain/:id/dns` | 添加 DNS | ✅ `domain dns add` |
| DELETE | `/product/domain/:id/dns/` | 删除 DNS | ✅ `domain dns delete` |
| GET | `/product/domain/:id/dns/` | DNS 记录列表 | ✅ `domain dns list` |
| GET | `/product/domain/:id/dnssec` | DNSSEC 详情 | ⬜ |
| POST | `/product/domain/:id/dnssec` | 添加 DNSSEC | ⬜ |
| POST | `/product/domain/:id/dnssec/delete` | 删除 DNSSEC | ⬜ |
| POST | `/product/domain/:id/dnssec/sync` | 同步 DNSSEC | ⬜ |
| PUT | `/product/domain/:id/lock/disable` | 关闭锁定 | ⬜ |
| PUT | `/product/domain/:id/lock/enable` | 开启锁定 | ⬜ |
| POST | `/product/domain/:id/nameservers` | 修改 NS | ⬜ |
| POST | `/product/domain/:id/nameservers/reset` | 重置 NS | ⬜ |
| GET | `/product/domain/:id/password` | 管理密码 | ⬜ |
| POST | `/product/domain/:id/password` | 更新密码 | ⬜ |
| POST | `/product/domain/:id/renew` | 续费 | ⬜ |
| GET | `/product/domain/:id/renew-price` | 续费价格 | ⬜ |
| POST | `/product/domain/:id/transfer` | 过户 | ⬜ |
| DELETE | `/product/domain/certify` | 删除认证 | ⬜ |
| GET | `/product/domain/certify` | 已验证域名 | ⬜ |
| POST | `/product/domain/certify` | 添加认证 | ⬜ |
| POST | `/product/domain/certify/verify` | 认证校验 | ⬜ |
| POST | `/product/domain/check` | 检查可注册 | ⬜ |
| DELETE | `/product/domain/free_subdomain` | 删除免费二级 | ⬜ |
| GET | `/product/domain/free_subdomain` | 免费二级列表 | ⬜ |
| POST | `/product/domain/free_subdomain` | 创建免费二级 | ⬜ |
| POST | `/product/domain/free_subdomain/proxy` | CDN 设置 | ⬜ |
| GET | `/product/domain/free_subdomain/usable` | 可用免费域名 | ⬜ |
| POST | `/product/domain/register` | 注册域名 | ⬜ |
| PATCH | `/product/domain/template` | 编辑模板 | ⬜ |
| DELETE | `/product/domain/template/` | 删除模板 | ⬜ |
| GET | `/product/domain/template/` | 模板列表 | ⬜ |
| GET | `/product/domain/template/detail/` | 模板详情 | ⬜ |
| GET | `/product/domain/whitelist` | 白名单 | ⬜ |
| POST | `/product/domain/whitelist` | 添加白名单 | ⬜ |
| GET | `/product/domain/whois` | WHOIS 查询 | ⬜ |
---
## 对象存储 ROS
> `ry storage <action>`
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| GET | `/product/ros/instance` | 实例列表 | ✅ `storage list` |
| POST | `/product/ros/instance` | 创建实例 | ⬜ |
| GET | `/product/ros/instance/:id` | 实例详情 | ⬜ |
| POST | `/product/ros/instance/:id/regenerate-keys` | 重新生成密钥 | ⬜ |
| POST | `/product/ros/instance/:id/renew` | 续费 | ⬜ |
| POST | `/product/ros/instance/:id/renew/option` | 自动续费 | ⬜ |
| POST | `/product/ros/instance/:id/scale` | 缩放 | ⬜ |
| PATCH | `/product/ros/instance/:id/tag` | 设置标签 | ⬜ |
| POST | `/product/ros/instance/:id/toggle-extra-accounting` | 弹性计费 | ⬜ |
| POST | `/product/ros/instance/:id/toggle-public-access` | 匿名访问 | ⬜ |
| GET | `/product/ros/bucket` | 桶列表 | ✅ `storage bucket list` |
| POST | `/product/ros/bucket` | 创建桶 | ✅ `storage bucket create` |
| DELETE | `/product/ros/bucket/:id` | 删除桶 | ⬜ |
| GET | `/product/ros/bucket/:id` | 桶详情 | ⬜ |
| GET | `/product/ros/bucket/:id/monitor` | 实例监控 | ⬜ |
| POST | `/product/ros/bucket/:id/regenerate-keys` | 重新生成密钥 | ⬜ |
| POST | `/product/ros/bucket/:id/request-log` | 请求日志 | ⬜ |
| POST | `/product/ros/bucket/:id/toggle-public-access` | 匿名访问 | ⬜ |
| GET | `/product/ros/plans` | 套餐列表 | ⬜ |
| GET | `/product/ros/price` | 价格 | ⬜ |
---
## 计费 Expense
> `ry billing <action>`
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| GET | `/expense/orders/list` | 订单列表 | ✅ `billing orders` |
| POST | `/expense/orders/pay` | 支付订单 | ⬜ |
| POST | `/expense/product/transfer` | 产品转移 | ⬜ |
| POST | `/expense/unsubscribe/` | 退订 | ⬜ |
---
## CDN
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| POST | `/product/cdn` | 创建 CDN | ⬜ |
| GET | `/product/cdn/` | CDN 列表 | ⬜ |
| DELETE | `/product/cdn/:id` | 删除 CDN | ⬜ |
| GET | `/product/cdn/:id` | CDN 详情 | ⬜ |
| PATCH | `/product/cdn/:id` | 修改 CDN | ⬜ |
| GET | `/product/cdn/:id/metrics` | 监控 | ⬜ |
| GET | `/product/cdn/pack` | 流量包列表 | ⬜ |
| POST | `/product/cdn/pack` | 购买流量包 | ⬜ |
| GET | `/product/cdn/pack-plans` | 流量包套餐 | ⬜ |
---
## 游戏云 RGS
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| GET | `/product/rgs/` | 游戏云列表 | ⬜ |
| POST | `/product/rgs/` | 创建游戏云 | ⬜ |
| GET | `/product/rgs/:id/` | 详情 | ⬜ |
| POST | `/product/rgs/:id/start` | 开机 | ⬜ |
| POST | `/product/rgs/:id/stop` | 关机 | ⬜ |
| POST | `/product/rgs/:id/reboot` | 重启 | ⬜ |
| POST | `/product/rgs/:id/changeos` | 重装 | ⬜ |
| ... | *(共 75 个端点)* | | ⬜ |
---
## 裸金属 RBM
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| GET | `/product/rbm` | RBM 列表 | ⬜ |
| POST | `/product/rbm/` | 创建 RBM | ⬜ |
| POST | `/product/rbm/:id/poweroff` | 关机 | ⬜ |
| POST | `/product/rbm/:id/poweron` | 开机 | ⬜ |
| ... | *(共 23 个端点)* | | ⬜ |
---
## 虚拟主机 RVH
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| GET | `/product/rvh/` | 虚拟主机列表 | ⬜ |
| POST | `/product/rvh/` | 创建 | ⬜ |
| ... | *(共 25 个端点)* | | ⬜ |
---
## 云应用 RCA
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| ... | *(共 62 个端点)* | | 🚫 |
---
## RCDN
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| ... | *(共 22 个端点)* | | ⬜ |
---
## SSL 证书
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| ... | *(共 6 个端点)* | | ⬜ |
---
## 工单 WorkOrder
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| ... | *(共 18 个端点)* | | 🚫 |
---
## 用户 / VIP / 积分 / 商城
| 方法 | 路径 | 说明 | 状态 |
|------|------|------|------|
| ... | *(共 60+ 个端点)* | | 🚫 |
---
## 统计
| 类别 | 总数 | 已接入 | 占比 |
|------|------|--------|------|
| 云服务器 RCS | 50 | 8 | 16% |
| 域名 Domain | 38 | 4 | 11% |
| 对象存储 ROS | 24 | 3 | 13% |
| 计费 Expense | 4 | 1 | 25% |
| CDN | 9 | 0 | 0% |
| 游戏云 RGS | 75 | 0 | 0% |
| 裸金属 RBM | 23 | 0 | 0% |
| 虚拟主机 RVH | 25 | 0 | 0% |
| 云应用 RCA | 62 | 0 | 0% |
| RCDN | 22 | 0 | 0% |
| SSL 证书 | 6 | 0 | 0% |
| 工单 WorkOrder | 18 | 0 | 0% |
| 用户/VIP/积分 | 60+ | 0 | 0% |
| **总计** | **~416** | **16** | **~4%** |