getProductList

Prev Next

Available in Classic and VPC

View the list of products.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /product/getProductList

Request headers

For headers common to all List price APIs, see List price common headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
pageNo Integer Optional Page number
pageSize Integer Optional Page size
  • 1000 or less (default: 1000)
regionCode String Required Region code
productItemKindCode String Optional Product item type code
productCategoryCode String Optional Product category code
productCode String Optional Product code
productName String Optional Product name
responseFormatType String Optional Response result format
  • xml (default) | json

Request example

The following is a sample request.

curl --location 'https://billingapi.apigw.ntruss.com/billing/v1/product/getProductList?regionCode=KR&productItemKindCode=VSVR&productName=6248R'
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response body

See ProductList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

<?xml version="1.0" encoding="UTF-8"?>
<getProductListResponse>
<requestId>e837d207-bd44-4041-9120-338b578cacd9</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>2</totalRows>
<productList>
<product>
<productItemKind>
<code>VSVR</code>
<codeName>Server (VPC)</codeName>
</productItemKind>
<productItemKindDetail>
<code>BM</code>
<codeName>BareMetal</codeName>
</productItemKindDetail>
<productCode>SVR.VSVR.BM.C024.M128.LOCAL.SSD.B3840.G001</productCode>
<productName>Single Intel Xeon Gold 6248R (3.0GHz) 24 Cores 128GB RAM, 8 x 480GB SSD</productName>
<productDescription>Single Intel Xeon Gold 6248R (3.0GHz) 24 Cores 128GB RAM, 8 x 480GB SSD</productDescription>
<softwareType/>
  <productCategory>
         <code>COMPUTE</code>
         <codeName>Compute</codeName>
      </productCategory>
    </product>
<product>
<productItemKind>
<code>VSVR</code>
<codeName>Server (VPC)</codeName>
</productItemKind>
<productItemKindDetail>
<code>BM</code>
<codeName>BareMetal</codeName>
</productItemKindDetail>
<productCode>SVR.VSVR.BM.C048.M384.LOCAL.SSD.B3840.G001</productCode>
<productName>Dual Intel Xeon Gold 6248R(3.0GHz), 48 cores, 384GB RAM, 8 x 480GB SSD</productName>
<productDescription>Dual Intel Xeon Gold 6248R(3.0GHz), 48 cores, 384GB RAM, 8 x 480GB SSD</productDescription>
<softwareType/>
      <productCategory>
        <code>COMPUTE</code>
        <codeName>Compute</codeName>
      </productCategory>
</product>
</productList>
</getProductListResponse>