GraphQL 查詢支援
GraphQL 是一種用於 API 的查詢語言,以及使用現有資料來滿足這些查詢的執行環境。它讓使用者能夠精確地要求他們需要的內容,不多也不少。
列舉
列舉表示欄位可能的值集合。
例如,Node
物件有一個名為 status
的欄位。狀態是一個列舉(具體來說,是 Status
類型),因為它可能是 UP
、DRAINING
或 UNAVAILABLE
。
純量
純量是基本值:Int
、Float
、String
、Boolean
或 ID
。
當呼叫 GraphQL API 時,您必須指定巢狀子欄位,直到您只傳回純量為止。
Schema 的結構
Grid schema 的結構如下
{
session(id: "<session-id>") : {
id,
capabilities,
startTime,
uri,
nodeId,
nodeUri,
sessionDurationMillis
slot : {
id,
stereotype,
lastStarted
}
}
grid: {
uri,
totalSlots,
nodeCount,
maxSession,
sessionCount,
version,
sessionQueueSize
}
sessionsInfo: {
sessionQueueRequests,
sessions: [
{
id,
capabilities,
startTime,
uri,
nodeId,
nodeUri,
sessionDurationMillis
slot : {
id,
stereotype,
lastStarted
}
}
]
}
nodesInfo: {
nodes : [
{
id,
uri,
status,
maxSession,
slotCount,
sessions: [
{
id,
capabilities,
startTime,
uri,
nodeId,
nodeUri,
sessionDurationMillis
slot : {
id,
stereotype,
lastStarted
}
}
],
sessionCount,
stereotypes,
version,
osInfo: {
arch,
name,
version
}
}
]
}
}
查詢 GraphQL
查詢 GraphQL 的最佳方式是使用 curl
請求。查詢會被解譯為 JSON。請確保正確地逸出雙引號,以避免意外錯誤。GraphQL 允許您僅提取您想要的資料,不多也不少。
下面提供了一些 GraphQL 查詢範例。您可以根據需要建立自己的查詢。
查詢 Grid 中 maxSession
和 sessionCount
的數量
curl -X POST -H "Content-Type: application/json" --data '{"query": "{ grid { maxSession, sessionCount } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
通常在本地電腦上,<LINK_TO_GRAPHQL_ENDPOINT>
會是 https://#:4444/graphql
查詢 session、node 和 Grid 的所有詳細資訊
curl -X POST -H "Content-Type: application/json" --data '{"query":"{ grid { uri, maxSession, sessionCount }, nodesInfo { nodes { id, uri, status, sessions { id, capabilities, startTime, uri, nodeId, nodeUri, sessionDurationMillis, slot { id, stereotype, lastStarted } }, slotCount, sessionCount }} }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢以取得 Grid 中目前的 session 數量
curl -X POST -H "Content-Type: application/json" --data '{"query":"{ grid { sessionCount } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢以取得 Grid 中最大的 session 數量
curl -X POST -H "Content-Type: application/json" --data '{"query":"{ grid { maxSession } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢以取得 Grid 中所有節點的所有 session 詳細資訊
curl -X POST -H "Content-Type: application/json" --data '{"query":"{ sessionsInfo { sessions { id, capabilities, startTime, uri, nodeId, nodeId, sessionDurationMillis } } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢以取得 Grid 中每個節點中所有 session 的插槽資訊
curl -X POST -H "Content-Type: application/json" --data '{"query":"{ sessionsInfo { sessions { id, slot { id, stereotype, lastStarted } } } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢以取得給定 session 的 session 資訊
curl -X POST -H "Content-Type: application/json" --data '{"query":"{ session (id: \"<session-id>\") { id, capabilities, startTime, uri, nodeId, nodeUri, sessionDurationMillis, slot { id, stereotype, lastStarted } } } "}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢 Grid 中每個節點的功能
curl -X POST -H "Content-Type: application/json" --data '{"query": "{ nodesInfo { nodes { stereotypes } } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢 Grid 中每個節點的狀態
curl -X POST -H "Content-Type: application/json" --data '{"query": "{ nodesInfo { nodes { status } } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢每個節點和 Grid 的 URI
curl -X POST -H "Content-Type: application/json" --data '{"query": "{ nodesInfo { nodes { uri } } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢以取得新 session 佇列中目前的請求
curl -X POST -H "Content-Type: application/json" --data '{"query":"{ sessionsInfo { sessionQueueRequests } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>
查詢以取得新 session 佇列的大小
curl -X POST -H "Content-Type: application/json" --data '{"query":"{ grid { sessionQueueSize } }"}' -s <LINK_TO_GRAPHQL_ENDPOINT>