ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.0 リファレンスガイド (API編)
ServerView
第2章 L-Platform APIリファレンス > 2.1 L-Platformテンプレートの操作 > 2.1.7 ListNetworkResource (ネットワークリソースの一覧を取得)
前次

2.1.7 ListNetworkResource (ネットワークリソースの一覧を取得)

ネットワークリソースの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

Version

説明

L-Platform APIのバージョンID

型

string ASCII

設定内容

固定。"2.0"を指定してください。

Locale

説明

L-Platform APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

型

string ASCII

設定内容

以下から選択します。
・"ja": 日本語
・"en": 英語

Action

説明

実行するL-Platform APIの名称

型

string ASCII

設定内容

固定。"ListNetworkResource"を指定してください。

userId

説明

L-Platform APIを実行するユーザーID

型

string ASCII

設定内容

31文字以内

orgId

説明

L-Platform APIを実行するユーザーのテナント名

型

string ASCII

設定内容

32文字以内

networkCategory

説明

ネットワーク種別。指定したネットワーク種別のネットワークリソースを取得します。

型

string ASCII

設定内容

以下のどちらかを指定してください。

・MANAGEMENT: ネットワーク種別にMANAGEMENTが設定されているネットワークリソースを取得します。
・BUSINESS: ネットワーク種別にBUSINESSが設定されているネットワークリソースを取得します。

省略時は、すべてのネットワークリソースを取得します。

segmentType

説明

セグメント識別情報。登録されているセグメント識別情報が一致するネットワークリソースを取得します。

型

string ASCII

設定内容

32文字以内

showTenant

説明

テナント名表示オプション。

型

string ASCII

設定内容

"true"または"false"のどちらかを指定してください。

省略時は"false"が指定されたものとして動作します。


レスポンス

《ステータスコード》

正常に終了した場合に"200 OK"を返します。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkResourceResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <networks>
    <network>
      <addressSet>
        <end>[アドレスセットの終了アドレス]</end>
        <mask>[アドレスセットのネットマスク]</mask>
        <name>[アドレスセットの名前]</name>
        <start>[アドレスセットの開始アドレス]</start>
        <subnet>[アドレスセットのサブネットアドレス]</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>[アドレスセットの空きアドレス個数]</avail>
        <num>[アドレスセットのアドレス個数]</num>
        <used>[アドレスセットの予約済みアドレス個数]</used>
      </addressSetStatus>
      <networkCategory>[ネットワーク種別]</networkCategory>
      <vlanId>[VLANID]</vlanId>
      <excludeaddressranges>
        <excludeaddressrange>
          <start>[除外アドレスの開始アドレス]</start>
          <end>[除外アドレスの終了アドレス]</end>
        </excludeaddressrange>
      </excludeaddressranges>
      <vlanId>12</vlanId>
      <resourceId>[ネットワークリソースID]</resourceId>
      <resourceName>[ネットワークリソース名]</resourceName>
      <resourceType>[ネットワークリソースの種別]</resourceType>
      <tenantName>[ネットワークプールのリソースプールのテナント名]</tenantName>
      <comment>[コメント]</comment>
      <gateway>[デフォルトゲートウェイ]</gateway>
    </network>
  </networks>
</ListNetworkResourceResponse>

《要素》

要素名

項目

項目説明

ListNetworkResourceResponse

説明

レスポンスの情報を持つ要素

型

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。

型

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。

型

string ASCII

出現回数

1

networks

説明

ネットワークリソース情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

network

説明

ネットワークリソース情報の一式

型

なし

出現回数

0以上

resourceId

説明

ネットワークリソースID

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

resourceName

説明

ネットワークリソース名

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

tenantName

説明

ネットワークプールのリソースプールのテナント名

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

networkCategory

説明

ネットワーク種別

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

vlanId

説明

VLANID

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

resourceType

説明

ネットワークリソースの種別

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

segmentType

説明

セグメント識別情報

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

comment

説明

コメント

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

gateway

説明

デフォルトゲートウェイ

型

string ASCII

出現回数

networkの数分(それぞれに対して0または1)

addressSet

説明

アドレスセット情報の一式

型

なし

出現回数

networkの数分(それぞれに対して0または1)

name

説明

アドレスセットの名前

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

subnet

説明

アドレスセットのサブネットアドレス

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

mask

説明

アドレスセットのネットマスク

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

start

説明

アドレスセットの開始アドレス

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

end

説明

アドレスセットの終了アドレス

型

string ASCII

出現回数

addressSetの数分(それぞれに対して0または1)

excludeaddressranges

説明

除外アドレス情報のレスポンス情報を持つ要素

型

なし

出現回数

networkの数分(それぞれに対して0または1)

excludeaddressrange

説明

除外アドレス情報の一式

型

なし

出現回数

0以上

start

説明

除外アドレスの開始アドレス

型

string ASCII

出現回数

excludeaddressrangeの数分(それぞれに対して0または1)

end

説明

除外アドレスの終了アドレス

型

string ASCII

出現回数

excludeaddressrangeの数分(それぞれに対して0または1)

addressSetStatus

説明

アドレスセットのステータス情報

型

なし

出現回数

netwaorkの数分(それぞれに対して0または1)

num

説明

アドレスセットのアドレス個数

型

string ASCII

出現回数

addressSetStatusの数分(それぞれに対して0または1)

used

説明

アドレスセットの予約済みアドレス個数

型

string ASCII

出現回数

addressSetStatusの数分(それぞれに対して0または1)

avail

説明

アドレスセットの空きアドレス個数

型

string ASCII

出現回数

addressSetStatusの数分(それぞれに対して0または1)


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkResourceResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <networks>
    <network>
      <addressSet>
        <end>192.xxx.xxx.xxx</end>
        <mask>255.xxx.xxx.xxx</mask>
        <name>addr_set10</name>
        <start>192.xxx.xxx.xxx</start>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>138</avail>
        <num>140</num>
        <used>2</used>
      </addressSetStatus>
      <networkCategory>BUSINESS</networkCategory>
      <vlanId>11</vlanId>
      <resourceId>network-t-0001</resourceId>
      <resourceName>tenantA-DMZ</resourceName>
      <segmentType>SECURE</segmentType>
    </network>
    <network>
      <addressSet>
        <end>192.xxx.xxx.xxx</end>
        <mask>255.xxx.xxx.xxx</mask>
        <name>Global-Secure</name>
        <start>192.xxx.xxx.xxx</start>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>254</avail>
        <num>254</num>
        <used>254</used>
      </addressSetStatus>
      <networkCategory>MANAGEMENT</networkCategory>
      <excludeaddressranges>
        <excludeaddressrange>
          <start>192.xxx.xxx.xxx</start>
          <end>192.xxx.xxx.xxx</end>
        </excludeaddressrange>
      </excludeaddressranges>
      <vlanId>12</vlanId>
      <resourceId>network-t-0002</resourceId>
      <resourceName>tenantA-Secure</resourceName>
    </network>
  </networks>
</ListNetworkResourceResponse>

前次
Copyright 2011-2012 FUJITSU LIMITED