> ## 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.

# 查询实例列表

## 请求头

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

## 查询参数

<ParamField query="pageSize" type="integer" required={true}>
  每页返回的最大条数。整数，取值 >= 0。
</ParamField>

<ParamField query="pageNum" type="integer" required={true}>
  获取第几页。整数，取值 >= 0。
</ParamField>

<ParamField query="name" type="string" required={false}>
  实例名称（支持模糊查询）。字符串，长度限制：0-255 字符。
</ParamField>

<ParamField query="productName" type="string" required={false}>
  产品名称（支持模糊查询）。字符串，长度限制：0-255 字符。
</ParamField>

<ParamField query="status" type="string" required={false}>
  实例状态。字符串，长度限制：0-63 字符。可选值：

  * `toCreate`：待创建
  * `creating`：创建中
  * `pulling`：拉取镜像中
  * `running`：运行中
  * `toStart`：待启动
  * `starting`：启动中
  * `toStop`：待停止
  * `stopping`：停止中
  * `exited`：已停止
  * `toRestart`：待重启
  * `restarting`：重启中
  * `toRemove`：待删除
  * `removing`：删除中
  * `removed`：已删除
  * `toReset`：待重置(升级)
  * `resetting`：重置中
  * `migrating`：迁移中
  * `freezing`：冻结中
</ParamField>

## 响应参数

<ResponseField name="instances" type="object[]" required={true}>
  实例信息。

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

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

    <ResponseField name="clusterId" type="string" required={true}>
      集群 ID。
    </ResponseField>

    <ResponseField name="clusterName" type="string" required={false}>
      集群名称。
    </ResponseField>

    <ResponseField name="status" type="string" required={true}>
      实例状态。
    </ResponseField>

    <ResponseField name="imageUrl" type="string" required={true}>
      容器镜像地址。
    </ResponseField>

    <ResponseField name="imageAuthId" type="string" required={false}>
      镜像仓库认证信息。
    </ResponseField>

    <ResponseField name="command" type="string" required={false}>
      容器启动命令。
    </ResponseField>

    <ResponseField name="entrypoint" type="string" required={false}>
      容器启动 entrypoint。
    </ResponseField>

    <ResponseField name="cpuNum" type="string" required={true}>
      实例的 CPU 数。单位为核。
    </ResponseField>

    <ResponseField name="memory" type="string" required={true}>
      实例的内存大小。单位为 GB。
    </ResponseField>

    <ResponseField name="gpuNum" type="string" required={true}>
      实例的 GPU 卡数。
    </ResponseField>

    <ResponseField name="portMappings" type="object[]" required={false}>
      实例端口信息。

      <Expandable title="properties" defaultOpen={false}>
        <ResponseField name="port" type="integer" required={true}>
          端口值。
        </ResponseField>

        <ResponseField name="type" type="string" required={true}>
          端口类型。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="productId" type="string" required={true}>
      用于部署实例的产品 ID。
    </ResponseField>

    <ResponseField name="productName" type="string" required={true}>
      用于部署实例的产品名称。
    </ResponseField>

    <ResponseField name="rootfsSize" type="integer" required={true}>
      系统盘大小。单位为 GB。
    </ResponseField>

    <ResponseField name="volumeMounts" type="object[]" required={false}>
      实例的存储配置。

      <Expandable title="properties" defaultOpen={false}>
        <ResponseField name="type" type="string" required={false}>
          存储类型。取值：

          * network：云存储。
          * local：本地存储。
        </ResponseField>

        <ResponseField name="size" type="string" required={false}>
          存储容量大小。
        </ResponseField>

        <ResponseField name="id" type="string" required={false}>
          云存储 ID。当 type = network 时返回。
        </ResponseField>

        <ResponseField name="mountPath" type="string" required={false}>
          存储挂载路径。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="statusError" type="object" required={false}>
      实例创建失败或实例不可用时的错误信息。

      <Expandable title="properties" defaultOpen={false}>
        <ResponseField name="state" type="string" required={false}>
          实例异常状态。
        </ResponseField>

        <ResponseField name="message" type="string" required={false}>
          错误信息。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="envs" type="object[]" required={false}>
      实例的环境变量信息。

      <Expandable title="properties" defaultOpen={false}>
        <ResponseField name="key" type="string" required={false}>
          环境变量名称。
        </ResponseField>

        <ResponseField name="value" type="string" required={false}>
          环境变量取值。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="kind" type="string" required={false}>
      实例类型。
    </ResponseField>

    <ResponseField name="billingMode" type="string" required={true}>
      实例的计费方式。取值：

      * onDemand：按量计费。

      * monthly：包年包月。

      * spot：抢占式计费。
    </ResponseField>

    <ResponseField name="endTime" type="string" required={false}>
      包年包月实例到期时间。若是按量计费实例，则返回 -1。
    </ResponseField>
  </Expandable>
</ResponseField>

<ParamField name="total" type="integer" required={false}>
  查询结果的总条数。
</ParamField>
