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

> ## Agent Instructions
> PawSQL 是一个产品：Cloud 是公网部署形态，Engine / Optimizer / Auditor / Advisor / Patroller 是同一产品的组件与交付形态，不是彼此独立的产品。 / PawSQL is a single product: Cloud is the public deployment form, while Engine / Optimizer / Auditor / Advisor / Patroller are components and delivery forms of the same product, not separate products.
> 术语以站内术语表为准：SQL 审核对应英文 SQL Review，查询重写对应 Query Rewrite，索引推荐对应 Index Recommendation；英文内容统一用 Review，不用 Audit。 / Use the site glossary for terminology: 审核 is SQL Review, 重写 is Query Rewrite, 索引推荐 is Index Recommendation; English content uses Review, never Audit.
> 引用能力范围或版本支持时以对应页面为准；标注 unknown、或 status 非 published 的内容表示尚未经产品核实，不应作为事实引用。 / Cite capability scope and version support from the corresponding page; content marked unknown, or with a status other than published, is not yet product-verified and must not be cited as fact.

# 查询工作空间列表

> 获取当前用户的所有工作空间列表（分页）。

**注意**：匿名用户不支持查询工作空间列表。




## OpenAPI

````yaml /openapi/pawsql-optimization.yaml post /listWorkspaces
openapi: 3.0.3
info:
  title: PawSQL 优化服务
  description: |
    PawSQL SQL 优化服务对外接口。

    PawSQL 优化引擎是为开发者和 DBA 开发的查询优化引擎，集成了数据库行业的查询优化最佳实践，
    提供强大的 SQL 审核和重写优化功能，并集成 Paw Index Advisor 索引推荐引擎为慢查询提供基于成本的索引推荐。

    ## 认证方式

    大部分接口需要通过 `userKey`（激活码）进行身份认证。
    `userKey` 可通过 `/getUserKey` 接口（邮箱密码登录）获取。

    ## 接口调用流程

    1. 调用 `/getUserKey` 获取 userKey
    2. 调用 `/createWorkspace` 创建工作空间（或直接在 `/createAnalysis` 中传入 DDL）
    3. 调用 `/createAnalysis` 或 `/createAnalysisAsync` 创建优化任务
    4. 调用 `/getAnalysisSummary` 获取优化汇总
    5. 调用 `/getStatementDetails` 获取单条 SQL 优化详情
  version: 1.0.0
  contact:
    name: PawSQL Team
    url: https://pawsql.com
  license:
    name: PawSQL
    url: https://pawsql.com
servers:
  - url: /api/v1
    description: PawSQL Server
security:
  - userKey: []
tags:
  - name: 身份认证
    description: 身份认证接口
  - name: 工作空间
    description: 工作空间管理接口
  - name: SQL优化
    description: SQL 优化任务接口
paths:
  /listWorkspaces:
    post:
      tags:
        - 工作空间
      summary: 查询工作空间列表
      description: |
        获取当前用户的所有工作空间列表（分页）。

        **注意**：匿名用户不支持查询工作空间列表。
      operationId: listWorkspaces
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiUserRequestBody'
            examples:
              example:
                value:
                  userKey: CB698418-88B25371-67F15F01-XXXXXXXX
                  pageNumber: 1
                  pageSize: 10
      responses:
        '200':
          description: 工作空间列表
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResult'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/PageResponse_WorkspaceInfo'
              examples:
                success:
                  value:
                    code: 200
                    message: Success
                    data:
                      records:
                        - workspaceId: '1730411624641736706'
                          workspaceName: my-workspace
                          dbType: mysql
                          createTime: '2026-09-01 10:00:00'
                          numberOfAnalysis: 5
                          latestAnalysisTime: '2026-09-05 14:30:00'
                          status: success
                      total: 1
                      size: 10
                      current: 1
                      pages: 1
components:
  schemas:
    ApiUserRequestBody:
      type: object
      description: 用户请求（含分页参数）
      properties:
        userKey:
          type: string
          description: 激活码
          example: CB698418-88B25371-67F15F01-XXXXXXXX
        workspaceId:
          type: integer
          format: int64
          description: 工作空间 ID，不填则返回所有
        pageNumber:
          type: integer
          description: 页码，默认 1
          example: 1
          default: 1
        pageSize:
          type: integer
          description: 每页条数，默认 10
          example: 10
          default: 10
    ApiResult:
      type: object
      description: 统一响应体
      properties:
        code:
          type: integer
          description: 状态码，200 表示成功
          example: 200
        message:
          type: string
          description: 描述信息
          example: Success
        data:
          description: 响应数据
    PageResponse_WorkspaceInfo:
      type: object
      description: 工作空间分页响应
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceInfo'
        total:
          type: integer
          format: int64
          description: 总记录数
        size:
          type: integer
          format: int64
          description: 每页条数
        current:
          type: integer
          format: int64
          description: 当前页码
        pages:
          type: integer
          format: int64
          description: 总页数
    WorkspaceInfo:
      type: object
      description: 工作空间信息
      properties:
        workspaceId:
          type: string
          description: 工作空间 ID
        workspaceName:
          type: string
          description: 工作空间名称
        dbType:
          type: string
          description: 数据库类型
        createTime:
          type: string
          description: 创建时间
        numberOfAnalysis:
          type: integer
          description: 优化任务数量
        latestAnalysisTime:
          type: string
          description: 最近优化时间
        status:
          type: string
          description: 工作空间状态
  securitySchemes:
    userKey:
      type: apiKey
      in: header
      name: userKey
      description: 激活码，通过 /getUserKey 接口获取

````