VPC環境で利用できます。
概要
会員サーバ画像のインスタンスリストを照会します。
注意
KVMサーバのマイサーバイメージには対応していません。
リクエスト
リクエストパラメータ
| パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
|---|---|---|---|---|
| regionCode | No | String | - リージョンコード 会員サーバイメージインスタンスリスト照会対象のリージョン(Region)を決定可能 regionCodeはgetRegionListアクションを通じて取得可能 デフォルト: getRegionList照会結果の最初のリージョンを選択 |
|
| memberServerImageInstanceNoList.N | No | List<String> | - 会員サーバイメージインスタンス番号リスト 会員サーバイメージインスタンス番号で絞り込んで検索可能 memberServerImageInstanceNoはgetMemberServerImageInstanceListアクションを通じて取得可能 例) --memberServerImageInstanceNoList 1234 2345 |
|
| memberServerImageName | No | String | - 会員サーバイメージ名 会員サーバイメージ名で絞り込んで検索可能 |
|
| memberServerImageInstanceStatusCode | No | String | - 会員サーバイメージインスタンスの状態コード 会員サーバイメージインスタンスの状態コードで絞り込んで検索可能 オプション: INIT | CREAT | CREFL |
|
| platformTypeCodeList.N | No | List<String> | - プラットフォームタイプコードリスト プラットフォームタイプで絞り込んで検索可能 オプション: LNX32 | LNX64 | WND32 | WND64 | UBD64 | UBS64 例) --platformTypeCodeList LNX32 LNX64 |
|
| pageNo | No | Integer | - ページングされた結果のページ番号 結果値を pageNo、pageSizeを利用してページング処理可能 |
|
| pageSize | Conditional | Integer | - ページング時に表示する各ページサイズ 結果値をpageNo、pageSizeを利用してページング処理できる pageNoを入力する際に必ず入力 |
|
| sortedBy | No | String | - ソート対象 結果値を会員サーバイメージ名でソート可能 オプション: memberServerImageName |
|
| sortingOrder | No | String | - ソート順序 sortedByの利用時、昇順または降順のソートを設定 オプション: ASC(昇順) | DESC(降順) デフォルト: ASC |
|
| output | No | String | レスポンス結果の形式タイプ
|
レスポンス
レスポンスデータタイプ
- MemberServerImageInstanceListタイプ
| MemberServerImageInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List<MemberServerImageInstance> memberServerImageInstanceList = new ArrayList<>(); |
| MemberServerImageInstance |
|---|
| private String memberServerImageInstanceNo; |
| private String memberServerImageName; |
| private String memberServerImageDescription; |
| private String originalServerInstanceNo; |
| private String originalServerImageProductCode; |
| private CommonCode memberServerImageInstanceStatus; |
| private CommonCode memberServerImageInstanceOperation; |
| private String memberServerImageInstanceStatusName; |
| private Date createDate; |
| private Integer memberServerImageBlockStorageTotalRows; |
| private Long memberServerImageBlockStorageTotalSize; |
| private CommonCode shareStatus; |
| private SharedLoginIdList sharedLoginIdList; |
例
リクエスト例
ncloud vserver getMemberServerImageInstanceList --regionCode KR --memberServerImageInstanceNoList ***5847 --memberServerImageName test-*** --memberServerImageInstanceStatusCode CREAT --platformTypeCodeList LNX64
レスポンス例
<getMemberServerImageInstanceListResponse>
<requestId></requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<memberServerImageInstanceList>
<memberServerImageInstance>
<memberServerImageInstanceNo>***5847</memberServerImageInstanceNo>
<memberServerImageName>test-***</memberServerImageName>
<memberServerImageDescription></memberServerImageDescription>
<originalServerInstanceNo>***4299</originalServerInstanceNo>
<originalServerImageProductCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</originalServerImageProductCode>
<memberServerImageInstanceStatus>
<code>CREAT</code>
<codeName>NSI CREATED state</codeName>
</memberServerImageInstanceStatus>
<memberServerImageInstanceOperation>
<code>NULL</code>
<codeName>NSI NULLOP</codeName>
</memberServerImageInstanceOperation>
<memberServerImageInstanceStatusName>created</memberServerImageInstanceStatusName>
<createDate>2020-08-24T10:34:27+0900</createDate>
<shareStatus>
<code>NULL</code>
<codeName>NSI Share NULL State</codeName>
</shareStatus>
<sharedLoginIdList/>
</memberServerImageInstance>
</memberServerImageInstanceList>
</getMemberServerImageInstanceListResponse>