概要

ブロックストレージインスタンスリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名	要否	タイプ	説明
regionCode	No	String	- リージョンコードブロックストレージインスタンスが作成されるリージョン(Region)を決定できる regionCodeは、getRegionListアクションを通じて取得可能 Default: getRegionList照会結果の最初のリージョンを選択
zoneCode	No	String	- ZONEコードブロックストレージインスタンスのリストが照会されるゾーン(zone)を決定できる zoneCodeは、getZoneListアクションを通じて取得可能
blockStorageInstanceNoList.N	No	List<String>	- ブロックストレージインスタンス番号リストブロックストレージインスタンス番号でフィルタリングして検索できる blockStorageInstanceNoは、getBlockStorageInstanceListアクションを通じて取得可能 ex) blockStorageInstanceNoList.1=1234&blockStorageInstanceNoList.2=2345
blockStorageInstanceStatusCode	No	String	- ブロックストレージインスタンスのステータスコードブロックストレージインスタンスのステータスコードでフィルタリングして検索できる Options : INIT \| CREAT \| ATTAC
blockStorageDiskTypeCode	No	String	- ブロックストレージディスクのタイプコードブロックストレージディスクタイプでフィルタリングして検索できる Options : NET
blockStorageDiskDetailTypeCode	No	String	- ブロックストレージディスクの詳細タイプコードブロックストレージディスクの詳細タイプでフィルタリングして検索できる Options : HDD \| SSD
blockStorageSize	No	Integer	- ブロックストレージサイズ入力した GB単位サイズ以下のブロックストレージをフィルタリングして検索できる
blockStorageTypeCodeList.N	No	List<String>	- ブロックストレージのタイプコードリストブロックストレージタイプでフィルタリングして検索できる Options: BASIC(サーバインスタンスの基本ブロックストレージ) \| SVRBS(サーバインスタンスの追加ブロックストレージ) ex) blockStorageTypeCodeList.1=BASIC&blockStorageTypeCodeList.2=SVRBS
serverInstanceNo	No	String	- サーバインスタンス番号ブロックストレージが割り当てられたサーバインスタンス番号でフィルタリングして検索できる serverInstanceNoは、getServerInstanceListアクションを通じて取得可能
blockStorageName	No	String	- ブロックストレージ名ストレージ名でフィルタリングして検索できる blockStorageName、serverName、connectionInfo中の一つの検索条件のみ使用できる
serverName	No	String	- サーバ名ブロックストレージが割り当てられたサーバの名前でフィルタリングして検索できる blockStorageName、serverName、connectionInfo中の一つの検索条件のみ使用できる
connectionInfo	No	String	- 接続情報ブロックストレージが割り当てられたサーバとデバイス接続情報でフィルタリングして検索できる以下のふたつの形態で使用可能 Options: 「サーバ名[空白]デバイス名」(s173dc67dc2e /dev/xvda) \| 「サーバ名: デバイス名」(s173dc67dc2e:/dev/xvda) blockStorageName、serverName、connectionInfo中の一つの検索条件のみ使用できる
blockStorageVolumeTypeCodeList.N	No	List<String>	- ブロックストレージボリュームタイプコードリストブロックストレージボリュームタイプコードでフィルタリングして検索できる Options : HDD \| SSD \| FB1 \| CB1 ex) blockStorageVolumeTypeCodeList.1=SSD&blockStorageVolumeTypeCode.2=CB1
hypervisorTypeCodeList.N	No	List<String>	- ハイパーバイザータイプコードリストハイパーバイザータイプコードでフィルタリングして検索できる Options : XEN \| KVM ex) hypervisorTypeCodeList.1=XEN
pageNo	No	Integer	- ページングされた結果のページ番号結果値を pageNo、pageSizeを利用してページング処理できる
pageSize	Conditional	Integer	- ページングの際に表示する各ページのサイズ結果値を pageNo、pageSizeを利用してページング処理できる pageNoを入力する際に必ず入力する
responseFormatType	No	String	- レスポンス結果のフォーマットタイプ Options : xml \| json Default : xml

レスポンス

レスポンスボディ

BlockStorageInstanceList

例

リクエスト例

GET {API_URL}/getBlockStorageInstanceList
?regionCode=KR
&zoneCode=KR-1
&blockStorageInstanceNoList.1=***7746
&blockStorageInstanceStatusCode=ATTAC
&blockStorageDiskTypeCode=NET
&blockStorageDiskDetailTypeCode=SSD
&blockStorageSize=50
&blockStorageTypeCodeList.1=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>SSD</code>
        <codeName>SSD</codeName>
      </blockStorageVolumeType>
      <hypervisorType>
        <code>XEN</code>
        <codeName>XEN</codeName>
      </hypervisorType>
    </blockStorageInstance>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>

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

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

タグ