getNasVolumeInstanceList

Prev Next

VPC環境で利用できます。

概要

NASボリュームインスタンスリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
regionCode No String リージョンコード
NASボリュームインスタンスリストが照会されるリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default：getRegionList照会結果の最初のリージョンを選択
zoneCode No String ZONEコード
NASボリュームインスタンスリストが照会されるゾーン(zone)を決定できます。
zoneCodeはgetZoneListアクションを通じて取得できます。
nasVolumeInstanceNoList.N No List<String> NASボリュームインスタンス番号リスト
NASボリュームインスタンス番号でフィルタリングして検索できます。
nasVolumeInstanceNoはgetNasVolumeInstanceListアクションを通じて取得できます。
ex)--nasVolumeInstanceNoList 1234 2345
volumeName No String ボリューム名
NASボリューム名でフィルタリングして検索できます。
volumeAllotmentProtocolTypeCode No String ボリューム割り当てプロトコルタイプコード
ボリューム割り当てプロトコルタイプでフィルタリングして検索できます。
Options：NFS (CentOS、UbuntuなどLinuxサーバでマウントできます。)| CIFS (Windowsサーバでマウントできます。)
isEventConfiguration No Boolean イベント設定の有無
イベント設定の有無でフィルタリングして検索できます。
Options : true | false
isSnapshotConfiguration No Boolean スナップショット設定の有無
スナップショット設定の有無でフィルタリングして検索できます。
Options : true | false
pageNo No Integer ページングされた結果のページ番号
結果値をpageNo、pageSizeを利用してページング処理できます。
pageSize Conditional Integer ページングする時に表示する各ページのサイズ
結果値をpageNo、pageSizeを利用してページング処理できます。
pageNoを入力する時に必ず入力しなければなりません。
sortedBy No String ソート対象
結果値をNASボリュームインスタンス番号、ボリューム名、ボリュームの総サイズでソートできます。
Options : nasVolumeInstanceNo | volumeName | volumeTotalSize
sortingOrder No String ソート順序
sortedByを利用する時、昇順/降順ソートを設定します。
Options：ASC (昇順) | DESC (降順)
Default : ASC
responseFormatType No String レスポンス結果のフォーマットタイプ
Options : xml | json
Default : xml

レスポンス

レスポンスデータタイプ

  • NasVolumeInstanceListタイプ
NasVolumeInstanceList extends CommonResponse
private Integer totalRows;
private List<NasVolumeInstance> nasVolumeInstanceList = new ArrayList<>();
NasVolumeInstance
private String nasVolumeInstanceNo;
private CommonCode nasVolumeInstanceStatus;
private CommonCode nasVolumeInstanceOperation;
private String nasVolumeInstanceStatusName;
private Date createDate;
private String nasVolumeDescription;
private String mountInformation;
private CommonCode volumeAllotmentProtocolType;
private String volumeName;
private Long volumeTotalSize;
private Long volumeSize;
private Float snapshotVolumeConfigurationRatio;
private CommonCode snapshotVolumeConfigPeriodType;
private CommonCode snapshotVolumeConfigDayOfWeekType;
private Integer snapshotVolumeConfigTime;
private Long snapshotVolumeSize;
private Boolean isSnapshotConfiguration;
private Boolean isEventConfiguration;
private String regionCode;
private String zoneCode;
private ServerInstanceNoList nasVolumeServerInstanceNoList;
private Boolean isEncryptedVolume;
private List<NasVolumeInstanceCustomIp> nasVolumeInstanceCustomIpList;
private Boolean isReturnProtection;
NasVolumeInstanceCustomIp
private String customIp;

例

リクエスト例

ncloud vnas getNasVolumeInstanceList --regionCode KR --zoneCode KR-1 --nasVolumeInstanceNoList ***3901 --volumeName n***4567_test*** --volumeAllotmentProtocolTypeCode NFS --isEventConfiguration false --isSnapshotConfiguration false

レスポンス例

<getNasVolumeInstanceListResponse>
  <requestId>988048d6-30c6-4783-b2c9-bd2436d0db93</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <nasVolumeInstanceList>
    <nasVolumeInstance>
      <nasVolumeInstanceNo>***3901</nasVolumeInstanceNo>
      <nasVolumeInstanceStatus>
        <code>CREAT</code>
        <codeName>NAS create</codeName>
      </nasVolumeInstanceStatus>
      <nasVolumeInstanceOperation>
        <code>NULL</code>
        <codeName>NAS NULL OP</codeName>
      </nasVolumeInstanceOperation>
      <nasVolumeInstanceStatusName></nasVolumeInstanceStatusName>
      <createDate>1970-01-01T09:00:02+0900</createDate>
      <nasVolumeDescription></nasVolumeDescription>
      <mountInformation>***.***.0.20:/n***4567_test***</mountInformation>
      <volumeAllotmentProtocolType>
        <code>NFS</code>
        <codeName>NFS</codeName>
      </volumeAllotmentProtocolType>
      <volumeName>n***4567_test***</volumeName>
      <volumeTotalSize>536870912000</volumeTotalSize>
      <volumeSize>536870912000</volumeSize>
      <snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
      <snapshotVolumeConfigTime>0</snapshotVolumeConfigTime>
      <snapshotVolumeSize>0</snapshotVolumeSize>
      <isSnapshotConfiguration>false</isSnapshotConfiguration>
      <isEventConfiguration>false</isEventConfiguration>
      <regionCode>KR</regionCode>
      <zoneCode>KR-1</zoneCode>
      <nasVolumeServerInstanceNoList/>
      <isEncryptedVolume>false</isEncryptedVolume>
      <nasVolumeInstanceCustomIpList/>
      <isReturnProtection>false</isReturnProtection>
    </nasVolumeInstance>
  </nasVolumeInstanceList>
</getNasVolumeInstanceListResponse>