> ## Documentation Index
> Fetch the complete documentation index at: https://ppio.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取 GPU 产品列表

## 请求头

<ParamField header="Authorization" type="string" required={true}>
  Bearer 身份验证格式，例如：Bearer \{\{API 密钥}}。
</ParamField>

## 查询参数

<ParamField query="clusterId" type="string" required={false}>
  筛选指定集群ID。字符串，长度限制：0-255 字符。
</ParamField>

<ParamField query="gpuNum" type="integer" required={false}>
  筛选的显卡数量。整数，取值范围：\[0, 8]。
</ParamField>

<ParamField query="productName" type="string" required={false}>
  筛选的产品名称(模糊匹配)。字符串，长度限制：0-255 字符。
</ParamField>

<ParamField query="minCpuPerGpu" type="integer" required={false}>
  筛选规格(最小可使用cpu 核/卡)。整数，取值范围：大于等于 0。
</ParamField>

<ParamField query="minMemoryPerGpu" type="integer" required={false}>
  筛选规格(最小可使用内存 GB/卡)。整数，取值范围：大于等于 0。
</ParamField>

<ParamField query="minRootFSSize" type="integer" required={false}>
  筛选规格(最小可使用系统盘存储 GB/卡)。整数，取值范围：大于等于 0。
</ParamField>

<ParamField query="billingMethod" type="string" required={false}>
  筛选计费模式。可选值：

  * `onDemand`: 按量计费实例(默认)
  * `monthly`: 包年包月计费实例
  * `spot`: 抢占式计费
</ParamField>

## 响应参数

<ResponseField name="data" type="object[]" required={true}>
  GPU 产品信息。

  <Expandable title="properties" defaultOpen={true}>
    <ResponseField name="id" type="string" required={true}>
      产品 ID。
    </ResponseField>

    <ResponseField name="name" type="string" required={true}>
      产品名称。
    </ResponseField>

    <ResponseField name="cpuPerGpu" type="integer" required={true}>
      CPU 数。单位为核/卡。
    </ResponseField>

    <ResponseField name="memoryPerGpu" type="integer" required={true}>
      内存大小。单位为 GB/卡。
    </ResponseField>

    <ResponseField name="diskPerGpu" type="integer" required={true}>
      磁盘大小。单位为 GB/卡。
    </ResponseField>

    <ResponseField name="availableDeploy" type="boolean" required={true}>
      该产品是否可以创建实例。取值：

      * true：产品可以创建实例。
      * false:：产品资源不足，不能创建实例。
    </ResponseField>

    <ResponseField name="minRootFS" type="integer" required={true}>
      系统盘可用最小值。单位为 GB。
    </ResponseField>

    <ResponseField name="maxRootFS" type="integer" required={true}>
      系统盘可用最大值。单位为 GB。
    </ResponseField>

    <ResponseField name="minLocalStorage" type="integer" required={true}>
      本地盘可用最小值。单位为 GB。
    </ResponseField>

    <ResponseField name="maxLocalStorage" type="integer" required={true}>
      本地盘可用最大值。单位为 GB。
    </ResponseField>

    <ResponseField name="regions" type="[string]" required={true}>
      可用集群。表示该产品仅在指定集群可用，如果列表为空，则所有集群均可使用。
    </ResponseField>

    <ResponseField name="price" type="integer" required={true}>
      该产品创建按量计费实例的价格。
    </ResponseField>

    <ResponseField name="monthlyPrice" type="object[]" required={true}>
      该产品创建包年包月实例的价格。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="price" type="integer" required={true}>
          包年包月实例的单价。
        </ResponseField>

        <ResponseField name="month" type="integer" required={true}>
          包年包月实例的租用时长。单位为月。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="billingMethods" type="string[]" required={true}>
      该产品支持的计费方式。可选值：

      * `onDemand`：按量计费
      * `monthly`：包年包月计费
      * `spot`：抢占式计费
    </ResponseField>

    <ResponseField name="spotPrice" type="string" required={false}>
      抢占式计费实例价格。
    </ResponseField>

    <ResponseField name="inventoryState" type="string" required={false}>
      产品库存状态。

      * `none`：无库存
      * `low`：库存较少
      * `normal`：库存一般
      * `high`：库存充足
    </ResponseField>
  </Expandable>
</ResponseField>