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

# 查询镜像列表



## OpenAPI

````yaml gpus/v2-spec/list-image.json GET /gpus/v2/images
openapi: 3.0.0
info:
  title: PPIO GPU API v2
  version: 2.0.0
servers:
  - url: https://api.ppio.com
security: []
paths:
  /gpus/v2/images:
    get:
      summary: 查询镜像列表
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
          description: Bearer 身份验证格式,例如:Bearer `{{API 密钥}}`。
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - base
              - community
              - private
          description: 镜像类型过滤。可选值:`base`、`community`、`private`。留空字符串时不过滤。
          example: private
        - name: name
          in: query
          required: false
          schema:
            type: string
          description: 镜像名称过滤。字符串,长度限制:0-255 字符。
          example: pytorch
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: 本次返回数量上限。整数,取值 >= 0。
          example: 10
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: 上一页响应返回的游标,首次请求留空。字符串,长度限制:0-1024 字符。
          example: eyJpZCI6ImltYWdlLWlkIn0=
      responses:
        '200':
          description: 查询成功
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: 镜像列表
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: 镜像 ID
                          example: image-id
                        name:
                          type: string
                          description: 镜像名称
                          example: pytorch
                        image:
                          type: string
                          description: 镜像标识
                          example: registry.example.com/base/pytorch
                        type:
                          type: string
                          description: 镜像类型。可选值:`base`、`community`、`private`
                          example: private
                        status:
                          type: object
                          description: 镜像状态
                          properties:
                            status:
                              type: string
                              description: >-
                                状态值。可选值:`unknown`(未知状态)、`normal`(正常可用)、`hide`(隐藏)、`disable`(禁用)、`creating`(创建中)、`deleting`(删除中)
                              example: normal
                            error:
                              type: string
                              description: 错误码或错误类型
                              example: ''
                            message:
                              type: string
                              description: 状态说明或错误信息
                              example: ''
                        created_at:
                          type: integer
                          description: 创建时间。Unix 时间戳
                          example: 1714982400
                        tags:
                          type: array
                          description: 镜像标签列表
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: 标签 ID
                                example: tag-id
                              tag:
                                type: string
                                description: 镜像标签
                                example: 2.3.0-cuda12.1
                              owner_id:
                                type: string
                                description: 所属用户 ID
                                example: 550e8400-e29b-41d4-a716-446655440000
                              full_image_name:
                                type: string
                                description: 标签对应的完整镜像名称
                                example: >-
                                  registry.example.com/base/pytorch:2.3.0-cuda12.1
                  next_cursor:
                    type: string
                    description: 下一页游标。为空字符串表示无后续数据
                    example: eyJpZCI6Im5leHQtcGFnZSJ9
                  has_more:
                    type: boolean
                    description: 是否还有后续数据
                    example: true

````