getBlockStorageSnapshotInstanceList
- 印刷する
- PDF
getBlockStorageSnapshotInstanceList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
概要
ブロックストレージのスナップショットインスタンスリストを照会します。
リクエスト
リクエストパラメータ
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| regionCode | No | String | - リージョンコード ブロックストレージスナップショットインスタンスリストが照会されるリージョン(Region)を決定できる regionCodeは、getRegionListアクションを通じて取得可能 Default: getRegionList照会結果の最初のリージョンを選択 | |
| blockStorageSnapshotInstanceNoList.N | No | List<String> | - ブロックストレージのスナップショットインスタンス番号リスト ブロックストレージのスナップショットインスタンス番号でフィルタリングして検索できる blockStorageSnapshotInstanceNoは、getBlockStorageSnapshotInstanceListアクションを通じて取得可能 ex) blockStorageSnapshotInstanceNoList.1=1234&blockStorageSnapshotInstanceNoList.2=2345 | |
| blockStorageSnapshotName | No | String | - ブロックストレージスナップショットの名前 ブロックストレージのスナップショット名でフィルタリングして検索できる | |
| blockStorageSnapshotInstanceStatusCode | No | String | - ブロックストレージのスナップショットインスタンスのステータスコード ブロックストレージのスナップショットインスタンスのステータスコードでフィルタリングして検索できる Options : INIT | CREAT | |
| originalBlockStorageInstanceNoList.N | No | List<String> | - 原本ブロックストレージインスタンス番号リスト 原本ブロックストレージインスタンス番号でフィルタリングして検索できる originalBlockStorageInstanceNoは、getBlockStorageInstanceListアクションを通じて取得可能 ex) originalBlockStorageInstanceNoList.1=1234&originalBlockStorageInstanceNoList.2=2345 | |
| blockStorageSnapshotVolumeSize | No | Integer | - ブロックストレージのスナップショットボリュームサイズ 入力した GB単位サイズ以下のブロックストレージスナップショットをフィルタリングして検索できる | |
| isEncryptedOriginalBlockStorageVolume | No | Boolean | - 原本ブロックストレージボリューム暗号化の要否 原本ブロックストレージボリューム暗号化の要否でフィルタリングして検索できる Options : true | false | |
| hypervisorTypeCodeList.N | No | List<String> | - ハイパーバイザータイプコードリスト ハイパーバイザータイプコードでフィルタリングして検索できる Options : XEN | KVM ex) hypervisorTypeCodeList.1=KVM | |
| isBootable | No | Boolean | - マイサーバ画像作成の要否 マイサーバ画像を作成できるかどうかをフィルタリングして検索できる Options : true | false | |
| pageNo | No | Integer | - ページングされた結果のページ番号 結果値を pageNo、pageSizeを利用してページング処理できる | |
| pageSize | Conditional | Integer | - ページングの際に表示する各ページのサイズ 結果値を pageNo、pageSizeを利用してページング処理できる pageNoを入力する際に必ず入力する | |
| sortedBy | No | String | - ソート対象 結果値をブロックストレージスナップショット名で並べ替えることができる Options : blockStorageSnapshotName | |
| sortingOrder | No | String | - ソート順序 sortedByの利用時、昇順/降順ソートを設定 Options: ASC (昇順) | DESC (降順) Default : ASC | |
| responseFormatType | No | String | - レスポンス結果のフォーマットタイプ Options : xml | json Default : xml |
レスポンス
レスポンスボディ
例
リクエスト例
GET {API_URL}/getBlockStorageSnapshotInstanceList
?regionCode=KR
&blockStorageSnapshotInstanceNoList.1=***1951
&blockStorageSnapshotName=test-***
&blockStorageSnapshotInstanceStatusCode=CREAT
&originalBlockStorageInstanceNoList.1=***7746
&blockStorageSnapshotVolumeSize=50
&isEncryptedOriginalBlockStorageVolume=false
&hypervisorTypeCodeList.1=KVM
&isBootable=true
レスポンス例
<getBlockStorageSnapshotInstanceListResponse>
<requestId>08cacedf-cfd7-4a8d-a495-89aa0d72f7ca</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<blockStorageSnapshotInstanceList>
<blockStorageSnapshotInstance>
<blockStorageSnapshotInstanceNo>***1951</blockStorageSnapshotInstanceNo>
<blockStorageSnapshotName>test-***</blockStorageSnapshotName>
<blockStorageSnapshotVolumeSize>53687091200</blockStorageSnapshotVolumeSize>
<originalBlockStorageInstanceNo>***7746</originalBlockStorageInstanceNo>
<blockStorageSnapshotInstanceStatus>
<code>CREAT</code>
<codeName>Block storage CREATED state</codeName>
</blockStorageSnapshotInstanceStatus>
<blockStorageSnapshotInstanceOperation>
<code>NULL</code>
<codeName>Block Storage NULLOP</codeName>
</blockStorageSnapshotInstanceOperation>
<blockStorageSnapshotInstanceStatusName>created</blockStorageSnapshotInstanceStatusName>
<createDate>2020-08-25T10:18:15+0900</createDate>
<isEncryptedOriginalBlockStorageVolume>false</isEncryptedOriginalBlockStorageVolume>
<blockStorageSnapshotDescription></blockStorageSnapshotDescription>
<snapshotType>
<code>FULL</code>
<codeName>Full Storage Snapshot</codeName>
</snapshotType>
<baseSnapshotInstanceNo/>
<snapshotChainDepth>0</snapshotChainDepth>
<isBootable>true</isBootable>
<hypervisorType>
<code>KVM</code>
<codeName>KVM</codeName>
</hypervisorType>
</blockStorageSnapshotInstance>
</blockStorageSnapshotInstanceList>
</getBlockStorageSnapshotInstanceListResponse>
この記事は役に立ちましたか?