本文へ
ドキュメント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 桁の16進数文字列です。対応する一覧エンドポイントが返すプラットフォーム ID を使用し、プロバイダーのインスタンス ID は使用しないでください。

afterクエリ · 任意

string

任意の 24 桁の 16 進カーソルです。一覧の 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 の9項目はすべて false です。供給元の機能は未検証で、検証前は課金しません。スナップショットは互換性や安全な接続を証明しません。

portsobject[]

所有するローカルネットワークと ID 順で最大 100 件のポートスナップショットを取得します。存在しないネットワークや他の組織のネットワークは 404 を返します。ローカルポートが空でも供給元での不在は未確認です。

portsVerification"unknown"

常に unknown。空のローカル結果は供給元での不在を証明しません。

portsNextCursorstring | null

任意の 24 桁の 16 進カーソルです。一覧の 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 はテストの文脈のみを示し、購入済みの実サーバーも含み得ます。シミュレーションの証明でも、課金や安全確認の回避でもありません。