getBlockStorageInstanceList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

概要

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

リクエスト

リクエストパラメータ

パラメータ名	必須	タイプ	制約事項	説明
serverInstanceNo	No	String		サーバインスタンス番号サーバインスタンスにattachされたブロックストレージを照会する時に使います。 serverInstanceNoはgetServerInstanceListアクションを通じて取得できます。
blockStorageInstanceNoList.N	No	List<String>		ブロックストレージインスタンス番号リストブロックストレージインスタンス番号リストに該当するブロックストレージを照会します。 ex) blockStorageInstanceNoList.1=1021004&blockStorageInstanceNoList.2=937508
searchFilterName	No	String		検索するフィルタ名ブロックストレージ名(blockStorageName)と連結情報(attachmentInformation)でフィルタリングして検索できます。 Options : blockStorageName \| attachmentInformation `[大小文字区分なし]` 連結情報の場合、ブロックストレージ名`[空白]`連結情報またはブロックストレージ名: 連結情報の形式で入力する必要があります。入力できるステータスはブロックストレージインスタンスデータタイプ(BlockStorageInstance)のディバイス名(deviceName)の値をご参考ください。 searchFilterNameは以下のsearchFilterValue値とmappingして使います。 ex) searchFilterName=blockStorageName&searchFilterValue=s1669aa4e78c ex) searchFilterName=attachmentInformation&searchFilterValue=s1669aa4e78c:/dev
searchFilterValue	No	String		検索するフィルタ値上記のsearchFilterName値とmappingする値を入力します。
blockStorageTypeCodeList.N	No	List<String>	Min : 1, Max : 5	ブロックストレージ区分コードリストブロックストレージ区分コードリストに該当するブロックストレージのみ照会できます。 Options : BASIC (基本ブロックストレージ) \| SVRBS (追加ブロックストレージ) Default : BASIC ex) blockStorageTypeCodeList.1=SVRBS
blockStorageInstanceStatusCode	No	String	Min : 1, Max : 5	ブロックストレージインスタンスステータスコードブロックストレージインスタンスのステータス別に照会できます。入力できるステータスはブロックストレージインスタンスデータタイプ(BlockStorageInstance)のブロックストレージインスタンスステータス(blockStorageInstanceStatus)値をご参照ください。
diskTypeCode	No	String		ディスクタイプ区分コード Options : NET (ネットワークストレージ) \| LOCAL (ローカルストレージ)
diskDetailTypeCode	No	String		ディスクタイプタイプ詳細区分コード Optinos : HDD \| SSD
regionNo	No	String		リージョン番号ブロックストレージインスタンスリストをリージョン(Region)を利用してフィルタリングできます。 regionNoはgetRegionListアクションを通じて取得できます。
zoneNo	No	String		ZONE番号ブロックストレージインスタンスリストをゾーン(zone)を利用してフィルタリングできます。フィルタを設定しない場合、該当リージョンのZONEのすべてが選択されます。
pageNo	No	Integer	Min : 0, Max : 2147483647	ページングされた結果のページ番号結果値を、pageNoを利用してページング処理することが可能です。
pageSize	No	Integer	Min : 0, Max : 2147483647	ページングする時に表示する各ページサイズ結果値を、pageNoを利用してページング処理することが可能です。
sortedBy	No	String		ソート対象ブロックストレージ名とブロックストレージインスタンス番号でソートできます。 Options : blockStorageName (ブロックストレージ名) \| blockStorageInstanceNo (ブロックストレージインスタンス番号) `[大小文字区分なし]` Default : blockStorageInstanceNo sortedByは以下のsortingOrderとmappingして使います。 ex) sortedBy=blockStorageName&sortingOrder=ascending ex) sortedBy=blockStorageInstanceNo&sortingOrder=descending
sortingOrder	No	String		ソート順番上記で設定したsortedByのアセンディング/ディセンディングソートを設定します。 ascending (アセンディング) \| descending (ディセンディング) `[大小文字区分なし]` default : ascending

レスポンス

レスポンスボディ

BlockStorageInstanceList

例示

リクエスト例示

GET {SERVER_API_URL}/getBlockStorageInstanceList
?searchFilterName=blockStorageName
&searchFilterValue=s1669aa4e78c

レスポンス例示

<getBlockStorageInstanceListResponse>
  <requestId>c8172d4a-5486-4d34-9331-dfec6a747abf</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageInstanceList>
    <blockStorageInstance>
      <blockStorageInstanceNo>1021004</blockStorageInstanceNo>
      <serverInstanceNo>1021003</serverInstanceNo>
      <serverName>s1669aa4e78c</serverName>
      <blockStorageType>
        <code>BASIC</code>
        <codeName>Basic BS</codeName>
      </blockStorageType>
      <blockStorageName>s1669aa4e78c</blockStorageName>
      <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>2018-10-22T16:19:51+0900</createDate>
      <blockStorageInstanceDescription>s1669aa4e78c&apos;s basic storage</blockStorageInstanceDescription>
      <diskType>
        <code>NET</code>
        <codeName>Network Storage</codeName>
      </diskType>
      <diskDetailType>
        <code>SSD</code>
        <codeName>SSD</codeName>
      </diskDetailType>
      <maxIopsThroughput>4000</maxIopsThroughput>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>平村zone</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
    </blockStorageInstance>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>

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

What's Next

createBlockStorageInstance

概要
リクエスト
レスポンス
例示

タグ

Server