调用API

参数

描述

格式

支持百炼大模型平台、OpenAPI规范2种格式下载文件。

operationID

接口操作ID，用于接口操作的唯一标识。仅支持输入英文、下划线（_），不超过200个字符。

summary

接口描述。支持输入不超过200个字符。

代码预览

设置完成后，即可实时预览代码（JSON格式）。代码中各参数释义请参见OpenAPI 规范。

openapi: 3.0.1
info:
  title: sq_test_mysql
  description: ""
  version: V1.4
servers:
- url: http://528fdcdcc62d4f4eb8f10ad99cdda9f3-cn-shanghai.alicloudapi.com
paths:
  /list/10172:
    post:
      summary: ""
      operationId: ""
      parameters:
      - name: appKey
        in: query
        description: 访问API所绑定的应用Key
        required: true
        schema:
          type: string
          example: "2000001"
      - name: env
        in: query
        description: API所在的环境
        required: true
        schema:
          type: string
          example: "prod:生产环境, pre:预发环境"
      requestBody:
        content:
          application/json:
            schema:
              required:
              - returnFields
              type: object
              properties:
                useModelCache:
                  type: boolean
                  description: "是否开启SQL翻译缓存, 有利于查询性能提升"
                  default: false
                pageStart:
                  type: integer
                  description: 分页查询的第几条开始
                  format: int32
                pageSize:
                  type: integer
                  description: 分页查询返回条数
                  format: int32
                returnFields:
                  type: array
                  items:
                    type: string
                    example: "[id, name, sexo]"
                conditions:
                  required:
                  - sex
                  type: object
                  properties:
                    namee:
                      type: string
                      example: null
                    sex:
                      type: string
                      example: null
                    idd:
                      type: string
                      example: null
                  description: 入参条件
                useResultCache:
                  type: boolean
                  description: "是否开启API查询结果的缓存, 有利于查询性能提升"
                  default: false
                orderBys:
                  type: array
                  description: 排序字段
                  items:
                    type: object
                    properties:
                      field:
                        type: string
                        description: 排序类型，枚举值(注意大写)，只有ASC或者DESC
                      order:
                        type: string
                        description: 排序类型，枚举值(注意大写)，只有ASC或者DESC
                        example: ASC或者DESC
        required: true