getBlockStorageInstanceList

印刷する
共有
PDF

記事の要約

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

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

概要

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

リクエスト

リクエストパラメータ

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

レスポンス

レスポンスボディ

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>坪村ゾーン</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
    </blockStorageInstance>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>

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

What's Next

createBlockStorageInstance

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

タグ

Server