クエリは、Blocklet Serverからデータを取得するために使用されます。@blocklet/server-jsライブラリは、利用可能なGraphQLクエリに対応する一連のメソッドを提供しており、生のGraphQLを記述することなく簡単に情報を取得できます。
すべてのクエリメソッドは、client.queriesプロパティで利用できます。
ノード情報の取得
import BlockletServerClient from '@blocklet/server-js';
// ブラウザ環境用のクライアントを初期化
const client = new BlockletServerClient();
async function fetchNodeInfo() {
try {
const { info } = await client.queries.getNodeInfo();
console.log('Node Name:', info.name);
console.log('Node Version:', info.version);
} catch (error) {
console.error('Failed to fetch node info:', error);
}
}
fetchNodeInfo();クエリのカテゴリ
利用可能なクエリは、ナビゲーションを容易にするために以下のカテゴリにグループ化されています。カテゴリをクリックすると、各クエリの詳細情報と例が表示されます。
ノード & Blocklet管理
ノードとBlockletのライフサイクル、ステータス、設定を管理するためのクエリ。
ユーザー & アクセス管理
ユーザー、ロール、権限、セッション、アクセスキーを管理するためのクエリ。
ネットワーク & サービス
ルーティング、ドメイン、証明書、Webhook、通知を処理するためのクエリ。
データ & オペレーション
バックアップ、ログ、分析、その他の運用データにアクセスするためのクエリ。
公開 & プロジェクト
公開プロジェクト、リリース、および関連リソースを管理するためのクエリ。
クエリの完全なリスト
概要を素早く把握するために、利用可能なすべてのクエリメソッドの完全なリストを以下に示します。
| メソッド | 説明 | カテゴリ |
|---|---|---|
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 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 | ロールごとのパスポート数をカウントします。 | ユーザー & アクセス管理 |
getPassportsByRole | 特定のロールでフィルタリングされたパスポートを取得します。 | ユーザー & アクセス管理 |
getPassportLogs | パスポートアクティビティに関連するログを取得します。 | ユーザー & アクセス管理 |
getRelatedPassports | 指定されたパスポートに関連するパスポートを取得します。 | ユーザー & アクセス管理 |
getBlockletBaseInfo | Blockletの基本情報を取得します。 | ノード & Blocklet管理 |
getDomainDNS | ドメインのDNS情報を取得します。 | ネットワーク & サービス |
getOAuthClients | 設定されているすべてのOAuthクライアントを一覧表示します。 | ユーザー & アクセス管理 |
createOAuthClient | 新しいOAuthクライアントを作成します。 | ユーザー & アクセス管理 |
updateOAuthClient | 既存のOAuthクライアントを更新します。 | ユーザー & アクセス管理 |
deleteOAuthClient | OAuthクライアントを削除します。 | ユーザー & アクセス管理 |
次のステップ
データの取得方法を学んだので、次はデータの変更方法を学びます。ミューテーションセクションに進み、Blocklet Serverでリソースを作成、更新、削除する方法を確認してください。