> ## 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="Content-Type" type="string" required={true}>
  枚举值：application/json。
</ParamField>

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

## 查询参数

<ParamField query="page" type="integer" required={false}>
  页码，默认 1。
</ParamField>

<ParamField query="pageSize" type="integer" required={false}>
  每页数量，默认 10。
</ParamField>

<ParamField query="state" type="string" required={false}>
  预热任务状态。可选值：

  * `Pending`：待处理
  * `Running`：进行中
  * `Succeeded`：成功
  * `Failed`：失败
</ParamField>

<ParamField query="clusterId" type="string" required={false}>
  集群 ID。
</ParamField>

<ParamField query="name" type="string" required={false}>
  镜像名或任务备注。
</ParamField>

## 示例

```bash theme={null}
curl --location --request GET 'https://api.ppio.com/gpu-instance/openapi/v1/image/prewarm' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{API_KEY}}'
```

## 响应参数

<ResponseField name="data" type="object[]" required={true}>
  任务列表。

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

    <ResponseField name="imageName" type="string" required={true}>
      镜像名（取最后一段，去除 tag 部分）。
    </ResponseField>

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

    <ResponseField name="repositoryAuth" type="string" required={false}>
      镜像认证 ID。
    </ResponseField>

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

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

    <ResponseField name="products" type="object[]" required={false}>
      预热的产品卡信息。

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

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

    <ResponseField name="imageSize" type="string" required={true}>
      镜像大小（字节）。
    </ResponseField>

    <ResponseField name="createTime" type="string" required={true}>
      任务创建时间（Unix 时间戳秒）。
    </ResponseField>

    <ResponseField name="state" type="string" required={true}>
      任务状态。可选值：

      * `Pending`：待处理
      * `Running`：进行中
      * `Succeeded`：成功
      * `Failed`：失败
    </ResponseField>

    <ResponseField name="completeTime" type="string" required={false}>
      任务完成时间（Unix 时间戳秒）。
    </ResponseField>

    <ResponseField name="note" type="string" required={false}>
      任务备注。
    </ResponseField>

    <ResponseField name="reason" type="[string]" required={false}>
      任务原因或说明。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="total" type="integer" required={true}>
  任务总数。
</ResponseField>

## 响应示例

```json theme={null}
{
  "data": [
    {
      "id": "nzd5nyi4keefsv2d",
      "imageName": "nginx",
      "imageUrl": "nginx",
      "clusterId": "cn-dev-1",
      "clusterName": "v2测试(cn-dev-1)",
      "products": [],
      "imageSize": "72298048",
      "createTime": "1757656178",
      "state": "Succeeded",
      "completeTime": "1757656207",
      "note": "",
      "reason": [],
      "repositoryAuth": ""
    },
    {
      "id": "fexahnwdp4l1ajva",
      "imageName": "pytorch",
      "imageUrl": "test-image.ppinfra.com/test-public/pytorch:v2",
      "clusterId": "cn-dev-1",
      "clusterName": "v2测试(cn-dev-1)",
      "products": [
        {
          "productId": "4090.18c.60g.18c60g",
          "productName": "RTX 4090 24GB 18c"
        }
      ],
      "imageSize": "6762128493",
      "createTime": "1756361365",
      "state": "Succeeded",
      "completeTime": "1756361371",
      "note": "",
      "reason": [
        "image pulled successfully"
      ],
      "repositoryAuth": ""
    }
  ],
  "total": 2
}
```