getBlockStorageInstanceList
    • PDF

    getBlockStorageInstanceList

    • PDF

    記事の要約

    概要

    ブロックストレージインスタンスリスト照会

    説明

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

    リクエストパラメータ

    パラメータ名必須タイプ制約事項説明
    serverInstanceNoNoStringサーバインスタンスにattachされたブロックストレージを照会する時に使われます。
    blockStorageInstanceNoListNoListブロックストレージインスタンス番号リストに該当するブロックストレージを照会します。
    searchFilterNameNoStringブロックストレージ名(blockStorageName) | 連結情報(attachmentInformation) [大小文字区分なし]
    連結情報の場合、ブロックストレージ名[空白] 連結情報またはブロックストレージ名: 連結情報形式で入力される必要があります。
    searchFilterValueNoString検索するフィルタ値
    blockStorageTypeCodeListNoStringMin : 1, Max : 5ブロックストレージ区分コードリストに該当するブロックストレージのみ照会できます。
    基本ブロックストレージ(BASIC) | 追加ブロックストレージ(SVRBS)
    Default: 基本ブロックストレージ(BASIC), 追加ブロックストレージ(SVRBS)
    blockStorageInstanceStatusCodeNoStringMin : 1, Max : 5ブロックストレージインスタンスのステータス別に照会できます。
    入力できるステータスはブロックストレージインスタンスデータタイプ(BlockStorageInstance)のブロックストレージインスタンスステータス(blockStorageInstanceStatus) 値をご参考ください。
    diskTypeCodeNoStringディスクタイプ区分コード
    ネットワークストレージ(NET) | ローカルストレージ(LOCAL)
    diskDetailTypeCodeNoStringディスクタイプ詳細区分コード
    ハードディスク(HDD) | SSD(SSD)
    regionNoNoString入力できるステータスはgetRegionListアクションを通じて取得できます。
    zoneNoNoStringブロックストレージインスタンスリストを、ZONEを利用してフィルタリングできます。
    フィルタを設定しない場合、該当リージョンのZONEすべてが選択されます。
    pageNoNoIntegerMin : 0, Max : 2147483647件数が多い場合、ページサイズに該当するページ番号
    pageSizeNoIntegerMin : 0, Max : 2147483647一つのページで照会するページサイズ
    sortedByNoStringリスト結果に対するソートコラムを決定できます。
    ブロックストレージ名(blockStorageName) | ブロックストレージインスタンス番号(blockStorageInstanceNo) [大小文字区分なし]
    Default : ブロックストレージインスタンス番号(blockStorageInstanceNo)
    sortingOrderNoStringアセンディング、ディセンディングに対して、リスト結果にorderingを決定できます。
    アセンディング(ascending) | ディセンディング(descending) [大小文字区分なし]
    Default : アセンディング(ascending)

    レスポンスデータタイプ

    • BlockStorageInstanceListタイプ
    BlockStorageInstanceList extends CommonResponse
    private Integer totalRows;
    private List blockStorageInstanceList = new ArrayList();
    BlockStorageInstance
    private String blockStorageInstanceNo;
    private String serverInstanceNo;
    private String serverName;
    private CommonCode blockStorageType;
    private String blockStorageName;
    private Long blockStorageSize;
    private String deviceName;
    private String blockStorageProductCode;
    private CommonCode blockStorageInstanceStatus;
    private CommonCode blockStorageInstanceOperation;
    private String blockStorageInstanceStatusName;
    private Date createDate;
    private String blockStorageInstanceDescription;
    private CommonCode diskTypeCode;
    private CommonCode diskType;
    private CommonCode diskDetailType;
    private Integer maxIopsThroughput;
    private Region region;
    private Zone zone;

    例示

    呼び出し

    ncloud server getBlockStorageInstanceList --diskTypeCode NET --diskDetailTypeCode SSD --blockStorageTypeCodeList BASIC --pageSize 2 --pageNo 1
    

    レスポンス

    {
      "getBlockStorageInstanceListResponse": {
        "requestId": "28e08ca2-a988-4856-800f-daff05999ff1",
        "returnCode": "0",
        "returnMessage": "success",
        "totalRows": 56,
        "blockStorageInstanceList": [
          {
            "blockStorageInstanceNo": "324388",
            "serverInstanceNo": "324387",
            "serverName": "eco-test-2",
            "blockStorageType": {
              "code": "BASIC",
              "codeName": "Basic BS"
            },
            "blockStorageName": "eco-test-2",
            "blockStorageSize": 53687091200,
            "deviceName": "/dev/xvda",
            "blockStorageProductCode": "SPBSTBSTBS000005",
            "blockStorageInstanceStatus": {
              "code": "ATTAC",
              "codeName": "Block storage ATTACHED state"
            },
            "blockStorageInstanceOperation": {
              "code": "TERMT",
              "codeName": "Block Storage TERMINATE OP"
            },
            "blockStorageInstanceStatusName": "terminating",
            "createDate": "2017-05-19T11:04:03+0900",
            "blockStorageInstanceDescription": "compact-ssd\u0027s basic storage",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "diskDetailType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "zone": {
              "zoneNo": "2",
              "zoneName": "KR-1",
              "zoneCode": "KR-1",
              "zoneDescription": "KR-1 zone",
              "regionNo": "1"
            }
          },
          {
            "blockStorageInstanceNo": "342436",
            "serverInstanceNo": "342435",
            "serverName": "x0811",
            "blockStorageType": {
              "code": "BASIC",
              "codeName": "Basic BS"
            },
            "blockStorageName": "x0811",
            "blockStorageSize": 53687091200,
            "deviceName": "/dev/xvda",
            "blockStorageProductCode": "SPBSTBSTBS000005",
            "blockStorageInstanceStatus": {
              "code": "ATTAC",
              "codeName": "Block storage ATTACHED state"
            },
            "blockStorageInstanceOperation": {
              "code": "NULL",
              "codeName": "Block Storage NULL OP"
            },
            "blockStorageInstanceStatusName": "attached",
            "createDate": "2017-08-11T15:44:28+0900",
            "blockStorageInstanceDescription": "x0811\u0027s basic storage",
            "diskType": {
              "code": "NET",
              "codeName": "Network Storage"
            },
            "diskDetailType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "maxIopsThroughput": 4000,
            "zone": {
              "zoneNo": "2",
              "zoneName": "KR-1",
              "zoneCode": "KR-1",
              "zoneDescription": "KR-1 zone",
              "regionNo": "1"
            }
          }
        ]
      }
    }
    
    <?xml version="1.0" encoding="UTF-8" ?>
    <getBlockStorageInstanceListResponse>
      <requestId>28e08ca2-a988-4856-800f-daff05999ff1</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>56</totalRows>
      <blockStorageInstanceList>
        <blockStorageInstanceNo>324388</blockStorageInstanceNo>
        <serverInstanceNo>324387</serverInstanceNo>
        <serverName>eco-test-2</serverName>
        <blockStorageType>
          <code>BASIC</code>
          <codeName>Basic BS</codeName>
        </blockStorageType>
        <blockStorageName>eco-test-2</blockStorageName>
        <blockStorageSize>53687091200</blockStorageSize>
        <deviceName>/dev/xvda</deviceName>
        <blockStorageProductCode>SPBSTBSTBS000005</blockStorageProductCode>
        <blockStorageInstanceStatus>
          <code>ATTAC</code>
          <codeName>Block storage ATTACHED state</codeName>
        </blockStorageInstanceStatus>
        <blockStorageInstanceOperation>
          <code>TERMT</code>
          <codeName>Block Storage TERMINATE OP</codeName>
        </blockStorageInstanceOperation>
        <blockStorageInstanceStatusName>terminating</blockStorageInstanceStatusName>
        <createDate>2017-05-19T11:04:03+0900</createDate>
        <blockStorageInstanceDescription>compact-ssd&#x27;s basic storage</blockStorageInstanceDescription>
        <diskType>
          <code>NET</code>
          <codeName>Network Storage</codeName>
        </diskType>
        <diskDetailType>
          <code>SSD</code>
          <codeName>SSD</codeName>
        </diskDetailType>
        <zone>
          <zoneNo>2</zoneNo>
          <zoneName>KR-1</zoneName>
          <zoneCode>KR-1</zoneCode>
          <zoneDescription>KR-1 zone</zoneDescription>
          <regionNo>1</regionNo>
        </zone>
      </blockStorageInstanceList>
      <blockStorageInstanceList>
        <blockStorageInstanceNo>342436</blockStorageInstanceNo>
        <serverInstanceNo>342435</serverInstanceNo>
        <serverName>x0811</serverName>
        <blockStorageType>
          <code>BASIC</code>
          <codeName>Basic BS</codeName>
        </blockStorageType>
        <blockStorageName>x0811</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 NULL OP</codeName>
        </blockStorageInstanceOperation>
        <blockStorageInstanceStatusName>attached</blockStorageInstanceStatusName>
        <createDate>2017-08-11T15:44:28+0900</createDate>
        <blockStorageInstanceDescription>x0811&#x27;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>2</zoneNo>
          <zoneName>KR-1</zoneName>
          <zoneCode>KR-1</zoneCode>
          <zoneDescription>KR-1 zone</zoneDescription>
          <regionNo>1</regionNo>
        </zone>
      </blockStorageInstanceList>
    </getBlockStorageInstanceListResponse>
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.