跳至文檔內容
開發者文檔API 參考查詢伺服器資源
GETBearer 權杖

查詢伺服器資源

/api/v1/servers/:id/resources

查詢伺服器詳細資料與目前套用的防火牆。firewallState 區分預覽、尚未同步與就緒;firewalls 為 null 不代表已確認未套用任何防火牆。

API 欄位名稱、型別與程式碼在所有語言中保持原樣。

請求範例

cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/resources" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

僅提供範例,此頁不會發送 API 請求。

參數

id路徑 · 必填

string

資源 ID:24 個十六進位字元。請使用對應列表端點回傳的平台 ID,而非供應商的執行個體 ID。

回應

HTTP 狀態 200

讀取平台儲存的伺服器詳細資料及目前儲存的防火牆關聯狀態。

testOnlyboolean

此伺服器是否為隔離測試資源。

testUntilstring (ISO 8601) | null

測試資源到期時間(若有)。

supplierPaidThroughstring (ISO 8601) | null

伺服器儲存的 expiresAt 值,沿用此歷史欄位名稱回傳。

instanceIdstring

供應商執行個體識別碼,不是平台伺服器的 ObjectId。

namestring

儲存的主機名稱,或空字串。

statusstring

儲存的伺服器狀態。

previewboolean

此伺服器是否為唯讀預覽。

regionstring

地區顯示名稱;無名稱時使用代碼。

dataCenterstring

目前為長破折號佔位字元。

productstring

儲存的產品名稱;無名稱時顯示長破折號。

cpunumber

儲存的 CPU 數量,或零。

memoryMbnumber

儲存的記憶體容量(MB),或零。

diskMbnumber

儲存的磁碟容量(MB),或零。

operatingSystemstring

儲存的作業系統名稱或識別碼;無資料時顯示長破折號。

imageIdnull

目前的平台詳細資料讀取流程不會填入此欄位。

ipv4string | null

儲存的 IPv4 地址(若有)。

ipv6string | null

儲存的 IPv6 地址(若有)。

macAddressstring

儲存的 MAC 地址,或空字串。

createdAtstring (ISO 8601) | null

儲存的購買建立時間(若有)。

additionalIpsnull

目前的平台詳細資料讀取流程不會填入此欄位。

privateNetworksnull

目前的平台詳細資料讀取流程不會填入此欄位。

firewallStatestring ('preview' | 'unsynced' | 'ready')

此伺服器是否有可用的防火牆資料。

firewallsarray | null

preview 或 unsynced 狀態下為 null;其他情況為符合條件的關聯。

firewalls[].idstring

供應商防火牆識別碼,不一定與平台端識別碼相同。

firewalls[].namestring

防火牆顯示名稱。

firewalls[].statusstring

供應商防火牆狀態。

firewalls[].attachedInstanceCountnumber

目前可見且已關聯的組織伺服器數。

firewalls[].rulesarray

規則欄位包含 displayName、protocol、destPorts、ipv4、ipv6、action 及 status。