SuperAPI AI 工具集

yba-api

编程与开发

查看项目

更新于 10-16 03:04

技能介绍

用途:本技能面向自管理 YugabyteDB Anywhere(YBA)实例暴露的控制面 REST API,用于脚本化、自动化与排查 provider、release、universe、备份、KMS、告警、HA、RBAC、DR 等管理操作。不涉及 YugabyteDB Aeon(托管云 DBaaS,API 不同),也不涉及 YSQL/YCQL 数据库 API(端口 5433/9042)。

主要能力:YBA 同时提供 v1(/api/v1/...)与 v2(/api/v2/...)两套 API,共用同一主机与 X-AUTH-YW-API-TOKEN 头。v1 覆盖全面但模型与内部 Java/Play 模型紧耦合;v2 基于 OpenAPI 3,模型更扁平,目前聚焦 universe、升级、RBAC、release、telemetry。默认优先用 v2,其余回退 v1。技能内含 Python 与 PowerShell 客户端封装、请求配方、Prometheus 指标查询等参考文档。

使用方式:认证统一使用 X-AUTH-YW-API-TOKEN 头。令牌获取有三种:复用已有令牌(不过期,除非轮换);用邮箱密码调用 POST /api/v1/api_login(会轮换令牌);新实例首次调用 POST /api/v1/register?generateApiToken=1 注册。多数端点按 customer/tenant 作用域,可用 GET /api/v1/customers 查询并缓存 cUUID。异步操作返回 taskUUID,需轮询 GET /api/v1/customers/{cUUID}/tasks/{taskUUID},percent==100 为成功,status 为 Aborted/Failure 为失败,建议 5–10 秒轮询。

适用场景:编写或生成 Python/PowerShell 自动化脚本、创建与管理 universe、导入 release、配置 provider、备份恢复、查询 Prometheus 指标等。

限制:v2 覆盖不完整;v1 与 v2 载荷不可互换;令牌需按密码对待,不应记录或提交;私有 CA 环境可能需关闭证书校验;具体字段与端点应以 v1.routes 或 openapi 规范为准。