ネットワークの REST API

この REST API を使用して、ネットワークの詳細を取得します。

すべてのネットワークの取得

表 1. すべてのネットワークの取得
REST API 情報	値	説明
URI	/admin/resources/networks
メソッド	GET
戻り	200	すべてのネットワークのリストを返します。
	404	ネットワークのリストが見つかりませんでした。
	500	Platform System Manager は、要求の処理中に内部エラーを検出しました。

ネットワークのリストを返します。

オプション・パラメーターを使用して、REST API 呼び出しからの応答を変更することができます。詳しくは、「関連情報」セクションを参照してください。

応答本体

[
   {
      "link_state": "available",
      "created_time_raw": 1464287198968,
      "stg_power_state": "enabled",
      "stg": 127,
      "vlanid": "1061",
      "visible": "T",
      "network_type": "eb59b123-f95f-432b-9a02-82ef396088ab",
      "location": null,
      "state": "available",
      "isas_rn": 1,
      "label_text": "VLAN",
      "purpose": "management,untagged native",
      "hsrp": "false",
      "portgroup_key": null,
      "type": "vlan",
      "updated_time": "Thu 09 Jun 2016 00:13:42.281 UTC",
      "label_key": "pure2301",
      "version": "2.2.2.0",
      "id": "/admin/resources/networks/c871a5b2-b51c-479f-96a8-98b6af278165",
      "label_user": "VLAN",
      "updated_time_raw": 1465431222281,
      "description": "location[tor2,tor1,compass11,compass22,compass21,compass12];",
      "name": "MGMT VLAN 1061",
      "parent_type": null,
      "stg_state": "active",
      "created_time": "Thu 26 May 2016 18:26:38.968 UTC"
   }
]

[
   {
      "link_state": "available",
      "created_time_raw": 1465936021923,
      "stg_power_state": "disabled",
      "stg": 1,
      "vlanid": "1",
      "visible": "T",
      "network_type": "7c8e0eac-8201-43fa-b9ca-52445e41fe7b",
      "location": "",
      "state": "available",
      "isas_rn": 1,
      "label_text": "VLAN",
      "purpose": "native vlan",
      "hsrp": "true",
      "portgroup_key": null,
      "type": "vlan",
      "updated_time": "Tue 09 Aug 2016 13:46:44.161 UTC",
      "label_key": "pure2301",
      "version": "2.2.2.0",
      "id": "/admin/resources/networks/71a4e493-4dfe-4e3f-a818-622154538742",
      "label_user": "VLAN",
      "updated_time_raw": 1470750404161,
      "description": "location[tor1,tor2];",
      "name": "DEFAULT VLAN",
      "parent_type": null,
      "stg_state": "not_applicable",
      "created_time": "Tue 14 Jun 2016 20:27:01.923 UTC"
   }
]

created_time: オブジェクトが作成された時刻
説明: ネットワークの説明
ID: システム内のオブジェクトの固有 ID。
label_key: ネットワークのラベルを取得するためのキー
label_text: デフォルトで翻訳されたメッセージ・テキスト
label_user: ユーザーに変更されたメッセージ・テキスト
link_state: ネットワーク・リンクの状態
location: ネットワークのロケーション
名前: ネットワークの記述名
network_type: ネットワークのタイプ
parent_type: ネットワークが属している親のタイプ
portgroup_key: このネットワークに関連付けられているポート・グループ
状態: オブジェクトの一般可用性。「pending」の場合、オブジェクトは作成されたが、アクティブ化されていません。「available」の場合、オブジェクトはシステムでアクティブです。
タイプ: このネットワークのタイプ。通常、これは VLAN です。
updated_time: オブジェクトが最後に更新された時刻
vlanid: システム上のネットワークの固有番号
parent_type: 一般的な親のタイプ

親:

ラック、 management_nodes、スイッチ

特定のネットワークの取得

表 2. 特定のネットワークの取得
REST API 情報	値	説明
URI	/admin/resources/networks/{id}
メソッド	GET
戻り	200	ネットワークが返されました。
	404	ネットワークが見つかりませんでした。
	500	Platform System Manager は、要求の処理中に内部エラーを検出しました。

{id} で識別される単一のネットワークを返します。