getServerImageList
- 印刷する
- PDF
getServerImageList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
概要
サーバイメージリストを照会します。
リクエスト
リクエストパラメータ
| パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
|---|---|---|---|---|
| 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タイプ
| ServerImageList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List<ServerImage> serverImageList = new ArrayList<>(); |
| ServerImage |
|---|
| private String serverImageNo; |
| private String serverImageName; |
| private String serverImageDescription; |
| private CommonCode serverImageType; |
| private CommonCode serverImageLifeCyclePhase; |
| private CommonCode hypervisorType; |
| private CommonCode cpuArchitectureType; |
| private CommonCode osCategoryType; |
| private CommonCode osType; |
| private String serverImageStatusName; |
| private CommonCode serverImageStatus; |
| private CommonCode serverImageOperation; |
| private String serverImageProductCode; |
| private Date createDate; |
| private CommonCode shareStatus; |
| private SharedLoginIdList sharedLoginIdList; |
| private List<BlockStorageMapping> blockStorageMappingList; |
例
リクエスト例
ncloud vserver getServerImageList --regionCode KR --serverImageNoList ***5847 --serverImageName test-*** --serverImageStatusCode CREAT --osTypeCodeList 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>
この記事は役に立ちましたか?