> ## 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="type" type="string" required={true}>
  镜像类型。可选值：

  * `base`：平台官方镜像
  * `private`：私有仓库镜像
</ParamField>

<ParamField query="name" type="string" required={false}>
  镜像名称（模糊匹配）。
</ParamField>

<ParamField query="pageSize" type="integer" required={true}>
  每页数量。取值范围：>= 1。
</ParamField>

<ParamField query="pageNum" type="integer" required={true}>
  页码。取值范围：>= 1。
</ParamField>

## 示例

```bash theme={null}
curl --location --request GET 'https://api.ppio.com/gpu-instance/openapi/v1/images?name=&type=private&pageSize=10&pageNum=1' \
--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="name" type="string" required={true}>
      镜像名称。
    </ResponseField>

    <ResponseField name="url" type="string" required={true}>
      首个上传的镜像带标签的完整地址。
    </ResponseField>

    <ResponseField name="tags" type="object[]" required={false}>
      镜像标签信息。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="name" type="string" required={true}>
          标签名称。
        </ResponseField>

        <ResponseField name="url" type="string" required={true}>
          该标签对应的完整镜像地址（含标签）。
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="pageSize" type="integer" required={true}>
  每页数量。
</ResponseField>

<ResponseField name="pageNum" type="integer" required={true}>
  当前页码。
</ResponseField>

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

## 响应示例

```json theme={null}
{
  "data": [
    {
      "id": "42",
      "name": "nwe",
      "url": "test-image.ppinfra.com/dev-pukcnedkqkioyhnxrawo/image_ubuntu_test_keli_1202:v1",
      "tags": [
        {
          "name": "v1",
          "url": "test-image.ppinfra.com/dev-pukcnedkqkioyhnxrawo/image_ubuntu_test_keli_1202:v1"
        },
        {
          "name": "v3",
          "url": "test-image.ppinfra.com/dev-pukcnedkqkioyhnxrawo/image_ubuntu_test_keli_1202:v3"
        }
      ],
      "metadata": [],
      "port": []
    }
  ],
  "pageSize": 10,
  "pageNum": 1,
  "total": 14
}
```