agentbase-docs

Console SDK(Node.js / JavaScript)

Console SDK 面向管理面调用方:Console 面板能力、组织与项目治理、跨项目运维自动化,认证用管理身份——邮箱密码 Session 或 短期 JWT。npm 坐标 agentbase-console-sdk@2.8.0。Java / Python / Go 面见同目录 java.md / python.md / go.md;浏览器前端用 Client SDK;服务端数据面用 Server SDK。

安装与初始化

npm install agentbase-console-sdk@2.8.0 --save-exact

**方式一:sdk 包装对象(推荐,自动管理端点与模式)**

import { sdk, realtime } from 'agentbase-console-sdk';

sdk.forConsole.projects.list(/* 组织/控制台级调用 */);
sdk.forConsoleIn('default').health.get();      // 指定 region
sdk.forProject('default', '<projectId>').tablesDB.listRows(...); // 项目资源面,自动 setProject + setMode('admin')

**方式二:裸 Client(需要精细控制认证时)**

import { Client } from 'agentbase-console-sdk';

const client = new Client()
  .setEndpoint('https://appbuild.oceanbase.com/v1')
  .setProject('<consoleOrProjectId>');   // X-Appwrite-Project 头

认证装载(三选一,互斥):

其他 setter:setMode('admin')、setLocale、setSelfSigned。

5 分钟上手(管理自动化)

const projects = sdk.forConsole.projects;

const project = await projects.create({
  projectId: 'unique()', name: 'My Project', teamId: '<teamId>', region: 'default',
});
const key = await projects.createKey(project.$id, 'server key', [
  'users.read', 'users.write', 'teams.read', 'teams.write',
]);
// key.secret 只在创建响应出现一次,立即交给服务端安全存储

服务端拿 Key 接入 Server SDK;域名规则、迁移、备份等治理面继续用本页服务。

Console 专有 service

服务覆盖
Proxy站点/API/函数/重定向域名规则(createSiteRule / listRules / getRule / updateRuleVerification / deleteRule)
VcsGit 集成:installation、仓库发现、分支列表、仓库内容、外部部署状态回写
Migrations迁移任务(Appwrite/Firebase/Supabase/NHost/AppBase/CSV 导入导出):创建、报告、重试、删除;另有 SchemaMigration(基于 TablesDB 的表结构计划/执行助手)
Assistantassistant.chat() 管理侧 AI 助手
Console平台元数据:listRegions / listTags、计划与资源查询、列/索引建议(suggestColumns / suggestIndexes)、变量
Admin平台管理:池/标签列表、存储迁移、项目表模式转换、项目删除审计与恢复
Activities / Backups / Domains / Organizations事件流、备份策略与档案、域名资产、组织与账单

功能面导航(治理域 → 服务)

域服务与方法要点功能文档
组织Organizations:成员、账单地址、发票、充值、组织 Key、listUsageAggregates({ organizationId })../organization.md、../usage.md
项目生命周期Projects.create({ projectId, name, teamId, region: 'default', poolTag }) / get / update / delete / list../overview.md
项目 Key 与平台projects.createKey(scope 小写点分串,secret 仅创建时可见)、createDevKey、createPlatform / listPlatforms(仅 Console Session)、updateOAuth2../overview.md
配额与限频projects.getQuotaLimits / updateQuotaLimits;/limits 经 client.call../limits.md
三级用量account / organizations / projects 的 listUsageAggregates()(最近 30 个 UTC 日)../usage.md
项目资源面TablesDB / Sql / Sites / Functions / Storage / Messaging / Memory(含项目配置与回滚)/ Users / Teams / Tokens / LLMGateway(含用量)/ Webhooks / Graphql / Avatars / Locale / Health各功能页(../misc/webhooks.md 等)
SQLSql.query / Sql.execute(JS Console SDK 独有;Java / Python / Go Console 面见各自页说明)../databases/sql-proxy.md
站点与域名Sites 全集 + Proxy 域名规则 + Domains../sites.md
实时realtime.forProject(region, channels, cb) / realtime.forConsole(...)../realtime.md
平台运维Admin / Backups / Activities / Health(含管理面队列检查)../misc/webhooks.md

错误与边界

示例指引

事实源