Console SDK(Go)
Go 管理面 SDK(module agentbase-console-go-sdk)覆盖 Console / 管理面 API:组织与项目治理、Key 签发、跨项目运维,与 Server module(../server-sdk/go.md)可同时 replace 消费(facade 包名均为 agentbase,import 时起别名)。Node / Java / Python 面见同目录 nodejs.md / java.md / python.md。
制品与安装
不发布到公共 Go module proxy:下载 release ZIP 校验后,在应用模块 go.mod 中与 Server module 一并 replace 指向本地目录:
require (
agentbase-console-go-sdk v0.0.0
agentbase-go-sdk v0.0.0
)
replace agentbase-go-sdk => /path/to/agentbase-go-sdk-2.10.0
replace agentbase-console-go-sdk => /path/to/agentbase-console-go-sdk-2.10.0下载与校验命令见 ../examples/go.md「获取与安装」;Go 面自 agentbase-sdks v2.7.0 起交付(2.6.0 无该语言面)。
初始化与认证装载
Console 登录响应体不含 session secret(只在 a_session_console cookie),先经原始 HTTP 取 cookie 再挂到 Console SDK client:
import (
consolefacade "agentbase-console-go-sdk/agentbase"
)
consoleClient := consolefacade.NewClient(
consolefacade.WithEndpoint("https://appbuild.oceanbase.com/v1"),
consolefacade.WithProject("console"),
)
consoleClient.AddHeader("origin", "https://appbuild.oceanbase.com")
consoleClient.AddHeader("x-forwarded-host", "appbuild.oceanbase.com")
consoleClient.AddHeader("Cookie", "a_session_console="+cookieFromLoginResponse)典型治理调用
服务面含 account、teams、projects、users、proxy、migrations 等;调用约定与 Server module 一致(必选参数按位置、可选参数 With*):
import (
"fmt"
consolefacade "agentbase-console-go-sdk/agentbase"
)
consoleTeams := consolefacade.NewTeams(consoleClient)
consoleProjects := consolefacade.NewProjects(consoleClient)
_, _ = consoleTeams.Create("my-team", "My Team", consoleTeams.WithCreateRoles([]string{"owner"}))
project, _ := consoleProjects.Create("unique()", "My Project", "my-team")
key, _ := consoleProjects.CreateKey(project.Id, "server key", []string{
"users.read", "users.write", "teams.read", "teams.write",
})
fmt.Println(key.Secret) // Server SDK 用的 API Key,只在创建响应出现一次组织、成员、平台注册等 Console-only 操作不能用项目 API Key。
功能面导航
治理域到服务的全量映射见 nodejs.md「功能面导航」;各域功能页:组织、项目与 Key、配额、用量、站点与域名、平台运维。
错误与边界
错误统一为
*client.AgentbaseError(与 Server module 同型,见 ../server-sdk/go.md「错误处理」)。Console Session cookie 与 OAuth 测试 Session 相互隔离;短期 JWT 场景
WithJWT,禁止写入日志。
各语言调用示例
以下按功能域给出各语言调用示例;每个卡片可切换语言(全页同步)。
建团队、项目与签发 Key
Python 方法名为 snake_case、Go 为 facade New* 构造器 + With* 可选项。该域无 REST 直调页签,REST 直调见下文「配额与限频」卡。
- Console(Node)
- Java
- Python
- Go
import { Client, Teams, Projects, ID, Scopes } from 'agentbase-console-sdk';
const client = new Client()
.setEndpoint(process.env.APPBASE_ENDPOINT!) // https://appbuild.oceanbase.com/v1
.setProject(process.env.APPBASE_CONSOLE_PROJECT_ID!); // Console 项目,常为 console
const teams = new Teams(client);
const team = await teams.create({ teamId: ID.unique(), name: 'My Team' });
const projects = new Projects(client);
const project = await projects.create({
projectId: ID.unique(),
name: 'todo-app',
teamId: team.$id,
region: 'default' // 不使用 Appwrite Cloud 的区域枚举
});
const key = await projects.createKey({
projectId: project.$id,
name: 'setup-script',
scopes: [Scopes.UsersRead, Scopes.UsersWrite] // scope 最小化
});
// key.secret 仅创建时返回一次// 组织 = Team:Teams.create(teamId, name, roles)(位置参数,POST /teams),
// team.getId() 填入下方 projects.create 第 3 个位置参数;create 位置参数全集见同目录 java.md「快速上手」
io.agentbase.console.services.Teams teams = new io.agentbase.console.services.Teams(consoleClient);
var team = teams.create(
io.agentbase.console.ID.unique(), "My Team", java.util.List.of("owner"));
Projects projects = new Projects(consoleClient);
var project = projects.create(
io.agentbase.console.ID.unique(), "billing-service", team.getId(),
io.agentbase.console.enums.Region.DEFAULT, null, // poolTag 可空
null, null, null, null, null, null, null, null, null, null);
var key = projects.createKey(project.getId(), "ci-deploy",
java.util.List.of(io.agentbase.console.enums.Scopes.USERS_READ,
io.agentbase.console.enums.Scopes.USERS_WRITE),
null, null, null);
System.out.println(key.getSecret()); // secret 只在创建响应出现一次# console_client 初始化见同目录 python.md「初始化与认证装载」;完整步骤见其「快速上手」
from agentbase_console.services.projects import Projects
from agentbase_console.services.teams import Teams
teams = Teams(console_client)
projects = Projects(console_client)
teams.create(team_id='my-team', name='My Team', roles=['owner']) # Console 的 Organization = Team
project = projects.create(project_id='unique()', name='My Project', team_id='my-team')
key = projects.create_key(
project_id=project.id, name='server key',
scopes=['users.read', 'users.write', 'teams.read', 'teams.write'],
key_id='unique()')
print(key.secret) # 只在创建响应出现一次// consoleClient 初始化见上文「初始化与认证装载」;完整步骤见上文「快速上手」
consoleTeams := consolefacade.NewTeams(consoleClient)
consoleProjects := consolefacade.NewProjects(consoleClient)
_, _ = consoleTeams.Create("my-team", "My Team", consoleTeams.WithCreateRoles([]string{"owner"})) // Console 的 Organization = Team
project, _ := consoleProjects.Create("unique()", "My Project", "my-team")
key, _ := consoleProjects.CreateKey(project.Id, "server key", []string{
"users.read", "users.write", "teams.read", "teams.write",
})
fmt.Println(key.Secret) // 只在创建响应出现一次用量查询
三级聚合(最近 30 个 UTC 日)与旧口径是两套体系,方法名不可互猜(见 用量)。
- Console(Node)
- Java
- Python
- Go
// account / organizations / projects 为 Console SDK 对应 service 实例
await account.listUsageAggregates();
await organizations.listUsageAggregates({ organizationId: '<organizationId>' });
await projects.listUsageAggregates({ projectId: '<projectId>' });// Java Console SDK 生成名是 getUsageAggregates(与 JS 的 listUsageAggregates 不同名)
new io.agentbase.console.services.Projects(consoleClient)
.getUsageAggregates("<projectId>"); // 项目级
new io.agentbase.console.services.SelfHostedOrganizations(consoleClient)
.getUsageAggregates("<organizationId>"); // 组织级(端点同 JS organizations 面)
// 账号级(/account/usage/aggregates)在 console-java 无 typed 方法,走 REST 直调
// 旧口径:作用于 setProject 的当前项目(period 枚举 ONE_HOUR / ONE_DAY)
new io.agentbase.console.services.Project(consoleClient)
.getUsage(null, null, io.agentbase.console.enums.ProjectUsageRange.ONE_DAY);# 本文未提供 Python SDK 的三级用量聚合示例。
# 本节示例可使用 Node / Java / REST;Python 调用请核对所用 Console SDK
# 发布包的服务类、方法和参数,不要按 JS 命名推测。// server-go@release-2.6.0 无三级聚合方法
// 面,唯一旧口径是 selfhostedorganizations.GetUsage(organizationId, WithGetUsageRange)。
// Console Go 面自 2.7.0 起交付;本文未覆盖其三级聚合用法,请使用 Node / Java / REST,不按 JS 命名推测。配额与限频(REST 直调)
Go Console 面亦无 typed quota/ratelimit 证据,统一走 REST 入口:
- REST(curl)
# 查询当前配额与限频:
curl -sS "$APPBASE_ENDPOINT/projects/<projectId>/limits" \
-H "X-Appwrite-Project: $APPBASE_CONSOLE_PROJECT_ID" \
-H "X-Appwrite-Key: $APPBASE_CONSOLE_API_KEY"
# 设置:PATCH 同路径,body 为扁平的限频 + 配额字段;Quota 0 = 不限量,RateLimit 必须正整数
curl -sS -X PATCH "$APPBASE_ENDPOINT/projects/<projectId>/limits" \
-H 'Content-Type: application/json' \
-H "X-Appwrite-Project: $APPBASE_CONSOLE_PROJECT_ID" \
-H "X-Appwrite-Key: $APPBASE_CONSOLE_API_KEY" \
-d '{"databaseStorageLimit": 0}'
# 字段全集与字段名陷阱见 limits.mdx示例指引
Go(Server / Console)完整调用写法:../examples/go.md