-
响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportAppRsp objects 导入应用响应体。 表6 ImportAppRsp 参数 参数类型 描述 source_app_id String 参数解释: 源应用ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 destination_app_id String 参数解释: 目标应用ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 destination_app_name String 参数解释: 目标应用名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 version String 参数解释: 应用版本。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 message String 参数解释: 导入结果信息,仅在导入失败时会返回。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 status String 参数解释: 导入结果状态。 约束限制: 不涉及 取值范围: UNABLE_IMPORT:无法导入 ALREADY_IMPORT:重复导入 IMPORT_SUC
CES S:导入成功 IMPORT_FAIL:导入失败 默认取值: 不涉及 状态码:207 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of ImportAppRsp objects 导入应用响应体。 表8 ImportAppRsp 参数 参数类型 描述 source_app_id String 参数解释: 源应用ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 destination_app_id String 参数解释: 目标应用ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 destination_app_name String 参数解释: 目标应用名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 version String 参数解释: 应用版本。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 message String 参数解释: 导入结果信息,仅在导入失败时会返回。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 status String 参数解释: 导入结果状态。 约束限制: 不涉及 取值范围: UNABLE_IMPORT:无法导入 ALREADY_IMPORT:重复导入 IMPORT_SUCCESS:导入成功 IMPORT_FAIL:导入失败 默认取值: 不涉及
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,
获取Token 接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 source_project_id 是 String 参数解释: 源项目ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 import_apps 是 Array of AppSrcReq objects 参数解释: 源应用列表。 约束限制: 最多支持设置10个应用。 取值范围: 不涉及 默认取值: 不涉及 表4 AppSrcReq 参数 是否必选 参数类型 描述 destination_app_name 是 String 参数解释: 目标应用名称。 约束限制: 不涉及 取值范围: 长度为[1,56],以大小写字母开头,允许出现中划线(-)、小写字母和数字,且必须以大小写字母或数字结尾。 默认取值: 不涉及 destination_app_version 是 String 参数解释: 目标应用版本。 约束限制: 不涉及 取值范围: 长度[1,24],以小写字母或数字或大写字母开头,允许出现中划线,必须以小写字母或数字或大写字母结尾。 默认取值: 不涉及 source_app_id 是 String 参数解释: 源应用ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及
-
URI POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/batch-import 表1 路径参数 参数 是否必选 参数类型 描述 eihealth_project_id 是 String 参数解释: 空间ID,您可以从获取空间ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 project_id 是 String 参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及
-
请求示例 更新应用,更新应用cpu资源为1C,内存资源为1G。 https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/{app_id}
{
"name" : "demo-app",
"version" : "1.0.0",
"summary" : "summary",
"description" : "description",
"labels" : [ "labelA", "labelB" ],
"image" : "gwj-test-01/busybox:latest",
"commands" : [ "echo eihealth;" ],
"resources" : {
"cpu_type" : "X86",
"cpu" : "1C",
"memory" : "1G",
"gpu_type" : "GPU",
"gpu" : 0
},
"inputs" : [ {
"name" : "dir-parameter",
"description" : "parameter description",
"required" : true,
"concurrent" : "vars_iter",
"type" : "DIRECTORY",
"pattern" : "*.fastq",
"values" : [ "test-project:/300M_NA12878_clean_1.fastq" ]
} ],
"outputs" : [ {
"name" : "dir-parameter",
"description" : "parameter description",
"required" : true,
"type" : "DIRECTORY",
"pattern" : "*.fastq",
"values" : [ "test-project:/output-dir/" ]
} ],
"node_labels" : [ "health.node" ],
"icon" : "data:image/png;base64,xxxxx"
}
-
URI PUT /v1/{project_id}/eihealth-projects/{eihealth_project_id}/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 参数解释: 应用ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 eihealth_project_id 是 String 参数解释: 空间ID,您可以从获取空间ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 project_id 是 String 参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及
-
应用概述 开天工业工作台提供了平台预装应用,开租即可使用,同时提供订阅应用及自建应用功能。 内置应用:开租即用。如待办、日程、待办中心等。 预装应用:开租即用。预装应用包括两种:联邦应用和SaaS应用。 订阅应用:企业管理员在云商店主动购买的应用。 自建应用:租户的自研应用或者不在预集成应用列表中的软件类或商业应用,企业管理员还需要选择应用支持的认证协议、同步方式创建应用实例,进行应用集成开发。 父主题: 应用管理
-
支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。
IAM 项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效。如果在企业管理中授权,则该自定义策略不生效。管理员可以在授权项列表中查看授权项是否支持IAM项目或企业项目,“√”表示支持,“×”表示暂不支持。关于IAM项目与企业项目的区别,请参考IAM与企业管理的区别。 ServiceStage的支持自定义策略授权项如下所示:
-
请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。
-
URI DELETE /v3/{project_id}/cas/environments/{environment_id}/addons/{addon_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID。获取方法,请参考获取项目ID。 environment_id 是 String 环境ID。获取方法,请参考获取所有环境 - ObtainAllEnvironments。 addon_id 是 String 插件ID。获取方法,请参考查询插件列表 - QueryAdd-onList。
-
授权信息 账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。 如果使用角色与策略授权,具体权限要求请参见权限和授权项。 如果使用身份策略授权,需具备如下身份策略权限。 授权项 访问级别 资源类型(*为必须) 条件键 别名 依赖的授权项 servicestage:environment:deleteAddon write environment * - servicestage:app:delete -
-
响应示例 {
"id": "9974a8b3-cbd7-4084-bac9-194f7d5ba3da",
"name": "gray",
"swimlane_group_id": "b76dad96-66cf-4ae7-aa55-11b6d630e777",
"type": "GRAY",
"tag": "gray",
"weight": 0,
"route_status": "DISABLED",
"rule_match_mode": null,
"project_id": "4008a952b3f44b5a919c9a48d90811f3",
"rules": null,
"creator": "test_user",
"create_time": 1722928561358,
"update_time": 1722928561358
}
-
请求消息 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。
-
授权信息 账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。 如果使用角色与策略授权,具体权限要求请参见权限和授权项。 如果使用身份策略授权,需具备如下身份策略权限。 授权项 访问级别 资源类型(*为必须) 条件键 别名 依赖的授权项 servicestage::modifyLane write - - servicestage:app:modify -
-
响应消息 表4 响应参数 参数 参数类型 描述 id String 泳道ID。 name String 泳道名称。 swimlane_group_id String 所属的泳道组ID。 type String 泳道类型。 BASE:基线泳道。 GRAY:灰度泳道。 tag String 泳道标签,根据标签来控制流量的走向。 route_status String 泳道路由状态。 ENABLE:开启路由。 DISABLED:关闭路由。 rule_match_mode String 路由规则匹配模式。 当泳道组灰度类型为基于内容,即gray_release_type为CONTENT时生效。 ALL:匹配所有的规则。 ANY:匹配任一规则。 rules Array of objects 路由规则。当泳道组灰度类型为基于内容,即gray_release_type为CONTENT时生效。请参考表5。 weight Integer 泳道流量权重,范围在0-100之间。当泳道组灰度类型为基于流量,即gray_release_type为WEIGHT时生效。 project_id String 项目ID。 create_time Integer 创建时间。 update_time Integer 更新时间。 creator String 创建人。 表5 rules 参数 参数类型 描述 type String 灰度匹配规则类型。当前只支持HEADER,即基于Header头进行匹配。 key String 键。 value String 值。 condition String 匹配条件。 EXACT:精确匹配。 PREFIX:前缀匹配。 REGEX:正则匹配。
-
请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式),默认取值为“application/json;charset=utf8”。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权。