获取应用列表

最近更新时间:2025-09-16 01:55:48

我的收藏

1. 接口描述

接口请求域名: lowcode.tencentcloudapi.com 。

分页获取当前用户的应用列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeApps。
Version String 公共参数,本接口取值:2021-01-08。
Region String 公共参数,本接口不需要传递此参数。
Limit Integer 分页每页个数
示例值:1
Offset Integer 分页Offset
示例值:1
EnvId String 环境id
示例值:lowcode-sss
Keyword String 搜索关键词
示例值:name
AppIds.N Array of String 应用id
示例值:["app-1","app-2"]
Channel String 来源类型
示例值:SITEBUILD
Type Integer 1-自定义应用;2-模型应用
示例值:0
Favorite Boolean 应用是否收藏
示例值:true

3. 输出参数

参数名称 类型 描述
Weapps Array of Weapp 应用列表
注意:此字段可能返回 null,表示取不到有效值。
Count Integer 应用个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取应用列表

获取应用列表

输入示例

POST / HTTP/1.1
Host: lowcode.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApps
<公共请求参数>

{
    "Limit": 1,
    "Offset": 0,
    "Favorite": true
}

输出示例

{
    "Response": {
        "Count": 1,
        "RequestId": "d2c7af0a-59a0-42aa-8f06-36888a27b6b1",
        "Weapps": [
            {
                "AppType": 1,
                "AttachAppId": "",
                "BackgroundColor": "",
                "Channel": "",
                "ClientId": "AAU5PwABBkwmrGD34LQ",
                "CmsProject": 0,
                "ContentType": "JSON",
                "CreateTime": "2023-03-03T10:16:18+08:00",
                "Description": "PC应用",
                "EData": "edata",
                "EType": 1,
                "Env": "{\"envId\": \"lowcode-1gisa8u9d5edc4f8\", \"region\": \"ap-shanghai\"}",
                "EnvId": "lowcode-1gisa8u9d5edc4f8",
                "EnvRegion": "ap-shanghai",
                "ExpireTime": "0001-01-01T00:00:00Z",
                "FaviconUrl": "",
                "FlowId": 0,
                "IconUrl": "",
                "Id": "app-1rdp4z6f",
                "IsFree": false,
                "JobInfo": {
                    "ErrMsg": "",
                    "Id": 0,
                    "Status": 0,
                    "Step": 0,
                    "StepDesc": "",
                    "TotalStep": 0
                },
                "LastDeployTime": "2025-02-21T14:45:03+08:00",
                "LastMpCiId": "",
                "LastMpCiMode": 0,
                "LastMpCiStatus": "",
                "LastWebCiId": "df352da2-f648-47ea-ae59-88df953eb550",
                "LastWebCiMode": 2,
                "LastWebCiStatus": "success",
                "Name": "app-1rdp4z6f",
                "Owner": "98528",
                "PkgId": "lowcode-1gisa8u9d5edc4f8",
                "Platform": "WEB",
                "SceneType": "",
                "Source": "",
                "Status": 0,
                "TemplateId": "",
                "Title": "资产管理",
                "UpdateTime": "2025-02-21T14:47:06+08:00",
                "Favorite": true,
                "PublishPlatform": "cloudAdmin"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。