概要

サーバイメージリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名	必須の有無	タイプ	説明
regionCode	No	String	- リージョンコードサーバイメージリスト照会対象のリージョン(Region) regionCodeはgetRegionListアクションを通じて取得可能デフォルト: getRegionList照会結果の最初のリージョンを選択
serverImageNoList.N	No	List<String>	- サーバイメージ番号リストサーバイメージ番号でフィルタリングして検索可能 serverImageNoはgetServerImageListアクションを通じて取得可能例) serverImageNoList.1=1234&serverImageNoList.2=2345
serverImageName	No	String	- サーバイメージ名サーバイメージ名でフィルタリングして検索可能
serverImageStatusCode	No	String	- サーバイメージの状態コードサーバイメージの状態コードでフィルタリングして検索可能オプション: INIT \| CREAT
serverImageTypeCodeList.N	No	List<String>	- サーバイメージタイプコードリストサーバイメージタイプコードでフィルタリングして検索可能オプション: SELF \| NCP 例) serverImageTypeCodeList.1=NCP
hypervisorTypeCodeList.N	No	List<String>	- ハイパーバイザタイプコードリストハイパーバイザタイプコードでフィルタリングして検索可能オプション: XEN \| KVM 例) hypervisorTypeCodeList.1=XEN&hypervisorTypeCodeList.2=KVM
osTypeCodeList.N	No	List<String>	- OSタイプコードリスト OSタイプコードでフィルタリングして検索可能オプション: CENTOS \| UBUNTU \| WINDOWS 例) osTypeCodeList.1=CENTOS&osTypeCodeList.2=UBUNTU
platformCategoryCodeList.N	No	List<String>	- プラットフォームカテゴリコードリストプラットフォームカテゴリコードでフィルタリングして検索可能オプション: OS \| APP \| DBMS \| GPU 例) platformCategoryCodeList.1=OS&platformCategoryCodeList.2=GPU
pageNo	No	Integer	- ページングされた結果のページ番号結果値を pageNo、pageSizeを利用してページング処理可能
pageSize	Conditional	Integer	- ページング時に表示する各ページのサイズ結果値を pageNo、pageSizeを利用してページング処理可能 pageNo入力時、必ず入力
sortedBy	No	String	- ソート対象結果値をサーバイメージ名でソート可能オプション: serverImageName
sortingOrder	No	String	- ソート順序 sortedBy利用時、昇順または降順のソートを設定オプション: ASC (昇順) \| DESC (降順) デフォルト: ASC
responseFormatType	No	String	- レスポンス結果の形式タイプオプション: xml \| json デフォルト: xml

レスポンス

レスポンスボディ

ServerImageList

例

リクエスト例

GET {API_URL}/getServerImageList
?regionCode=KR
&serverImageNoList.1=***5847
&serverImageName=test-***
&serverImageStatusCode=CREAT
&osTypeCodeList.1=CENTOS

レスポンス例

<getServerImageListResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverImageList>
    <serverImage>
      <serverImageNo>***5847</serverImageNo>
      <serverImageName>test-***</serverImageName>
      <serverImageDescription></serverImageDescription>
      <serverImageType>
        <code>NCP</code>
        <codeName>NCP Server Image</codeName>
      </serverImageType>
      <serverImageLifeCyclePhase>
        <code>IN_SERVICE</code>
        <codeName>In Service</codeName>
      </serverImageLifeCyclePhase>
      <hypervisorType>
        <code>XEN</code>
        <codeName>XEN</codeName>
      </hypervisorType>
      <cpuArchitectureType>
        <code>X86_64</code>
        <codeName>x86 64bit</codeName>
      </cpuArchitectureType>
      <osCategoryType>
        <code>LINUX</code>
        <codeName>LINUX</codeName>
      </osCategoryType>
      <osType>
        <code>CENTOS</code>
        <codeName>CENTOS</codeName>
      </osType>
      <productCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</productCode>
      <serverImageStatus>
        <code>CREAT</code>
        <codeName>Server created state</codeName>
      </serverImageStatus>
      <serverImageOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </serverImageOperation>
      <serverImageStatusName>created</serverImageStatusName>
      <createDate>2020-08-24T10:34:27+0900</createDate>
      <blockStorageMappingList>
        <blockStorageMapping>
          <order>0</order>
          <blockStorageSize>53687091200</blockStorageSize>
          <blockStorageVolumeType>
            <code>HDD</code>
            <codeName>HDD</codeName>
          </blockStorageVolumeType>
          <isEncryptedVolume>false</isEncryptedVolume>
        </blockStorageMapping>
      </blockStorageMappingList>
      <shareStatus>
        <code>NULL</code>
        <codeName>NSI Share NULL State</codeName>
      </shareStatus>
      <sharedLoginIdList/>
    </serverImage>
  </serverImageList>
</getServerImageListResponse>

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

概要
リクエスト
- リクエストパラメータ
レスポンス
- レスポンスボディ
例
- リクエスト例
- レスポンス例

タグ

Server