文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 应用管理/ 获取租户下的应用清单 - ListApps
更新时间：2026-07-31 GMT+08:00
查看PDF
分享

获取租户下的应用清单 - ListApps

功能介绍

本接口用于获取租户在工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）中的应用清单。该清单包含应用的基本信息详情。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    dme:apps:list

    List

    -

    -

    dme:apps:get

    -

URI

GET /v1/{project_id}/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于标识资源所属的项目空间。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

由英文字母和数字组成，长度为1-36个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

page_num

否

Integer

参数解释：

分页查询的页码，用于控制当前返回的页数。

约束限制：

无。

取值范围：

大于等于0的整数。

默认取值：

0。

page_size

否

Integer

参数解释：

每页返回的记录数，用于控制分页大小。

约束限制：

无。

取值范围：

正整数，最大值为500。

默认取值：

10。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

page_num

Integer

参数解释：

当前页码。

取值范围：

大于等于0的整数。

page_size

Integer

参数解释：

每页记录数。

取值范围：

正整数，最大值为500。

total_size

Integer

参数解释：

总条数。

取值范围：

不涉及。

total_pages

Integer

参数解释：

总页数。

取值范围：

不涉及。

result

Array of result objects

参数解释：

应用详情列表。

取值范围：

不涉及。
表4 result

参数

参数类型

描述

id

String

参数解释：

应用的唯一标识。

  • 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。

  • 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。

取值范围：

由英文和数字组成。当唯一标识为应用名称时，长度为1-36个字符；当唯一标识为应用ID时，长度固定为32个字符。

project_id

String

参数解释：

应用所属项目ID。

取值范围：

由英文字母和数字组成，长度为1-36个字符。

app_type

String

参数解释：

应用使用场景类型。

取值范围：

default：标准

lite：轻量

permission_control

String

参数解释：

应用的权限控制策略，用于数据访问安全控制。

取值范围：

  • NONE：关闭权限校验

  • ALL：开启所有校验

mark_for_delete

Integer

参数解释：

逻辑删除标记。

取值范围：

  • 0：未删除。

  • 1：删除。

create_by

String

参数解释：

应用创建人的用户名。

取值范围：

不涉及。

create_time

Long

参数解释：

应用的创建时间，格式为Unix时间戳（毫秒）。

取值范围：

不涉及。

update_by

String

参数解释：

最近一次更新应用的用户名。

取值范围：

不涉及。

update_time

Long

参数解释：

应用的最近更新时间，格式为Unix时间戳（毫秒）。

取值范围：

不涉及。

name_cn

String

参数解释：

应用的中文名称。

取值范围：

仅支持中文、英文字母、数字、下划线（_）、短横线（-），且不能为“XDM”（不区分大小写），最大长度为128个字符。

name_en

String

参数解释：

应用的英文名称。

取值范围：

仅支持英文字母和数字，且必须以大写字母开头，且不能为“XDM”（不区分大小写），最大长度为128个字符。

desc_cn

String

参数解释：

应用的中文描述。

取值范围：

仅支持中文、英文字母（大小写）、数字、括号、下划线（_）、短横线（-）、空格及常用标点符号，最大长度为1024个字符。

desc_en

String

参数解释：

应用的英文描述。

取值范围：

仅支持英文字母（大小写）、数字、下划线（_）、短横线（-）、空格及常用标点符号，最大长度为1024个字符。

database_type

String

参数解释：

应用的数据库类型。

取值范围：

  • mysql：关系型数据库管理系统。

  • postgresql：对象-关系型数据库管理系统。

environment

String

参数解释：

应用运行的环境标识。

取值范围：

  • dev：用于开发环境。

  • sit：用于功能测试环境。

  • uat：用于用户测试环境。

  • train：用于培训环境。

  • beta：用于灰度部署环境。

  • production：用于生产环境。

owners

Array of strings

参数解释：

应用责任人。

取值范围：

不涉及。

id_type

String

参数解释：

应用ID类型，设置应用运行态中数据模型的内置ID（即唯一编码）属性类型。

取值范围：

  • LONG：数值类型

  • STRING：文本类型

triple_management_enabled

Boolean

参数解释：

应用是否开启三员管理。

取值范围：

  • true：开启三员管理

  • false：未开启三员管理

  • null：未开启三员管理

migrate_status

String

参数解释：

迁移状态。

取值范围：

  • 0：未迁移

  • 1：迁移中

hostname

String

参数解释：

默认域名。

取值范围：

不涉及。

请求示例

查询xx租户项目下的应用清单。

GET https://{endpoint}/v1/71710b9f65b9496d96f53f4ef7f6128b/apps?page_num=1&page_size=10

响应示例

状态码：200

OK

{
  "result" : [ {
    "id" : "701d34e780174f50aee82a9ba4e36b14",
    "project_id" : "71710b9f65b9496d96f53f4ef7f6128b",
    "mark_for_delete" : 0,
    "create_by" : "a6bb1e7d5e6340dabfb8df7c76ab8e15",
    "create_time" : 1778667518000,
    "update_by" : "a6bb1e7d5e6340dabfb8df7c76ab8e15",
    "update_time" : 1778667746000,
    "name_cn" : "NEWPDMBAK",
    "name_en" : "NEWPDMBAK",
    "desc_cn" : null,
    "desc_en" : null,
    "database_type" : "postgresql",
    "environment" : "train",
    "migrate_status" : "0",
    "app_type" : "default",
    "permission_control" : "NONE",
    "id_type" : "STRING",
    "owners" : [ "op_svc_bom", "op_svc_ipdcspace" ],
    "hostname" : "",
    "triple_management_enabled" : false
  } ],
  "page_num" : 1,
  "page_size" : 15,
  "total_size" : 1,
  "total_pages" : 1
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 应用管理

相关文档