OwlProxy OpenAPI 3.1 规范

本文档提供 OwlProxy OpenAPI 3.1 规范文件的获取方式，供 AI 助手、大模型、代码生成工具及自动化脚本消费。规范内容与本站《接口文档》OpenAPI.md 完全一致，仅格式为机器可读的 OpenAPI 描述。

📥 下载 OpenAPI 规范文件 — 适合 Postman、Swagger Editor、AI 工具等直接导入

获取方式：

  • 浏览器下载：点击此处下载 openapi.yaml，或访问：https://api.owlproxy.com/owlproxy/doc/zh/server/openapi.yaml 若浏览器直接打开而非下载，可右键链接选择「另存为」。
  • 命令行获取：curl https://api.owlproxy.com/owlproxy/doc/zh/server/openapi.yaml -o owlproxy-openapi.yaml
  • 直接引用：在 Postman、Swagger Editor、AI 等工具中使用上述 URL 直接导入

规范全文

以下为 OpenAPI 3.1 规范全文，可直接在本页复制使用，或通过上方链接下载文件。

openapi: 3.1.0
info:
  title: OwlProxy OpenAPI
  description: |
    OwlProxy 代理服务 OpenAPI 规范，供 AI/大模型/代码助手及自动化工具消费。
    接口描述、请求/响应参数与业务语义以本站《接口文档》OpenAPI.md 为准；
    认证与签名详见 OpenAPI.md。
  version: "1.0.0"

servers:
  - url: https://api.owlproxy.com
    description: OwlProxy API 服务器

security:
  - OwlProxyHMAC: []

tags:
  - name: 静态IP服务
  - name: 动态代理服务
  - name: 回调管理

paths:
  /owlproxy/proxy/type:
    get:
      tags:
        - 静态IP服务
      summary: 获取代理类型
      operationId: owlproxy_proxy_type_get
      description: |
        获取支持的代理类型列表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/region:
    get:
      tags:
        - 静态IP服务
      summary: 获取静态IP地区
      operationId: owlproxy_static_region_get
      description: |
        获取静态IP支持的地区列表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/quality:
    get:
      tags:
        - 静态IP服务
      summary: 获取静态IP质量选项
      operationId: owlproxy_static_quality_get
      description: |
        获取静态IP质量选项
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/provider:
    get:
      tags:
        - 静态IP服务
      summary: 获取静态IP服务商
      operationId: owlproxy_static_provider_get
      description: |
        获取静态IP服务商列表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/package:
    get:
      tags:
        - 静态IP服务
      summary: 获取静态IP套餐
      operationId: owlproxy_static_package_get
      description: |
        获取静态IP套餐列表
      parameters:
        - name: region
          in: query
          description: 地区编码
          schema:
            type: string
        - name: provider
          in: query
          description: 服务商编码
          schema:
            type: string
        - name: quality
          in: query
          description: 质量等级
          schema:
            type: string
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/order:
    post:
      tags:
        - 静态IP服务
      summary: 购买静态IP套餐
      operationId: owlproxy_static_order_post
      description: |
        购买静态IP套餐
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/ipinfo:
    post:
      tags:
        - 静态IP服务
      summary: 根据订单号获取IP信息
      operationId: owlproxy_static_ipinfo_post
      description: |
        根据订单号获取IP信息
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/list:
    post:
      tags:
        - 静态IP服务
      summary: 获取静态IP列表
      operationId: owlproxy_static_list_post
      description: |
        获取用户静态IP列表
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/remark:
    post:
      tags:
        - 静态IP服务
      summary: 修改静态IP备注
      operationId: owlproxy_static_remark_post
      description: |
        修改静态IP备注
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/renew:
    post:
      tags:
        - 静态IP服务
      summary: 静态IP续费
      operationId: owlproxy_static_renew_post
      description: |
        静态IP续费
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/autoRenew:
    post:
      tags:
        - 静态IP服务
      summary: 设置静态IP自动续费
      operationId: owlproxy_static_autoRenew_post
      description: |
        设置静态IP自动续费
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/static/orderList:
    post:
      tags:
        - 静态IP服务
      summary: 静态IP订单列表
      operationId: owlproxy_static_orderList_post
      description: |
        获取静态IP订单列表
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/balance:
    get:
      tags:
        - 动态代理服务
      summary: 查询动态流量余额
      operationId: owlproxy_dynamic_balance_get
      description: |
        查询动态代理当前流量余额
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/package:
    get:
      tags:
        - 动态代理服务
      summary: 获取动态IP套餐
      operationId: owlproxy_dynamic_package_get
      description: |
        获取动态IP套餐列表
      parameters:
        - name: region
          in: query
          description: 地区编码
          schema:
            type: string
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/order:
    post:
      tags:
        - 动态代理服务
      summary: 购买动态IP套餐
      operationId: owlproxy_dynamic_order_post
      description: |
        购买动态IP套餐
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/region:
    get:
      tags:
        - 动态代理服务
      summary: 获取动态IP提取地区
      operationId: owlproxy_dynamic_region_get
      description: |
        获取动态IP提取地区列表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/line:
    get:
      tags:
        - 动态代理服务
      summary: 获取动态IP提取线路
      operationId: owlproxy_dynamic_line_get
      description: |
        获取动态IP提取线路
      parameters:
        - name: region
          in: query
          description: 地区编码
          schema:
            type: string
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/extract:
    post:
      tags:
        - 动态代理服务
      summary: 动态IP提取
      operationId: owlproxy_dynamic_extract_post
      description: |
        提取动态IP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/autoRenewOrder:
    post:
      tags:
        - 动态代理服务
      summary: 动态IP自动续费订单
      operationId: owlproxy_dynamic_autoRenewOrder_post
      description: |
        获取动态IP自动续费订单
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/setAutoRenew:
    post:
      tags:
        - 动态代理服务
      summary: 动态IP设置自动续费
      operationId: owlproxy_dynamic_setAutoRenew_post
      description: |
        设置动态IP自动续费
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"
  /owlproxy/dynamic/orderList:
    post:
      tags:
        - 动态代理服务
      summary: 动态IP订单列表
      operationId: owlproxy_dynamic_orderList_post
      description: |
        获取动态IP订单列表
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: 见 OpenAPI.md 该接口请求Body/参数表
      responses:
        "200":
          description: 成功时返回 JSON，结构为 { code, msg, ts, data }，code=200 表示成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApiResponse"

