{
  "name": "lowcode",
  "display_name": "云开发低码",
  "description": "云开发低码平台云api",
  "domain": "other",
  "api_version": "2021-01-08",
  "endpoint": "lowcode.tencentcloudapi.com",
  "actions": [
    {
      "name": "CheckDeployApp",
      "description": "检查应用发布状态",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-5gzbnlvd93"
        },
        {
          "name": "Id",
          "type": "string",
          "required": true,
          "description": "应用id",
          "example": "app-k82WCPM8"
        },
        {
          "name": "BuildId",
          "type": "string",
          "required": true,
          "description": "构建 Id",
          "example": "4f12-b62b-c1c6f403d6e1"
        }
      ],
      "required": [
        "EnvId",
        "Id",
        "BuildId"
      ]
    },
    {
      "name": "CreateKnowledgeSet",
      "description": "创建知识库",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-sdf"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "知识库标识",
          "example": "the_name"
        },
        {
          "name": "Title",
          "type": "string",
          "required": true,
          "description": "知识库名称",
          "example": "the_title"
        },
        {
          "name": "Desc",
          "type": "string",
          "required": false,
          "description": "描述",
          "example": "the_desc"
        },
        {
          "name": "Meta",
          "type": "string",
          "required": false,
          "description": "知识库的meta信息",
          "example": "meta"
        }
      ],
      "required": [
        "EnvId",
        "Name",
        "Title"
      ]
    },
    {
      "name": "DeleteAppBindWxApp",
      "description": "删除应用绑定小程序",
      "status": "online",
      "parameters": [
        {
          "name": "WeappId",
          "type": "string",
          "required": true,
          "description": "应用id",
          "example": "app-dfa"
        }
      ],
      "required": [
        "WeappId"
      ]
    },
    {
      "name": "DeleteKnowledgeDocumentSet",
      "description": "删除知识库下文档",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-sdf"
        },
        {
          "name": "CollectionView",
          "type": "string",
          "required": true,
          "description": "知识库标识",
          "example": "qinmyku873d0a9"
        },
        {
          "name": "Query",
          "type": "object",
          "required": false,
          "description": "删除时制定的条件",
          "example": "无",
          "children": [
            {
              "name": "DocumentSetId",
              "type": "array",
              "required": false,
              "description": "文件ids",
              "example": "docId",
              "item_type": "string"
            },
            {
              "name": "DocumentSetName",
              "type": "array",
              "required": false,
              "description": "文件名集合",
              "example": "docName",
              "item_type": "string"
            },
            {
              "name": "Filter",
              "type": "string",
              "required": false,
              "description": "使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式",
              "example": "filter"
            }
          ]
        }
      ],
      "required": [
        "EnvId",
        "CollectionView"
      ]
    },
    {
      "name": "DeleteKnowledgeSet",
      "description": "删除知识库",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-sdf"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "知识库标识",
          "example": "name"
        }
      ],
      "required": [
        "EnvId",
        "Name"
      ]
    },
    {
      "name": "DeployApp",
      "description": "发布应用",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-5gzbnlvd93"
        },
        {
          "name": "Id",
          "type": "string",
          "required": true,
          "description": "应用id",
          "example": "app-k82WCPM8"
        },
        {
          "name": "Mode",
          "type": "string",
          "required": false,
          "description": "发布体验preview/正式upload",
          "example": "upload"
        },
        {
          "name": "BuildType",
          "type": "string",
          "required": false,
          "description": "构建类型：mp、pc、web、adminPortal",
          "example": "web"
        },
        {
          "name": "SubAppIds",
          "type": "array",
          "required": false,
          "description": "子包数组",
          "example": "[\"sub-7x28cST\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "EnvId",
        "Id"
      ]
    },
    {
      "name": "DescribeApps",
      "description": "分页获取当前用户的应用列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页每页个数",
          "example": "1"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "分页Offset",
          "example": "1"
        },
        {
          "name": "EnvId",
          "type": "string",
          "required": false,
          "description": "环境id",
          "example": "lowcode-sss"
        },
        {
          "name": "Keyword",
          "type": "string",
          "required": false,
          "description": "搜索关键词",
          "example": "name"
        },
        {
          "name": "AppIds",
          "type": "array",
          "required": false,
          "description": "应用id",
          "example": "[\"app-1\",\"app-2\"]",
          "item_type": "string"
        },
        {
          "name": "Channel",
          "type": "string",
          "required": false,
          "description": "来源类型",
          "example": "SITEBUILD"
        },
        {
          "name": "Type",
          "type": "integer",
          "required": false,
          "description": "1-自定义应用；2-模型应用",
          "example": "0"
        },
        {
          "name": "Favorite",
          "type": "boolean",
          "required": false,
          "description": "应用是否收藏",
          "example": "true"
        }
      ],
      "required": [
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "DescribeDataSourceList",
      "description": "获取数据源详情列表",
      "status": "online",
      "parameters": [
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "每页条数",
          "example": "10"
        },
        {
          "name": "PageIndex",
          "type": "integer",
          "required": true,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境 id",
          "example": "lowcode -wa123454"
        },
        {
          "name": "Appids",
          "type": "array",
          "required": false,
          "description": "应用id数组",
          "example": "[\"app-wasds\",\"app-wsdfasd\"]",
          "item_type": "string"
        },
        {
          "name": "DataSourceIds",
          "type": "array",
          "required": false,
          "description": "数据源id数组",
          "example": "[\"data-zylntekm\",\"data-zylntekn\"]",
          "item_type": "string"
        },
        {
          "name": "DataSourceNames",
          "type": "array",
          "required": false,
          "description": "数据源名称数组",
          "example": "[\"name1\",\"name2\"]",
          "item_type": "string"
        },
        {
          "name": "DataSourceType",
          "type": "string",
          "required": false,
          "description": "数据源类型 database-自建数据源；cloud-integration-自定义数据源",
          "example": "database"
        },
        {
          "name": "QueryOption",
          "type": "object",
          "required": false,
          "description": "数据源模糊查询参数",
          "example": "{\"LikeName\":\"\tdata-3w6wEhrF\",\"LikeTitle\":\"\t时间轴区块数据\"}",
          "children": [
            {
              "name": "LikeName",
              "type": "string",
              "required": false,
              "description": "数据源标识模糊匹配",
              "example": "data-3w6wEhrF"
            },
            {
              "name": "LikeTitle",
              "type": "string",
              "required": false,
              "description": "数据源名称模糊匹配",
              "example": "时间轴区块数据"
            }
          ]
        },
        {
          "name": "ViewIds",
          "type": "array",
          "required": false,
          "description": "数据源视图Id数组",
          "example": "234233",
          "item_type": "string"
        },
        {
          "name": "AppLinkStatus",
          "type": "integer",
          "required": false,
          "description": "查询未关联应用的数据源，0:未关联，该参数配合 AppIds 参数一块使用",
          "example": "1"
        },
        {
          "name": "QueryBindToApp",
          "type": "integer",
          "required": false,
          "description": "查询应用绑定数据源: 0: 否,1: 是",
          "example": "0"
        },
        {
          "name": "QueryConnector",
          "type": "integer",
          "required": false,
          "description": "查询连接器 0 数据模型 1 连接器 2 自定义连接器",
          "example": "0"
        },
        {
          "name": "NotQuerySubTypeList",
          "type": "array",
          "required": false,
          "description": "废弃中",
          "example": "lowcode -wa123454",
          "item_type": "string"
        },
        {
          "name": "ChannelList",
          "type": "array",
          "required": false,
          "description": "查询channelList",
          "example": "channelList",
          "item_type": "string"
        },
        {
          "name": "QueryDataSourceRelationList",
          "type": "boolean",
          "required": false,
          "description": "是否查询数据源关联关系",
          "example": "true"
        },
        {
          "name": "DbInstanceType",
          "type": "string",
          "required": false,
          "description": "db实例类型",
          "example": "MYSQL"
        },
        {
          "name": "DatabaseTableNames",
          "type": "array",
          "required": false,
          "description": "数据库表名列表",
          "example": "database",
          "item_type": "string"
        },
        {
          "name": "QuerySystemModel",
          "type": "boolean",
          "required": false,
          "description": "是否查询系统模型，默认为true，需要显示设置为False才能过滤系统模型",
          "example": "true"
        }
      ],
      "required": [
        "PageSize",
        "PageIndex",
        "EnvId"
      ]
    },
    {
      "name": "DescribeKnowledgeDocumentSetDetail",
      "description": "获取知识库下文档详情",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-sdf"
        },
        {
          "name": "CollectionView",
          "type": "string",
          "required": true,
          "description": "知识库标识",
          "example": "qinmyku873d0a9"
        },
        {
          "name": "DocumentSetName",
          "type": "string",
          "required": false,
          "description": "文件名",
          "example": " my-test.md"
        },
        {
          "name": "DocumentSetId",
          "type": "string",
          "required": false,
          "description": "文件id",
          "example": "1232343434511"
        }
      ],
      "required": [
        "EnvId",
        "CollectionView"
      ]
    },
    {
      "name": "DescribeKnowledgeDocumentSetList",
      "description": "查询知识库下文件集合",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-sdf"
        },
        {
          "name": "CollectionView",
          "type": "string",
          "required": true,
          "description": "知识库标识",
          "example": "qinmyku873d0a9"
        },
        {
          "name": "Query",
          "type": "object",
          "required": false,
          "description": "查询条件",
          "example": "无",
          "children": [
            {
              "name": "DocumentSetId",
              "type": "array",
              "required": false,
              "description": "文件id数组，表示要查询的文件的所有 ID，支持批量查询，数组元素范围[1,20]。",
              "example": "docId",
              "item_type": "string"
            },
            {
              "name": "DocumentSetName",
              "type": "array",
              "required": false,
              "description": "表示要查询的文档名称，支持批量查询，数组元素范围[1,20]。",
              "example": "docName",
              "item_type": "string"
            },
            {
              "name": "Limit",
              "type": "integer",
              "required": false,
              "description": "取值范围：[1,16384]",
              "example": "10"
            },
            {
              "name": "Offset",
              "type": "integer",
              "required": false,
              "description": "设置分页偏移量，用于控制分页查询返回结果的起始位置，方便用户对数据进行分页展示和浏览。 取值：为 limit 整数倍。 计算公式：offset=limit*(page-1)。 例如：当 limit = 10，page = 2 时，分页偏移量 offset = 10 * (2 - 1) = 10，表示从查询结果的第 11 条记录开始返回数据。",
              "example": "0"
            },
            {
              "name": "OutputFields",
              "type": "array",
              "required": false,
              "description": "设置后，其他字段为空值",
              "example": "file",
              "item_type": "string"
            },
            {
              "name": "Filter",
              "type": "string",
              "required": false,
              "description": "使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式。",
              "example": "filter"
            }
          ]
        }
      ],
      "required": [
        "EnvId",
        "CollectionView"
      ]
    },
    {
      "name": "DescribeKnowledgeSetList",
      "description": "查询知识库",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-sdf"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "知识库标识，精准查询",
          "example": "name"
        },
        {
          "name": "Title",
          "type": "string",
          "required": false,
          "description": "知识库名称，精准查询",
          "example": "title"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页起始位",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "查询条数",
          "example": "10"
        },
        {
          "name": "QueryMode",
          "type": "string",
          "required": false,
          "description": "NoPage标识不分页",
          "example": "NoPage"
        }
      ],
      "required": [
        "EnvId"
      ]
    },
    {
      "name": "DescribeRelatedUsers",
      "description": "获取角色关联的用户列表",
      "status": "online",
      "parameters": [
        {
          "name": "RoleId",
          "type": "integer",
          "required": true,
          "description": "角色id",
          "example": "113123"
        },
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境id",
          "example": "\"lowcode-sdfs\""
        },
        {
          "name": "PageNo",
          "type": "integer",
          "required": true,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "页面含量",
          "example": "10"
        },
        {
          "name": "EnvType",
          "type": "string",
          "required": false,
          "description": "环境类型",
          "example": "\"prod\""
        },
        {
          "name": "RoleStringId",
          "type": "string",
          "required": false,
          "description": "新角色id",
          "example": "\"weqr\""
        }
      ],
      "required": [
        "RoleId",
        "EnvId",
        "PageNo",
        "PageSize"
      ]
    },
    {
      "name": "DescribeResourceRoleList",
      "description": "查询资源关联的角色列表",
      "status": "online",
      "parameters": [
        {
          "name": "ResourceId",
          "type": "string",
          "required": true,
          "description": "资源id",
          "example": "无"
        },
        {
          "name": "ResourceType",
          "type": "string",
          "required": true,
          "description": "资源类型",
          "example": "无"
        },
        {
          "name": "EnvType",
          "type": "string",
          "required": true,
          "description": "预览：pre；非预览：prod",
          "example": "无"
        },
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境id",
          "example": "无"
        },
        {
          "name": "SubType",
          "type": "string",
          "required": false,
          "description": "子资源类型",
          "example": "无"
        },
        {
          "name": "PageNo",
          "type": "integer",
          "required": false,
          "description": "页码",
          "example": "无"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "分页大小",
          "example": "无"
        }
      ],
      "required": [
        "ResourceId",
        "ResourceType",
        "EnvType",
        "EnvId"
      ]
    },
    {
      "name": "PutWxAppIdToWeApp",
      "description": "接口提供应用绑定微信ID功能。",
      "status": "online",
      "parameters": [
        {
          "name": "WeAppId",
          "type": "string",
          "required": true,
          "description": "应用ID",
          "example": "app-xxx"
        },
        {
          "name": "WxAppId",
          "type": "string",
          "required": true,
          "description": "微信AppId",
          "example": "无"
        }
      ],
      "required": [
        "WeAppId",
        "WxAppId"
      ]
    },
    {
      "name": "SearchDocList",
      "description": "知识库文档搜索接口",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-xxx"
        },
        {
          "name": "CollectionView",
          "type": "string",
          "required": false,
          "description": "知识库名称",
          "example": "collection_view"
        },
        {
          "name": "SearchKey",
          "type": "string",
          "required": false,
          "description": "搜索模式",
          "example": "id"
        },
        {
          "name": "SearchValue",
          "type": "string",
          "required": false,
          "description": "搜索值",
          "example": "value"
        },
        {
          "name": "PageNo",
          "type": "integer",
          "required": false,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "页大小",
          "example": "10"
        }
      ],
      "required": [
        "EnvId"
      ]
    },
    {
      "name": "UpdateKnowledgeSet",
      "description": "更新知识库",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-sdf"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "知识库标识",
          "example": "name"
        },
        {
          "name": "Title",
          "type": "string",
          "required": false,
          "description": "知识库名称",
          "example": "title"
        },
        {
          "name": "Desc",
          "type": "string",
          "required": false,
          "description": "描述",
          "example": "desc"
        },
        {
          "name": "Active",
          "type": "string",
          "required": false,
          "description": "状态;ENABLED启用；NOT_ENABLED不启用",
          "example": "ENABLED"
        },
        {
          "name": "Meta",
          "type": "string",
          "required": false,
          "description": "知识库的meta信息",
          "example": "meta"
        }
      ],
      "required": [
        "EnvId",
        "Name"
      ]
    },
    {
      "name": "UploadKnowledgeDocumentSet",
      "description": "更新知识库",
      "status": "online",
      "parameters": [
        {
          "name": "EnvId",
          "type": "string",
          "required": true,
          "description": "环境ID",
          "example": "lowcode-sdf"
        },
        {
          "name": "CollectionView",
          "type": "string",
          "required": true,
          "description": "知识库标识",
          "example": "qinmyku873d0a9"
        },
        {
          "name": "FileName",
          "type": "string",
          "required": true,
          "description": "状态;ENABLED启用；NOT_ENABLED不启用",
          "example": "my-test.md"
        },
        {
          "name": "CosUrl",
          "type": "string",
          "required": true,
          "description": "腾讯云文件存储位置的可读地址",
          "example": "http://example.myqcloud.com/file.txt"
        },
        {
          "name": "DocumentType",
          "type": "string",
          "required": false,
          "description": "文件类型，例如: .docx, .md",
          "example": ".md"
        },
        {
          "name": "DocumentDesc",
          "type": "string",
          "required": false,
          "description": "对文件的描述",
          "example": "一个md文件"
        },
        {
          "name": "FileTitle",
          "type": "string",
          "required": false,
          "description": "文件标题",
          "example": "文件标题"
        },
        {
          "name": "FileMetaData",
          "type": "string",
          "required": false,
          "description": "文件元信息，为jsonstring",
          "example": "{\"url\":\"\",\"title\":\"标题\"}"
        },
        {
          "name": "DocumentSetId",
          "type": "string",
          "required": false,
          "description": "文件id",
          "example": "id"
        },
        {
          "name": "Delimiter",
          "type": "string",
          "required": false,
          "description": "使用 regex 分割文档",
          "example": "\\n{2,}"
        },
        {
          "name": "FileId",
          "type": "string",
          "required": false,
          "description": "Cos存储文件ID",
          "example": "cloud://aa.doc"
        }
      ],
      "required": [
        "EnvId",
        "CollectionView",
        "FileName",
        "CosUrl"
      ]
    }
  ]
}