跳到主要内容

查询

查询用于从 Blocklet Server 获取数据。@blocklet/server-js 库提供了一组与可用 GraphQL 查询相对应的方法,使得无需编写原始 GraphQL 即可轻松检索信息。

查询用于从 Blocklet Server 获取数据。@blocklet/server-js 库提供了一组与可用 GraphQL 查询相对应的方法,使得无需编写原始 GraphQL 即可轻松检索信息。

所有查询方法都在 client.queries 属性下可用。

Get Node Information

javascript
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();

查询分类

可用的查询已按以下类别分组,以便于导航。点击类别可查看每个查询的详细信息和示例。

查询完整列表

为了快速概览,以下是所有可用查询方法的完整列表。

MethodDescriptionCategory
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 上创建、更新和删除资源。