部署应用 - DeployApplication
功能介绍
本接口用于在工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)中完成应用部署。部署成功后生成应用运行态,即可执行API调用、实例创建等相关操作。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v1/{project_id}/envs/{env_id}/apps/{app_id}/deploy
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于标识资源所属的项目空间。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,长度为1-36个字符。 默认取值: 不涉及。 |
| env_id | 是 | String | 参数解释: 运行服务的唯一标识,用于指定应用部署的目标运行服务。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| app_id | 是 | String | 参数解释: 应用唯一标识,用于指定要删除的应用。 约束限制: 不涉及。 取值范围: 由英文和数字组成。当唯一标识为应用名称时,长度为1-36个字符;当唯一标识为应用ID时,长度固定为32个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| version | 是 | String | 参数解释: 所部署应用的版本信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| org_code | 否 | String | 参数解释: 组织编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| org_name | 否 | String | 参数解释: 组织名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| xdm_running_state_administrators | 否 | Array of strings | 参数解释: 运行态管理员。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
部署应用成功。
无
请求示例
将应用ID为0069c1abcfda420e9e27588cefbe86dd、版本号为v1.0.0的应用,部署到ID为000117e9-8c9c-420c-a33a-faea1c1237f1的运行服务上。
POST https://{endpoint}/v1/1234567890/envs/000117e9-8c9c-420c-a33a-faea1c1237f1/apps/0069c1abcfda420e9e27588cefbe86dd/deploy
{
"version" : "v1.0.0",
"org_code" : null,
"org_name" : null,
"xdm_running_state_administrators" : [ "admin001", "admin002" ]
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 部署应用成功。 |
错误码
请参见错误码。