components:
  securitySchemes:
    OwlProxyHMAC:
      type: http
      scheme: custom
      description: |
        HMAC-SHA256 签名验证。请求头必须包含：
        x-date（UTC 时间 ISO 8601）、x-host（api.owlproxy.com）、
        Content-Type（application/json）、authorization（HMAC-SHA256 签名）。
        签名格式：HMAC-SHA256 Credential={AccessKey}, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature={Signature}
        计算步骤见 OpenAPI.md。
  schemas:
    ApiResponse:
      type: object
      properties:
        code:
          type: integer
          description: 业务码，200 表示成功
        msg:
          type: string
          description: 提示信息
        ts:
          type: integer
          description: 时间戳
        data:
          description: 业务数据，结构见 OpenAPI.md 各接口响应参数

规范内容说明

  • 接口范围：与 OpenAPI.md 中接口概览一致，包含静态IP服务、动态代理服务、回调管理等全部接口。
  • 请求/响应语义：路径、方法、摘要及参数名称与 OpenAPI.md 对应接口一致；详细参数类型、是否必填、示例等以 OpenAPI.md 为准。
  • 认证方式：全局使用 HMAC-SHA256 签名（请求头 x-date、x-host、Content-Type、authorization），计算方式见本站 OpenAPI.md。

使用建议

  1. AI / 大模型：将上述 openapi.yaml 的 URL 或内容提供给 AI，便于生成调用示例、参数说明或 SDK 代码。
  2. 代码生成：使用 OpenAPI 代码生成器（如 OpenAPI Generator）时，以该 YAML 为输入，并配合本站文档理解业务语义与错误码。
  3. 调试与测试：可导入 Postman、Insomnia 等工具；认证需自行实现 HMAC-SHA256，参考 OpenAPI.md。

相关文档

Prev LLMs.txt（AI快速参考）  |  Next 错误码