创建应用 - CreateXdmApplication
功能介绍
本接口用于在工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)中创建应用实例。应用是iDME-数据建模引擎(xDM Foundation,简称xDM-F)的核心资源载体,创建后可用于承载数据模型、业务逻辑及服务编排。每个租户下的应用数量受配额限制,请提前确保配额充足。
接口约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
dme:apps:create
Write
-
-
-
-
URI
POST /v1/{project_id}/apps
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的项目空间。 获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,长度为1-36个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的认证Token,用于接口调用身份鉴权。 获取方式请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| app_name_cn | 是 | String | 参数解释: 应用的中文名称,用于在中文界面展示应用名称。 约束限制: 不涉及。 取值范围: 仅支持中文、英文字母、数字、下划线(_)、短横线(-),且不能为“XDM”(不区分大小写),最大长度为128个字符。 默认取值: 不涉及。 |
| app_name_en | 是 | String | 参数解释: 应用的英文名称,用于系统内部标识和英文界面展示。 约束限制: 不涉及。 取值范围: 仅支持英文字母和数字,且必须以大写字母开头,且不能为“XDM”(不区分大小写),最大长度为128个字符。 默认取值: 不涉及。 |
| app_desc | 否 | String | 参数解释: 应用的中文描述,说明应用的用途、功能等信息。 约束限制: 不涉及。 取值范围: 仅支持中文、英文字母(大小写)、数字、括号、下划线(_)、短横线(-)、空格及常用标点符号,最大长度为1024个字符。 默认取值: 不涉及。 |
| app_desc_en | 否 | String | 参数解释: 应用的英文描述,说明应用的用途、功能等信息。 约束限制: 不涉及。 取值范围: 仅支持英文字母(大小写)、数字、下划线(_)、短横线(-)、空格及常用标点符号,最大长度为1024个字符。 默认取值: 不涉及。 |
| app_env | 是 | String | 参数解释: 应用部署的环境标识,用于区分不同生命周期的环境。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| database_type | 是 | String | 参数解释: 应用使用的数据库类型,决定数据存储方案。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| app_user_list | 是 | Array of AppUserList objects | 参数解释: 应用责任人,用于指定应用的管理者和使用者。 约束限制: 必须填写当前租户下的IAM账户信息,且不能为空数组。 取值范围: AppUserList对象数组,每个对象包含用户ID和用户名。 默认取值: 不涉及。 |
| integration_mode | 是 | String | 参数解释 应用的集成模式,定义外部系统访问应用的方式。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| app_type | 否 | String | 参数解释: 应用的使用场景类型,区分不同的应用规模。 约束限制: 不涉及。 取值范围: 默认取值: default。 |
| permission_control | 否 | String | 参数解释: 应用的权限控制策略,用于数据访问安全控制。 约束限制: 不涉及。 取值范围: 默认取值: NONE。 |
| id_type | 否 | String | 参数解释: 应用的ID类型,用于应用运行态中数据模型内置ID的属性类型。 约束限制: ID类型一经设置,仅支持由数值改为文本,不支持由文本改为数值,且文本类型的应用仅支持JDK17版本。 取值范围: 默认取值: LONG。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 应用的唯一标识,由系统自动生成。 取值范围: 由英文和数字组成,且长度固定为32个字符。 |
| project_id | String | 参数解释: 项目ID,用于标识资源所属的项目空间。 取值范围: 由英文字母和数字组成,长度为1-36个字符。 |
| mark_for_delete | Integer | 参数解释: 逻辑删除标记,标识数据是否被标记删除。 取值范围: |
| 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 | 参数解释: 应用的数据库类型。 取值范围: |
| environment | String | 参数解释: 应用运行的环境标识。 取值范围: |
| versions | Array of Version objects | 参数解释: 应用版本信息。 取值范围: 不涉及。 |
| migrating | Boolean | 参数解释: 判断是否在迁移中。 取值范围: true:迁移中。 false:未迁移。 |
| migrate_status | String | 参数解释: 迁移状态。 取值范围: |
| app_type | String | 参数解释: 应用的使用场景类型,区分不同的应用规模。 取值范围: |
| permission_control | String | 参数解释: 应用的权限控制策略,用于数据访问安全控制。 取值范围: |
| id_type | String | 参数解释: 应用的ID类型,用于应用运行态中数据模型内置ID的属性类型。 取值范围: |
请求示例
创建一个中文名称为“测试应用”、英文名称为“TEST”、环境为“dev”的标准使用场景的应用。
POST https://{endpoint}/v1/71710b9f65b9496d96f53f4ef7f6128b/apps
{
"app_name_cn" : "测试应用",
"app_name_en" : "TEST",
"app_env" : "dev",
"app_desc" : "这是一个测试应用",
"app_desc_en" : "This is a test application",
"app_type" : "default",
"permission_control" : "ALL",
"database_type" : "mysql",
"integration_mode" : "API",
"app_user_list" : [ {
"id" : "user001",
"name" : "ADMIN"
}, {
"id" : "user002",
"name" : "DEVELOPER"
} ]
} 响应示例
状态码:200
表示创建应用成功。
{
"id" : "",
"project_id" : "71710b9f65b9496d96f53f4ef7f6128b",
"mark_for_delete" : 0,
"create_by" : "",
"create_time" : 1685987901000,
"update_by" : "",
"update_time" : 1685987901000,
"name_cn" : "测试应用",
"name_en" : "TEST",
"desc_cn" : "这是一个测试应用",
"desc_en" : "This is a test application",
"database_type" : "mysql",
"environment" : "dev",
"migrate_status" : "0",
"app_type" : "default",
"permission_control" : "NONE",
"id_type" : "LONG",
"versions" : null,
"migrating" : false
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示创建应用成功。 |
错误码
请参见错误码。