MENU
      getBlockStorageInstanceList

        getBlockStorageInstanceList


        Article summary

        Overview

        Gets a list of Block Storage instances.

        Request

        Request parameters

        ParameterRequiredTypeLimitationsDescription
        serverInstanceNoNStringServer instance number
        It is used to get the Block Storage attached to a specific server instance.
        Get available values by using the getServerInstanceList action.
        blockStorageInstanceNoList.NNList<String>List of Block Storage instance numbers
        The action gets the Block Storage instances corresponding to the list of Block Storage instance numbers.
        Example) blockStorageInstanceNoList.1=1021004&blockStorageInstanceNoList.2=937508
        searchFilterNameNStringFilter name to search
        You can search Block Storage instances by blockStorageName or attachmentInformation.
        Options: blockStorageName | attachmentInformation [case insensitive]
        Attachment information should be specified in the form of “Block Storage name [space] attachment information” or “Block Storage name:attachment information.”
        Please refer to the device name (deviceName) of the Block Storage instance data type (BlockStorageInstance) for available status values.
        Map searchFilterName and searchFilterValue as follows.
        Example) searchFilterName=blockStorageName&searchFilterValue=s1669aa4e78c
        Example) searchFilterName=attachmentInformation&searchFilterValue=s1669aa4e78c:/dev
        searchFilterValueNStringFileter value
        This value is mapped with searchFilterName.
        blockStorageTypeCodeList.NNList<String>Min: 1,
        Max: 5
        List of Block Storage type codes
        You can get only the Block Storage instances corresponding to the list of Block Storage type codes.
        Options: BASIC (Basic Block Storage) | SVRBS (Additional Block Storage)
        Default: BASIC
        ex) blockStorageTypeCodeList.1=SVRBS
        blockStorageInstanceStatusCodeNStringMin: 1,
        Max: 5
        Block Storage instance status code
        You can get results by Block Storage instance status.
        Please refer to the Block Storage instance status (blockStorageInstanceStatus) value of the Block Storage instance data type (BlockStorageInstance) for available status values.
        diskTypeCodeNStringDisk type code
        Options: NET (Network storage) | LOCAL (Local storage)
        diskDetailTypeCodeNStringDetailed disk type code
        Options: HDD | SSD
        regionNoNStringRegion number
        You can filter Block Storage instances by region.
        Get available values by using the getRegionList action.
        zoneNoNStringZone number
        You can filter Block Storage instances by zone.
        All zones in the region will be selected if this parameter is not specified.
        pageNoNIntegerMin: 0,
        Max: 2147483647
        Page number of paginated results
        You can paginate results with pageNo.
        pageSizeNIntegerMin: 0,
        Max: 2147483647
        Page size to show when paginating results.
        You can paginate results with pageSize.
        sortedByNStringSort by
        You can sort Block Storage instances by Block Storage instance name or Block Storage instance number.
        Options: blockStorageName (Block Storage name) | blockStorageInstanceNo (Block Storage instance number) [case insensitive]
        Default: blockStorageInstanceNo
        Map sortedBy and sortingOrder as follows.
        Example) sortedBy=blockStorageName&sortingOrder=ascending
        Example) sortedBy=blockStorageInstanceNo&sortingOrder=descending
        sortingOrderNStringSorting order
        It shows results sorted by the specified sortedBy value in ascending or descending order.
        ascending | descending [case insensitive]
        Default: ascending

        Response

        Response body

        Examples

        Request example

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

        Response example

        <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>Pyeongchon zone</zoneDescription>
                <regionNo>1</regionNo>
              </zone>
            </blockStorageInstance>
          </blockStorageInstanceList>
        </getBlockStorageInstanceListResponse>
        XML

        Was this article helpful?

        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.