查詢用於從 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 | 獲取有關護照發行的資訊。 | 使用者與存取管理 |
logoutUser | 登出使用者會話。 | 使用者與存取管理 |
destroySelf | 允許使用者刪除自己的帳戶。 | 使用者與存取管理 |
getUserFollowers | 檢索使用者的追蹤者列表。 | 使用者與存取管理 |
getUserFollowing | 檢索使用者正在追蹤的使用者列表。 | 使用者與存取管理 |
getUserFollowStats | 獲取使用者的追蹤統計資料。 | 使用者與存取管理 |
checkFollowing | 檢查一個使用者是否正在追蹤另一個使用者。 | 使用者與存取管理 |
followUser | 追蹤一個使用者。 | 使用者與存取管理 |
unfollowUser | 取消追蹤一個使用者。 | 使用者與存取管理 |
getUserInvites | 檢索使用者的受邀者列表。 | 使用者與存取管理 |
getTags | 檢索標籤列表。 | 資料與營運 |
getAuditLogs | 獲取用於追蹤活動的稽核日誌。 | 資料與營運 |
getLauncherSession | 從 Blocklet 啟動器檢索會話資訊。 | 節點與 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 | 計算每個角色的護照數量。 | 使用者與存取管理 |
getPassportsByRole | 檢索按特定角色篩選的護照。 | 使用者與存取管理 |
getPassportLogs | 獲取與護照活動相關的日誌。 | 使用者與存取管理 |
getRelatedPassports | 獲取與給定護照相關的護照。 | 使用者與存取管理 |
getBlockletBaseInfo | 檢索有關 blocklet 的基本資訊。 | 節點與 Blocklet 管理 |
getDomainDNS | 獲取網域的 DNS 資訊。 | 網路與服務 |
getOAuthClients | 列出所有已設定的 OAuth 用戶端。 | 使用者與存取管理 |
createOAuthClient | 建立一個新的 OAuth 用戶端。 | 使用者與存取管理 |
updateOAuthClient | 更新現有的 OAuth 用戶端。 | 使用者與存取管理 |
deleteOAuthClient | 刪除一個 OAuth 用戶端。 | 使用者與存取管理 |
後續步驟
既然您已了解如何獲取資料,下一步就是學習如何修改它。請繼續前往 變更 部分,探索如何在 Blocklet Server 上建立、更新和刪除資源。