跳至文檔內容
開發者文檔API 參考查詢私有網路詳情
GETBearer 權杖

查詢私有網路詳情

/api/v1/networks/:id

讀取組織擁有的本機網路及依 ID 排序的最多 100 筆連接埠快照。網路不存在或屬於其他組織時回傳 404。本機連接埠為空不代表供應商端不存在連接埠。

呼叫前請注意

僅讀取本機資料,不呼叫供應商、不計費也不寫入。所有 capabilities 均為 false;地區或供應商相同不代表相容或可安全連接。

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

請求範例

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

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

回應示例
JSON
{
  "id": "507f1f77bcf86cd799439011",
  "provider": "contabo",
  "name": "example-network",
  "serviceFrom": null,
  "serviceUntil": null,
  "autoRenew": false,
  "accessState": "unknown",
  "region": "EU",
  "dataCenter": null,
  "capacity": 5,
  "monthlyPrice": "990",
  "currency": "USD",
  "priceUnit": "cent",
  "state": "pending",
  "version": 1,
  "checkedAt": null,
  "testOnly": true,
  "source": "local",
  "verification": "unknown",
  "capabilities": {
    "purchase": false,
    "attach": false,
    "disconnect": false,
    "remove": false,
    "reconnect": false,
    "cancelAddon": false,
    "renew": false,
    "resize": false,
    "delete": false,
    "blockedReason": "Private network supplier actions are not verified. Billing requires verified supplier support; local snapshots do not establish compatibility or safe attachment."
  },
  "portsVerification": "unknown",
  "portsNextCursor": null,
  "ports": [
    {
      "id": "507f1f77bcf86cd799439014",
      "slot": 1,
      "serverId": null,
      "active": true,
      "reservationState": "reserved",
      "connectionState": "unknown",
      "privateIps": null,
      "checkedAt": null,
      "version": 1,
      "testOnly": true
    }
  ],
  "cidr": null,
  "boundServers": 0,
  "occupiedPorts": 0
}

參數

id路徑 · 必填

string

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

after查詢字串 · 選填

string

選填的 24 位十六進位游標,取自網路清單的 nextCursor 或網路詳情的 portsNextCursor。回傳 ID 大於游標的最多 100 筆資料;null 表示沒有下一頁。

回應

HTTP 狀態 200

讀取組織擁有的本機網路及依 ID 排序的最多 100 筆連接埠快照。網路不存在或屬於其他組織時回傳 404。本機連接埠為空不代表供應商端不存在連接埠。

idstring

平台識別碼,並非供應商識別碼。

providerstring

已儲存的本機快照值,並非已驗證的供應商即時狀態。

namestring

已儲存的本機快照值,並非已驗證的供應商即時狀態。

regionstring

已儲存的本機快照值,並非已驗證的供應商即時狀態。

dataCenterstring | null

已儲存的本機快照值,並非已驗證的供應商即時狀態。

cidrstring | null

已記錄的私有網路CIDR;尚未觀測時為null。

boundServersinteger | null

目前組織所擁有實體伺服器的有效綁定數;資料不一致時為null。

occupiedPortsinteger | null

本地有效占位數,包含預留及移出中的名額;占用資料不一致時為null。

capacityinteger

已儲存的本機快照值,並非已驗證的供應商即時狀態。

statestring

已儲存的本機快照值,並非已驗證的供應商即時狀態。

versioninteger

已儲存的本機快照值,並非已驗證的供應商即時狀態。

monthlyPricestring

美元美分整數字串,並非美元金額;顯示價格不代表可付款。

serviceFromstring (ISO 8601) | null

服務僅在購買確證完成後開始;未知時為 null。

serviceUntilstring (ISO 8601) | null

平台已付服務的截止時間,與供應商已付日期獨立;未知時為 null。

autoRenewboolean

僅為續約意向,不證明已付款或已延長服務期。

accessStatestring

儲存的本機網路存取狀態:active、stopping、stopped、restoring 或 unknown,不代表目前供應商連線已通過驗證。

currency"USD"

固定幣別 USD、價格單位 cent;若有計費週期則為 month。

priceUnit"cent"

固定幣別 USD、價格單位 cent;若有計費週期則為 month。

checkedAtstring | null

快照檢查時間(ISO 8601),未知時為 null。有時間戳記不代表即時驗證。

testOnlyboolean

true 僅表示測試情境,也可能包含已購買的真實伺服器;不證明為模擬資料,也不會略過計費或安全檢查。

source"local"

固定為 local;不向供應商發送即時請求。

verification"unknown" | "snapshot"

有 checkedAt 時為 snapshot,否則為 unknown。兩者均不驗證供應商目前狀態。

capabilitiesobject

九個旗標 purchase、attach、disconnect、remove、reconnect、cancelAddon、renew、resize、delete 均為 false。供應商能力尚未核實,核實前不開放計費;快照無法證明相容性或安全連接。

portsobject[]

讀取組織擁有的本機網路及依 ID 排序的最多 100 筆連接埠快照。網路不存在或屬於其他組織時回傳 404。本機連接埠為空不代表供應商端不存在連接埠。

portsVerification"unknown"

固定為 unknown;本機結果為空並非供應商端不存在的證明。

portsNextCursorstring | null

選填的 24 位十六進位游標,取自網路清單的 nextCursor 或網路詳情的 portsNextCursor。回傳 ID 大於游標的最多 100 筆資料;null 表示沒有下一頁。

ports[].idstring

平台識別碼,並非供應商識別碼。

ports[].slotinteger

已儲存的本機快照值,並非已驗證的供應商即時狀態。

ports[].serverIdstring | null

僅提供目前組織擁有且未刪除的伺服器資料。否則 serverId 與 checkedAt 為 null、connectionState 為 unknown、privateIps 為 null。

ports[].activeboolean

已儲存的本機快照值,並非已驗證的供應商即時狀態。

ports[].reservationStatestring

已儲存的本機快照值,並非已驗證的供應商即時狀態。

ports[].connectionStatestring

僅提供目前組織擁有且未刪除的伺服器資料。否則 serverId 與 checkedAt 為 null、connectionState 為 unknown、privateIps 為 null。

ports[].privateIpsstring[] | null

缺少所有權或檢查時間時為 null。僅組織擁有、未刪除且有 checkedAt 的伺服器回傳陣列(可能為 []);仍然只是本機快照。

ports[].checkedAtstring | null

僅提供目前組織擁有且未刪除的伺服器資料。否則 serverId 與 checkedAt 為 null、connectionState 為 unknown、privateIps 為 null。

ports[].versioninteger

已儲存的本機快照值,並非已驗證的供應商即時狀態。

ports[].testOnlyboolean

true 僅表示測試情境,也可能包含已購買的真實伺服器;不證明為模擬資料,也不會略過計費或安全檢查。