getBlockStorageInstanceList
- 印刷する
- PDF
getBlockStorageInstanceList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
概要
ブロックストレージインスタンスリストを照会します。
リクエスト
リクエストパラメータ
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| regionCode | No | String | - | - リージョンコード ブロックストレージのインスタンスリストを照会するリージョン(Region)を決定できる regionCodeは、getRegionListアクションを通じて取得可能 Default: getRegionList照会結果の最初のリージョンを選択 |
| zoneCode | No | String | - | - ZONEコード ブロックストレージインスタンスリストを照会するゾーン(zone)を決定できる zoneCodeは、getZoneListアクションを通じて取得可能 |
| blockStorageInstanceNoList | No | List<String> | - | - ブロックストレージインスタンス番号リスト ブロックストレージインスタンス番号でフィルタリングして検索可能 blockStorageInstanceNoは、getBlockStorageInstanceListアクションを通じて取得可能 ex) --blockStorageInstanceNoList 1234 2345 |
| blockStorageInstanceStatusCode | No | String | - | - ブロックストレージインスタンス状態コード ブロックストレージインスタンス状態コードでフィルタリングして検索可能 Options : INIT | CREAT | ATTAC |
| blockStorageDiskTypeCode | No | String | - | - ブロックストレージディスクタイプコード ブロックストレージディスクタイプでフィルタリングして検索可能 Options : NET |
| blockStorageDiskDetailTypeCode | No | String | - | - ブロックストレージディスク詳細タイプコード ブロックストレージディスク詳細タイプでフィルタリングして検索可能 Options : HDD | SSD |
| blockStorageSize | No | Integer | - | - ブロックストレージサイズ 入力した GB単位サイズ以下のブロックストレージをフィルタリングして検索可能 |
| blockStorageTypeCodeList | No | List<String> | - | - ブロックストレージタイプコードリスト ブロックストレージタイプでフィルタリングして検索可能 Options: BASIC (サーバインスタンスのデフォルトのブロックストレージ) |
| serverInstanceNo | No | String | - | - サーバーインスタンス番号 ブロックストレージが割り当てられたサーバインスタンス番号でフィルタリングして検索できる serverInstanceNoは、getServerInstanceListアクションを通じて取得可能 |
| blockStorageName | No | String | - | - ブロックストレージ名 ブロックストレージ名でフィルタリングして検索可能 blockStorageName、serverName、connectionInfoのいずれかの検索条件のみ使用可能 |
| serverName | No | String | - | - サーバ名 ストレージインターフェースが割り当てられたサーバの名前でフィルタリングして検索できる blockStorageName、serverName、connectionInfoのいずれかの検索条件のみ使用可能 |
| connectionInfo | No | String | - | - 接続情報 ブロックストレージが割り当てられたサーバとデバイス接続情報でフィルタリングして検索できる 次の2つの形で使用可能 Options: 「サーバ名 [空白] デバイス名」(s173dc67dc2e /dev/xvda) |
| blockStorageVolumeTypeCodeList | No | List<String> | - | - ブロックストレージボリュームタイプコードリスト ブロックストレージボリュームタイプでフィルタリングして検索可能 Options : SSD | HDD | FB1 | CB1 ex) --blockStorageVolumeTypeCodeList HDD SSD |
| hypervisorTypeCodeList | No | List<String> | - | - ハイパーバイザータイプコードリスト ハイパーバイザータイプでフィルタリングして検索可能 Options : XEN | KVM ex) --hypervisorTypeCodeList KVM XEN |
| pageNo | No | Integer | - | - ページングされた結果のページ番号 結果値を pageNo、pageSizeを利用してページング処理可能 |
| pageSize | Conditional | Integer | - | - ページング時に表示する各ページのサイズ 結果値を pageNo、pageSizeを利用してページング処理可能 pageNoを入力時に必ず入力 |
| responseFormatType | No | String | - | - レスポンス結果のフォーマットタイプ Options : xml | json Default : xml |
レスポンス
レスポンスデータのタイプ
- BlockStorageInstanceListタイプ
| BlockStorageInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List<BlockStorageInstance> blockStorageInstanceList = new ArrayList<>(); |
| BlockStorageInstance |
|---|
| private String blockStorageInstanceNo; |
| private String serverInstanceNo; |
| private String blockStorageName; |
| private CommonCode blockStorageType; |
| private Long blockStorageSize; |
| private String deviceName; |
| private String blockStorageProductCode; |
| private CommonCode blockStorageInstanceStatus; |
| private CommonCode blockStorageInstanceOperation; |
| private String blockStorageInstanceStatusName; |
| private Date createDate; |
| private String blockStorageDescription; |
| private CommonCode blockStorageDiskType; |
| private CommonCode blockStorageDiskDetailType; |
| private Integer maxIopsThroughput; |
| private Boolean isEncryptedVolume; |
| private String zoneCode; |
| private String regionCode; |
| private Boolean isReturnProtection; |
| private CommonCode blockStorageVolumeType; |
| private CommonCode hypervisorType; |
| private Long throughput; |
| private Long iops; |
| private Long blockStorageSnapshotInstanceNo; |
例
リクエスト例
ncloud vserver getBlockStorageInstanceList --regionCode KR --zoneCode KR-1 --blockStorageInstanceNoList ***7746 --blockStorageInstanceStatusCode ATTAC --blockStorageDiskTypeCode NET --blockStorageDiskDetailTypeCode SSD --blockStorageSize 50 --blockStorageTypeCodeList BASIC --serverInstanceNo ***4299 --connectionInfo test-***:/dev/xvda
レスポンス例
<getBlockStorageInstanceListResponse>
<requestId></requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<blockStorageInstanceList>
<blockStorageInstance>
<blockStorageInstanceNo>***7746</blockStorageInstanceNo>
<serverInstanceNo>***4299</serverInstanceNo>
<blockStorageName>test-***</blockStorageName>
<blockStorageType>
<code>BASIC</code>
<codeName>Basic BS</codeName>
</blockStorageType>
<blockStorageSize>53687091200</blockStorageSize>
<deviceName>/dev/xvda</deviceName>
<blockStorageProductCode>SPBSTBSTBS000005</blockStorageProductCode>
<blockStorageInstanceStatus>
<code>ATTAC</code>
<codeName>Block storage ATTACHED state</codeName>
</blockStorageInstanceStatus>
<blockStorageInstanceOperation>
<code>NULL</code>
<codeName>Block Storage NULLOP</codeName>
</blockStorageInstanceOperation>
<blockStorageInstanceStatusName>attached</blockStorageInstanceStatusName>
<createDate>2020-08-19T15:05:07+0900</createDate>
<blockStorageDescription>test-***'s basic storage</blockStorageDescription>
<blockStorageDiskType>
<code>NET</code>
<codeName>Network Storage</codeName>
</blockStorageDiskType>
<blockStorageDiskDetailType>
<code>SSD</code>
<codeName>SSD</codeName>
</blockStorageDiskDetailType>
<maxIopsThroughput>4000</maxIopsThroughput>
<isEncryptedVolume>false</isEncryptedVolume>
<zoneCode>KR-1</zoneCode>
<regionCode>KR</regionCode>
<isReturnProtection>false</isReturnProtection>
<blockStorageVolumeType>
<code>CB1</code>
<codeName>Common BlockStorage 1</codeName>
</blockStorageVolumeType>
<hypervisorType>
<code>KVM</code>
<codeName>KVM</codeName>
</hypervisorType>
<throughput>10000</throughput>
<iops>1000</iops>
<blockStorageSnapshotInstnaceNo>1002120</blockStorageSnapshotInstnaceNo>
</blockStorageInstance>
</blockStorageInstanceList>
</getBlockStorageInstanceListResponse>
この記事は役に立ちましたか?