getNetworkInterfaceList

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VPC環境で利用できます。

概要

ネットワークインターフェースリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名	要否	タイプ	説明
regionCode	No	String	- リージョンコードネットワークインターフェースリストが照会されるリージョン(Region)を決定できる regionCodeは、getRegionListアクションを通じて取得可能デフォルト：getRegionList照会結果の最初のリージョンを選択
subnetName	No	String	- サブネット番号ネットワークインターフェースリストが照会されるサブネットの名前でフィルタリングして検索できる
networkInterfaceNoList.N	No	List	- ネットワークインターフェース番号リストネットワークインターフェース番号でフィルタリングして検索できる networkInterfaceNoは、getNetworkInterfaceListアクションを通じて取得可能例) --networkInterfaceNoList 1234 2345
networkInterfaceName	No	String	- ネットワークインターフェースの名前ネットワークインターフェース名でフィルタリングして検索できる
networkInterfaceStatusCode	No	String	ネットワークインターフェースの状態コードオプション： SET \| UNSET \| USED \| NOTUSED
ip	No	String	- IPアドレスネットワークインターフェースに割り当てられたIPアドレスでフィルタリングして検索できる
secondaryIpList.N	No	List	- セカンダリIPリストネットワークインターフェースに割り当てられたセカンダリIPアドレスでフィルタリングして検索できるネットワークインターフェースに割り当てられたsecondaryIpは、getNetworkInterfaceListアクションを通じて取得できる例) secondaryIpList.1=192.168.0.1&secondaryIpList.2=192.168.0.2
instanceNo	No	String	- インスタンス番号ネットワークインターフェースが割り当てられているデバイスのインスタンス番号でフィルタリングして検索できる instanceNoは、instanceTypeに該当する照会アクションを通じて取得できる
isDefault	No	Boolean	- デフォルトかどうかネットワークインターフェースがデフォルトかどうかでフィルタリングして検索できるオプション： true \| false
deviceName	No	String	- デバイスの名前ネットワークインターフェースが割り当てられたデバイスでのイーサネット名でフィルタリングして検索できるオプション： eth0 \| eth1 \| eth2
serverName	No	String	- サーバ名ネットワークインターフェースが割り当てられたサーバの名前でフィルタリングして検索できる
pageNo	No	Integer	- ページングされた結果のページ番号結果値をpageNo、pageSizeを利用してページング処理できる
pageSize	Conditional	Integer	- ページング時に表示する各ページサイズ結果値をpageNo、pageSizeを利用してページング処理できる pageNoを入力する際に必ず入力

レスポンス

レスポンスデータのタイプ

NetworkInterfaceListタイプ

NetworkInterfaceList extends CommonResponse
private Integer totalRows;
private List<NetworkInterface> networkInterfaceList = new ArrayList<>();

NetworkInterface
private String networkInterfaceNo;
private String networkInterfaceName;
private String subnetNo;
private Boolean deleteOnTermination;
private Boolean isDefault;
private String deviceName;
private CommonCode networkInterfaceStatus;
private CommonCode instanceType;
private String instanceNo;
private String ip;
private String macAddress;
private AccessControlGroupNoList accessControlGroupNoList;
private String networkInterfaceDescription;
private SecondaryIpList secondaryIpList;

SecondaryIpList
private List<String> secondaryIpList = new ArrayList<>();

例

リクエスト例

ncloud vserver getNetworkInterfaceList --regionCode KR --subnetName test-*** --networkInterfaceNoList ***87 ***88 --networkInterfaceName test-*** --networkInterfaceStatusCode USED --ip ***.***.1.6 --secondaryIpList ***.***.1.7 --instanceNo ***4299 --isDefault ture --deviceName eth0 --serverName test-***

レスポンス例

<getNetworkInterfaceListResponse>
  <requestId>73caedc4-073d-4001-a363-efedd90831be</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <networkInterfaceList>
    <networkInterface>
      <networkInterfaceNo>***87</networkInterfaceNo>
      <networkInterfaceName>test-***</networkInterfaceName>
      <subnetNo>***43</subnetNo>
      <deleteOnTermination>true</deleteOnTermination>
      <isDefault>true</isDefault>
      <deviceName>eth0</deviceName>
      <networkInterfaceStatus>
        <code>USED</code>
        <codeName>used </codeName>
      </networkInterfaceStatus>
      <instanceType>
        <code>VSVR</code>
        <codeName>Server (VPC)</codeName>
      </instanceType>
      <instanceNo>***4299</instanceNo>
      <ip>***.***.1.6</ip>
      <macAddress>F2:20:***:***:8A:F5</macAddress>
      <accessControlGroupNoList>
        <accessControlGroupNo>***63</accessControlGroupNo>
      </accessControlGroupNoList>
      <networkInterfaceDescription></networkInterfaceDescription>
      <secondaryIpList>
        <secondaryIp>***.***.1.7</secondaryIp>
      </secondaryIpList>
    </networkInterface>
  </networkInterfaceList>
</getNetworkInterfaceListResponse>

この記事は役に立ちましたか?

What's Next

getNetworkInterfaceDetail

概要
リクエスト
レスポンス
例

タグ