本文へ
ドキュメントAPI リファレンスサーバーのプライベートネットワークを取得
GETBearer トークン

サーバーのプライベートネットワークを取得

/api/v1/servers/:id/networks

現在の組織のサーバーと物理インスタンスに属するローカルポート記録を最大100件取得します。存在しない、削除済み、移管済みのサーバーは404を返します。物理インスタンスの識別情報が無効な場合は409を返します。記録がないことは隔離や課金停止の証明にはなりません。

呼び出す前に

ローカルデータの読み取り専用です。供給元への要求、課金、書き込みは行いません。すべての capabilities は false です。地域や供給元の一致は互換性や安全な接続を保証しません。

API のフィールド名、型、コードはすべての言語で共通です。

リクエスト例

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

表示のみ。このページから API リクエストは送信されません。

レスポンス例
JSON
{
  "serverId": "507f1f77bcf86cd799439013",
  "ports": [],
  "nextCursor": null,
  "testOnly": false,
  "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."
  }
}

パラメーター

idパス · 必須

string

現在の組織のサーバー ID(24 桁の 16 進文字)。削除済みまたは移管済みサーバーにはアクセスできません。

afterクエリ · 任意

string

nextCursorから取得した24桁の16進数ポートカーソル(省略可能)。このカーソルより大きいポートIDを最大100件返します。nullは次のページがないことを示します。

レスポンス

HTTP ステータス 200

現在の組織のサーバーと物理インスタンスに属するローカルポート記録を最大100件取得します。存在しない、削除済み、移管済みのサーバーは404を返します。物理インスタンスの識別情報が無効な場合は409を返します。記録がないことは隔離や課金停止の証明にはなりません。

serverIdstring

現在の組織のサーバー ID(24 桁の 16 進文字)。削除済みまたは移管済みサーバーにはアクセスできません。

testOnlyboolean

true はテストの文脈のみを示し、購入済みの実サーバーも含み得ます。シミュレーションの証明でも、課金や安全確認の回避でもありません。

portsobject[]

現在の組織のサーバーと物理インスタンスに属するローカルポート記録を最大100件取得します。存在しない、削除済み、移管済みのサーバーは404を返します。物理インスタンスの識別情報が無効な場合は409を返します。記録がないことは隔離や課金停止の証明にはなりません。

ports[].idstring

供給元ではなくプラットフォームの識別子です。

ports[].slotinteger

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].serverIdstring

現在の組織のサーバー ID(24 桁の 16 進文字)。削除済みまたは移管済みサーバーにはアクセスできません。

ports[].activeboolean

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].reservationStatestring

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].connectionStatestring

接続とIPの情報には、一致する組織所有のネットワークと未来ではない有効な確認日時が必要です。それ以外はconnectionStateがunknown、checkedAt/privateIpsがnullになります。ローカルスナップショットのみです。

ports[].privateIpsstring[] | null

接続とIPの情報には、一致する組織所有のネットワークと未来ではない有効な確認日時が必要です。それ以外はconnectionStateがunknown、checkedAt/privateIpsがnullになります。ローカルスナップショットのみです。

ports[].checkedAtstring | null

接続とIPの情報には、一致する組織所有のネットワークと未来ではない有効な確認日時が必要です。それ以外はconnectionStateがunknown、checkedAt/privateIpsがnullになります。ローカルスナップショットのみです。

ports[].versioninteger

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].testOnlyboolean

true はテストの文脈のみを示し、購入済みの実サーバーも含み得ます。シミュレーションの証明でも、課金や安全確認の回避でもありません。

ports[].networkobject | null

list_networksと同じフィールドを持つ組織所有のネットワークスナップショット。ネットワークが取得できない場合や、テストコンテキストがサーバーまたはポートと異なる場合はnullです。

ports[].network.cidrstring | null

記録済みのプライベートネットワークCIDR。未観測の場合はnullです。

ports[].network.boundServersinteger | null

現在の組織が所有する物理サーバーへの有効な接続数。不整合の場合はnullです。

ports[].network.occupiedPortsinteger | null

予約中と取り外し中を含むローカルの有効な占有数。不整合の場合はnullです。

ports[].network.idstring

供給元ではなくプラットフォームの識別子です。

ports[].network.providerstring

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].network.namestring

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].network.regionstring

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].network.dataCenterstring | null

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].network.capacityinteger

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].network.statestring

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].network.versioninteger

保存されたローカルスナップショット値であり、検証済みの供給元の現在状態ではありません。

ports[].network.monthlyPricestring

米ドルではなくセント単位の整数文字列。表示価格は支払いを有効にしません。

ports[].network.serviceFromstring (ISO 8601) | null

購入完了の確認後にサービスを開始します。不明な場合は null です。

ports[].network.serviceUntilstring (ISO 8601) | null

プラットフォーム上の支払い済みサービス期限。供給元の支払い済み期限とは独立し、不明なら null です。

ports[].network.autoRenewboolean

更新の希望のみを示し、支払いや期間延長の完了を証明しません。

ports[].network.accessStatestring

保存されたローカルのネットワーク接続状態:active、stopping、stopped、restoring、unknown。提供元の現在の接続を検証した結果ではありません。

ports[].network.currency"USD"

固定通貨 USD、価格単位 cent、請求期間がある場合は month です。

ports[].network.priceUnit"cent"

固定通貨 USD、価格単位 cent、請求期間がある場合は month です。

ports[].network.checkedAtstring | null

スナップショット確認時刻(ISO 8601)。不明な場合は null。時刻があっても現在の検証ではありません。

ports[].network.testOnlyboolean

true はテストの文脈のみを示し、購入済みの実サーバーも含み得ます。シミュレーションの証明でも、課金や安全確認の回避でもありません。

ports[].network.source"local"

常に local。供給元へのリアルタイム要求は行いません。

ports[].network.verification"unknown" | "snapshot"

checkedAt がある場合は snapshot、それ以外は unknown。いずれも現在の供給元状態を検証しません。

ports[].network.capabilitiesobject

purchase、attach、disconnect、remove、reconnect、cancelAddon、renew、resize、delete の9項目はすべて false です。供給元の機能は未検証で、検証前は課金しません。スナップショットは互換性や安全な接続を証明しません。

nextCursorstring | null

nextCursorから取得した24桁の16進数ポートカーソル(省略可能)。このカーソルより大きいポートIDを最大100件返します。nullは次のページがないことを示します。

source"local"

常に local。供給元へのリアルタイム要求は行いません。

verification"unknown"

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

capabilitiesobject

purchase、attach、disconnect、remove、reconnect、cancelAddon、renew、resize、delete の9項目はすべて false です。供給元の機能は未検証で、検証前は課金しません。スナップショットは互換性や安全な接続を証明しません。