查询用于从 Blocklet Server 获取数据。@blocklet/server-js 库提供了一组与可用 GraphQL 查询相对应的方法,使得无需编写原始 GraphQL 即可轻松检索信息。
所有查询方法都在 client.queries 属性下可用。
Get Node Information
import BlockletServerClient from '@blocklet/server-js';
// 在浏览器环境中初始化客户端
const client = new BlockletServerClient();
async function fetchNodeInfo() {
try {
const { info } = await client.queries.getNodeInfo();
console.log('节点名称:', info.name);
console.log('节点版本:', info.version);
} catch (error) {
console.error('获取节点信息失败:', error);
}
}
fetchNodeInfo();查询分类
可用的查询已按以下类别分组,以便于导航。点击类别可查看每个查询的详细信息和示例。
节点与 Blocklet 管理
用于管理节点和 Blocklet 的生命周期、状态和配置的查询。
用户与访问管理
用于管理用户、角色、权限、会话和访问密钥的查询。
网络与服务
用于处理路由、域名、证书、Webhook 和通知的查询。
数据与运营
用于访问备份、日志、分析和其他运营数据的查询。
发布与项目
用于管理发布项目、版本和相关资源的查询。
查询完整列表
为了快速概览,以下是所有可用查询方法的完整列表。
| Method | Description | Category |
|---|---|---|
getBlocklet | 获取特定 Blocklet 的详细信息。 | 节点与 Blocklet 管理 |
getBlockletMetaFromUrl | 从给定 URL 获取 Blocklet 元数据。 | 节点与 Blocklet 管理 |
getBlockletDiff | 将本地 Blocklet 与远程版本进行比较以获取差异。 | 节点与 Blocklet 管理 |
getBlocklets | 列出节点上所有已安装的 Blocklet。 | 节点与 Blocklet 管理 |
getBlockletRuntimeHistory | 获取 Blocklet 的运行时历史记录(CPU、内存)。 | 节点与 Blocklet 管理 |
getBlockletsFromBackup | 列出备份中可用的 Blocklet。 | 数据与运营 |
getDynamicComponents | 从 URL 检索动态组件。 | 节点与 Blocklet 管理 |
getNodeInfo | 获取有关 Blocklet Server 节点的常规信息。 | 节点与 Blocklet 管理 |
resetNodeStatus | 重置节点的状态。 | 节点与 Blocklet 管理 |
getNodeEnv | 检索节点的环境信息。 | 节点与 Blocklet 管理 |
checkNodeVersion | 检查 Blocklet Server 的可用更新。 | 节点与 Blocklet 管理 |
getDelegationState | 获取节点的委托状态。 | 节点与 Blocklet 管理 |
getNodeRuntimeHistory | 获取节点的运行时历史记录(CPU、内存)。 | 节点与 Blocklet 管理 |
getBlockletMeta | 检索特定 Blocklet 的元数据。 | 节点与 Blocklet 管理 |
getNotifications | 获取通知列表。 | 网络与服务 |
makeAllNotificationsAsRead | 将所有通知标记为已读。 | 网络与服务 |
getNotificationSendLog | 检索通知的发送日志。 | 网络与服务 |
getReceivers | 获取通知接收者列表。 | 网络与服务 |
getNotificationComponents | 检索可以发送通知的组件。 | 网络与服务 |
resendNotification | 重新发送特定通知。 | 网络与服务 |
getRoutingSites | 获取所有已配置的路由站点。 | 网络与服务 |
getRoutingSnapshots | 检索路由配置的快照。 | 网络与服务 |
getSnapshotSites | 从特定路由快照中获取站点。 | 网络与服务 |
getRoutingProviders | 列出可用的路由提供商。 | 网络与服务 |
isDidDomain | 检查给定域是否为 DID 域。 | 网络与服务 |
getCertificates | 检索所有 SSL/TLS 证书。 | 网络与服务 |
checkDomains | 检查指定域的状态和配置。 | 网络与服务 |
findCertificateByDomain | 查找与特定域关联的证书。 | 网络与服务 |
getAccessKeys | 列出所有访问密钥。 | 用户与访问管理 |
getAccessKey | 通过其 ID 检索特定的访问密钥。 | 用户与访问管理 |
getWebHooks | 获取所有已配置的 Webhook。 | 网络与服务 |
getWebhookSenders | 检索可用 Webhook 发送者的列表。 | 网络与服务 |
sendTestMessage | 向 Webhook 发送测试消息以进行验证。 | 网络与服务 |
getSession | 检索会话信息。 | 用户与访问管理 |
getRoles | 列出所有用户角色。 | 用户与访问管理 |
getRole | 检索特定角色的详细信息。 | 用户与访问管理 |
getPermissions | 列出所有可用的权限。 | 用户与访问管理 |
getInvitations | 获取所有待处理的邀请。 | 用户与访问管理 |
getUsers | 检索用户列表。 | 用户与访问管理 |
getUser | 获取特定用户的详细信息。 | 用户与访问管理 |
getUserSessions | 列出用户的活动会话。 | 用户与访问管理 |
getUserSessionsCount | 获取用户会话的总数。 | 用户与访问管理 |
getUsersCount | 检索用户总数。 | 用户与访问管理 |
getUsersCountPerRole | 获取每个角色的用户数。 | 用户与访问管理 |
getOwner | 检索节点所有者的用户信息。 | 用户与访问管理 |
getPermissionsByRole | 列出与特定角色关联的权限。 | 用户与访问管理 |
getPassportIssuances | 获取有关 Passport 颁发的信息。 | 用户与访问管理 |
logoutUser | 注销用户会话。 | 用户与访问管理 |
destroySelf | 允许用户删除自己的帐户。 | 用户与访问管理 |
getUserFollowers | 检索用户的关注者列表。 | 用户与访问管理 |
getUserFollowing | 检索用户正在关注的用户列表。 | 用户与访问管理 |
getUserFollowStats | 获取用户的关注统计信息。 | 用户与访问管理 |
checkFollowing | 检查一个用户是否正在关注另一个用户。 | 用户与访问管理 |
followUser | 关注一个用户。 | 用户与访问管理 |
unfollowUser | 取消关注一个用户。 | 用户与访问管理 |
getUserInvites | 检索用户的受邀者列表。 | 用户与访问管理 |
getTags | 检索标签列表。 | 数据与运营 |
getAuditLogs | 获取用于跟踪活动的审计日志。 | 数据与运营 |
getLauncherSession | 从 Blocklet Launcher 检索会话信息。 | 节点与 Blocklet 管理 |
getBlockletBackups | 列出特定 Blocklet 的所有备份。 | 数据与运营 |
getBlockletBackupSummary | 获取 Blocklet 备份活动的摘要。 | 数据与运营 |
getBlockletSpaceGateways | 检索为 Blocklet 配置的空间网关。 | 节点与 Blocklet 管理 |
getTrafficInsights | 获取流量分析和洞察。 | 数据与运营 |
getProjects | 列出所有发布项目。 | 发布与项目 |
getProject | 检索特定项目的详细信息。 | 发布与项目 |
getReleases | 列出项目的所有版本。 | 发布与项目 |
getRelease | 获取特定版本的详细信息。 | 发布与项目 |
getSelectedResources | 获取为版本选择的资源。 | 发布与项目 |
getBlockletSecurityRule | 检索 Blocklet 的特定安全规则。 | 网络与服务 |
getBlockletSecurityRules | 列出 Blocklet 的所有安全规则。 | 网络与服务 |
getBlockletResponseHeaderPolicy | 获取特定的响应头策略。 | 网络与服务 |
getBlockletResponseHeaderPolicies | 列出所有响应头策略。 | 网络与服务 |
getBlockletAccessPolicy | 检索特定的访问策略。 | 网络与服务 |
getBlockletAccessPolicies | 列出所有访问策略。 | 网络与服务 |
getWebhookEndpoints | 检索 Webhook 端点列表。 | 网络与服务 |
getWebhookEndpoint | 获取单个 Webhook 端点的详细信息。 | 网络与服务 |
getWebhookAttempts | 获取 Webhook 的投递尝试历史记录。 | 网络与服务 |
getPassportRoleCounts | 按角色统计 Passport 的数量。 | 用户与访问管理 |
getPassportsByRole | 按特定角色筛选并检索 Passport。 | 用户与访问管理 |
getPassportLogs | 获取与 Passport 活动相关的日志。 | 用户与访问管理 |
getRelatedPassports | 获取与给定 Passport 相关的 Passport。 | 用户与访问管理 |
getBlockletBaseInfo | 检索 Blocklet 的基本信息。 | 节点与 Blocklet 管理 |
getDomainDNS | 获取域名的 DNS 信息。 | 网络与服务 |
getOAuthClients | 列出所有已配置的 OAuth 客户端。 | 用户与访问管理 |
createOAuthClient | 创建一个新的 OAuth 客户端。 | 用户与访问管理 |
updateOAuthClient | 更新现有的 OAuth 客户端。 | 用户与访问管理 |
deleteOAuthClient | 删除一个 OAuth 客户端。 | 用户与访问管理 |
后续步骤
既然您已了解如何获取数据,下一步是学习如何修改数据。请继续阅读 变更 部分,了解如何在 Blocklet Server 上创建、更新和删除资源。