获取租户下的应用清单
功能介绍
本接口用于获取租户在工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)的应用清单。
URI
GET /v1/{project_id}/apps
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为[1-36]个字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
page_num |
否 |
Integer |
参数解释: 分页查询的页数。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
page_size |
否 |
Integer |
参数解释: 分页查询时,每页最多展示的记录数。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
page_num |
Integer |
参数解释: 分页查询时,每页最多展示的记录数。 取值范围: 不涉及。 默认取值: 1。 |
|
page_size |
Integer |
参数解释: 分页查询的页数。 取值范围: 不涉及。 默认取值: 10。 |
|
total_size |
Integer |
参数解释: 总共条数。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
total_pages |
Integer |
参数解释: 总页数。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
result |
Array of result objects |
参数解释: 应用详情。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 应用ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
project_id |
String |
参数解释: 项目ID。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 |
|
app_type |
String |
参数解释: 使用场景。 约束限制: 不涉及。 取值范围: default:标准 lite:轻量 默认取值: 不涉及。 |
|
permission_control |
String |
参数解释: APP权限控制。 约束限制: 不涉及。 取值范围: NONE:关闭权限校验 ALL:开启所有校验 默认取值: 不涉及。 |
|
mark_for_delete |
Integer |
参数解释: 删除标记。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
create_by |
String |
参数解释: 创建人。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
create_time |
Long |
参数解释: 创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
update_by |
String |
参数解释: 更新人。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
update_time |
Long |
参数解释: 更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
name_cn |
String |
参数解释: 应用的中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
name_en |
String |
参数解释: 应用的英文名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
desc_cn |
String |
参数解释: 应用的中文描述。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
desc_en |
String |
参数解释: 应用的英文描述。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
database_type |
String |
参数解释: 应用的数据库类型。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
environment |
String |
参数解释: 运行服务的环境标识。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
owners |
Array of strings |
参数解释: 应用责任人。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
id_type |
String |
参数解释: 应用ID类型,设置应用运行态中数据模型的内置ID(即唯一编码)属性类型。 约束限制: 不涉及。 取值范围: LONG:数值类型 STRING:文本类型 默认取值: 不涉及。 |
请求示例
无
响应示例
状态码:200
OK
{
"result": [
{
"id": "",
"project_id": "",
"mark_for_delete": 0,
"create_by": "",
"create_time": 1673474220000,
"update_by": "",
"update_time": 1682984766000,
"name_cn": "",
"name_en": "",
"desc_cn": "",
"desc_en": "",
"database_type": "",
"environment": "",
“migrating_status”:""
"owners": [
"op_svc_idme_container1",
"dme-console"
]
}
],
"page_num": 1,
"page_size": 15,
"total_size": 13,
"total_pages": 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。