华为云用户手册

  • 响应示例 { "stateCode": "0", "errorMessage": null, "result": { "data": [ { "adminOrganizationCode": "830;21494", "adminOrganizationName": "XXXX总公司;XX111", "createdBy": 153169, "createName": "lyl", "creationTimestamp": 1615432302612, "fromSceneId": 4059, "isApplyApprove": 0, "isNewVersion": 0, "lastUpdatedBy": 153169, "lastUpdateName": "lyl", "lastUpdateTimestamp": 1615448819406, "reviewProcessId": null, "reviewProcessName": null, "sceneCode": "PS20210311111142612", "sceneId": 4073, "sceneLicense": null, "sceneMode": null, "sceneName": "0311测试-003", "sceneRemark": "", "sceneStatus": 0, "sceneType": 2, "sourceSceneId": 4059, "version": "1.1" }, { "adminOrganizationCode": "830;21494", "adminOrganizationName": "XXXX总公司;XX111", "createdBy": 153169, "createName": "lyl", "creationTimestamp": 1615443237758, "fromSceneId": 4080, "isApplyApprove": 0, "isNewVersion": 0, "lastUpdatedBy": 153169, "lastUpdateName": "lyl", "lastUpdateTimestamp": 1615448808878, "reviewProcessId": null, "reviewProcessName": null, "sceneCode": "PS20210311141357758", "sceneId": 4084, "sceneLicense": null, "sceneMode": null, "sceneName": "0311测试-005", "sceneRemark": "", "sceneStatus": 1, "sceneType": 2, "sourceSceneId": 4080, "version": "1.1" } ], "pos": 0, "total_count": 2, "entityName": null }}
  • 认证鉴权 ISDP+提供的OpenAPI接口都需要通过认证之后才可以访问。认证方式为:在请求消息头上设置“Authorization”。 Token在计算机系统中代表令牌(临时)的意思,拥有Token代表拥有某种权限。Token认证是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用ISDP+ Token接口获取,请求body,如下所示,其中***********为应用ID,xxxxxxxxxx为应用令牌。 POST https://isdpcloud-beta.xxx.huawei.com/oauth2/oauth/rest_tokenContent-Type: application/json{ "client_id": "isdp-xxxx-openapi", "client_secret": "isdp-xxxx-openapi", "grant_type": "password", "username": "**********", "password": "xxxxxxxxxx"} 对于获取ISDP+ Token接口,返回的响应消息体中“access_token”和“token_type”就是组成ISDP+ Token的值。 ISDP+ Token=“token_type access_token”(注意两个字段之间有空格)。 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“Authorization”,其值即为Token,如下所示。 POST https://isdpcloud-beta.xxx.huawei.com/openapi/v1/openSceneTask/createTaskAuthorization: bearer XXXXXXXXXXXXXXContent-Type: application/json 父主题: 接口调用方法
  • 响应示例 { "access_token": "*****************", "token_type": "bearer", "expires_in": 359, "scope": "all", "plat_user": { "userId": 107027, "userNo": "XXXXXXXXXXX", "userName": "test", "userType": "API", "phone": null, "tenantId": 50222, "status": "0", "deleteFlag": 0, "pwdUpdateDate": "2022-03-17T02:35:04.000+00:00", "userExtendMap": { "clientId": "isdp-xxxx-openapi" }, "password": null, "salt": null, "currentLoginType": "password" }}
  • 请求示例 { "sceneName": "掘锚机日常电气检修标准作业流程", "adminOrganization": "1001", "sceneMode": 3, "taskSceneExtendFieldList": [ { "fieldName": "流程编号", "fieldDefaultValue": "SHPM-12-A02020201-0001", "stage": 1 }, { "fieldName": "配件", "fieldDefaultValue": "", "stage": 1 }, { "fieldName": "材料", "fieldDefaultValue": "棉纱(0.2Kg)、防锈油(1桶)、清洗剂(1瓶)。", "stage": 1 }, { "fieldName": "相关事故案例", "fieldDefaultValue": "", "stage": 1 }, { "fieldName": "工具", "fieldDefaultValue": "万用表(1块)、兆欧表(1块)、一字改锥6X200mm(1把)、十字改锥6X200mm(1把),克丝钳(1把)、便携式甲烷检测报警仪(1部)、8寸活动扳手(1把)、公制内六角扳手(1套)、验电器(1部)、放电绳(1根)、接地线(1根)等。", "stage": 1 }, { "fieldName": "重要危险源", "fieldDefaultValue": "1)顶、帮支护不完好,片帮,造成人员伤害。2)未检查瓦斯浓度或瓦斯浓度超限禁止送电。3)未检查瓦斯浓度或瓦斯浓度超限禁止送电。", "stage": 1 }, { "fieldName": "使用频率", "fieldDefaultValue": "高", "stage": 1 } ], "taskSceneModeList": [ { "sceneModeName": "停机、停电", "description": "1)掘锚机停止运行;2)掘锚机控制开关手把打到零位。", "templateName": "测试openApi导入模板" } ], "templateInfoList": [ { "templateName": "测试openApi导入模板", "kcpList": [ { "children": [ { "name": "启动掘锚机", "operationGuide": "【危险源及风险】1)启动前未预警,造成人员伤害;2)启动掘锚机前,未确认周围无人员作业,造成人员伤害。\n【风险值】12\n【风险等级】中等\n【管控措施】设备启动前需发出预警信号,确保设备周边无人时方可启动。", "qualityStandard": "运行正常。", "issueType": "掘锚工艺#工器具不完好或有缺陷,造成事故", "severity": 1, "outputList": [ { "outputType": "文本", "outputName": "备注" }, { "outputType": "图片", "outputName": "图片" } ] } ] } ] } ]}
  • 相关接口 接口名称 调用说明 获取Token 调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 查询任务场景 新增时为防止重复可先进行任务场景的查询,也可以在新增后使用确保新增成功 删除任务场景 新增后如需要删除可使用删除任务场景接口 新增问题类别(API名称:createIssueConfig) 提前预配置好“问题类别” 任务扩展属性列表查询 扩展属性配置中,需提前配置好,可使用该接口查询 查询(上/下级)组织信息(API名称:findPagedOrgListWithDirection) 提前传入“组织单元编码”可使用该接口查询
  • URL 请求方式 HTTPS地址 服务架构 消息体类型 POST https://isdp+ 域名 /openapi/v1/openTaskScene/createTaskScene OpenAPI application/json 调用流程: 因为任务场景的前置依赖数据较多,成功调用此API需要提前预配置如下信息: 1、 任务管理列表,扩展属性配置中,提前配置好“租户的全局扩展属性”。“任务场景”中写入的“扩展属性”,必须是已配置好的全局扩展属性。 2、 ISDP租户管理员设置,扩展属性配置中,预配置:通用检查作业下,配置“业务类型=作业”; 3、 问题类别配置中,提前预配置好“问题类别”,如创建“问题大类=掘锚工艺”下的问题子类;便于采集模板中,每个条目对应预置的问题类别(调“问题类别创建”API,建好问题类别) 4、 入参中的“组织单元”需要传“组织单元编码”。
  • 请求参数 参数 类型 是否必填 描述 sceneName String 是 场景名称 adminOrganization String 是 组织单元编码 sceneMode Int 否 只支持任务启用工序模式,传3 taskSceneExtendFieldList入参 参数 类型 是否必填 描述 fieldName String 否 场景扩展字段名称 fieldDefaultValue String 否 扩展字段的默认值,入参有值,则赋值为扩展字段默认值,没有,则取全局扩展属性配置的默认值 stage Integer 否 扩展属性阶段:1创建阶段 2执行阶段,不填写默认为创建阶段 taskSceneModeList入参 参数 类型 是否必填 描述 sceneModeName String 否 工序名称 description String 否 工序描述,如果该工序配置了模板,工序描述也是kcp的名称 templateName String 否 工序关联的模板名称。若工序需要关联模板,则名称要在templateInfoList集合中存在。无需关联则置空(命名规则:“任务场景名称-工序名称”作为检查模板名称) templateInfoList入参 参数 类型 是否必填 描述 templateName String 否 模板名称 kcpList入参 参数 类型 是否必填 描述 name String 否 条目名称 operationGuide String 否 条目操作指导(500字以内) qualityStandard String 否 条目质量标准(500字以内) issueType String 否 条目采集问题类别,系统中存在。大类和小类用#分割,不同大类用英文分号分割。详见样例请求 severity Int 否 问题严重程度。仅支持数字。0-一般;1-重要;2-严重 outputList入参 参数 类型 是否必填 描述 outputType Int 否 输出项类型,枚举值:文本,图片 outputName String 否 输出项名称
  • 请求示例 { "sceneId": 107996, "reviewProcessId": 34909, "sceneStatus": 1, "sceneRemark": "场景描述", "reviewProcessName": "yytest-二级审批", "sceneName": "场景名称openAPI014修改1", "sceneCode": "TS20220719154907686", "sceneMode": 2, "sceneType": 0, "sceneLicense": null, "sourceSceneId": 107993, "version": "1.2", "isNewVersion": 0, "createdBy": 699960, "createName": "星星有泪", "lastUpdatedBy": 699960, "lastUpdateName": "星星有泪", "creationTimestamp": 1658216947686, "lastUpdateTimestamp": 1658218002722, "deleteFlag": "0", "signInConfig": "1", "coverId": null, "category": "", "id": null, "parentCategory": "", "parentId": null, "adminOrganizationCode": "830", "adminOrganizationName": "张三作业系统测试1", "dataSource": "appcube", "isApplyApprove": 1, "headerInfo": { "sceneName": "场景名称openAPI014修改1", "sceneRemark": "场景描述", "adminOrganizationCode": "830", "adminOrganizationName": "张三作业系统测试1", "coverId": null, "category": "", "id": null, "sceneCode": "TS20220719154907686", "sceneId": 107996, "parentId": null }, "taskSceneBaseFieldList": [ { "fieldCode": "executor", "fieldDefaultValue": [], "fieldIsNecessary": 1, "fieldName": "执行人", "fieldOrder": 1, "fieldStatus": 1, "sceneBaseFieldId": 1224580, "sceneId": 107996, "_RID": "row_1" }, { "itemId": "374104", "fieldName": "作业对象修11", "fieldStatus": 2, "itemAttr1": "2", "fieldCode": "location", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 2, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "_RID": "row_2", "fieldIsNecessary": 2 }, { "itemId": "374072", "fieldName": "行政区域修改11", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "administrativeDivision", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 3, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "_RID": "row_3", "fieldIsNecessary": 2 }, { "itemId": "375299", "fieldName": "计划开始时间1", "fieldStatus": 2, "itemAttr1": "2", "fieldCode": "planBeginDate", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 4, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "_RID": "row_10", "fieldIsNecessary": 2 }, { "itemId": "375300", "fieldName": "计划完成时间1", "fieldStatus": 2, "itemAttr1": "2", "fieldCode": "planEndDate", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 5, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "_RID": "row_11", "fieldIsNecessary": 2 }, { "fieldCode": "signInConfig", "fieldDefaultValue": null, "fieldIsNecessary": 2, "fieldName": "打卡配置", "fieldOrder": 6, "fieldStatus": 2, "sceneBaseFieldId": 1224581, "sceneId": 107996 }, { "fieldCode": "reviewRuleConfig", "fieldDefaultValue": null, "fieldIsNecessary": 2, "fieldName": "任务申请审批流配置", "fieldOrder": 7, "fieldStatus": 2, "sceneBaseFieldId": 1224582, "sceneId": 107996 } ], "taskSceneExtendFieldList": [ { "sceneExtendFieldId": 73602, "sceneId": 107996, "fieldName": "长文本有值", "fieldCode": "UDF15", "parentExtendFieldId": 0, "fieldType": "1", "fieldStatus": 1, "fieldIsNecessary": 1, "fieldOrder": 1, "fieldValue": null, "fieldDefaultValue": "12345678902345678901234567890123456789012123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012312345678901234567890123456789012345678901212345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890345678901456789034567890", "isNewWay": 1, "_RID": "row_24" }, { "id": 2248, "category": 1, "parentExtendId": 0, "fieldName": "时间有值", "fieldStatus": 1, "fieldIsNecessary": 2, "fieldOrder": 2, "fieldValue": "", "fieldDefaultValue": "1657003231000", "scopeList": [ 2, 1 ], "fieldCode": "UDF9", "fieldType": 5, "enumList": [], "_RID": "row_29", "sceneExtendEnumFieldList": [] } ], "taskSceneModeList": [ { "sceneModeId": 205721, "sceneId": 107996, "issueId": null, "parentSceneModeId": 0, "templateType": "1", "templateId": "263489", "templateName": "模板名称023", "sceneMode": 2, "taskTypeTag": 1, "modeLevel": 1, "modeOrder": 1, "templateCode": "QC2022XXXXXXXXXXXXX", "sceneModeName": "场景名称openAPI014修改1", "templateVersion": "1.0", "deleteFlag": 0, "tenantId": 886, "licenseSwitch": 0, "licenseTag": null, "lastUpdatedBy": 699960, "lastUpdateName": "星星有泪", "isAppraisal": 0, "collectionReviewId": null, "collectionReviewName": "", "signSiteId": null, "signSiteCode": null, "signSiteName": null, "regionId": null, "regionPath": null, "regionName": null, "description": null, "beginTimestamp": null, "endTimestamp": null, "priority": null, "jobDuration": null, "projectDuration": null, "administrativeDivision": null, "administrativeDivisionName": null, "address": null, "requiredStartTime": null, "requiredEndTime": null, "skill": null, "templateExistFlag": "Y", "assignedUserId": "", "assignedUserName": "", "userGroup": "", "userGroupName": "", "ccPerson": "", "ccPersonName": "", "owner": "", "ownerName": "", "ccPersonGroup": "", "ccPersonGroupName": "", "ownerGroup": "", "ownerGroupName": "", "subTaskExtendFieldList": [] } ], "baseSubTaskFieldList": [], "subTaskExtendFieldList": [], "taskSceneFileList": [], "operationFlag": "Y"}
  • 请求参数 参数 类型 是否必填 描述 dataSource String 是 创建来源标识。 submitterAccount String 是 提交人账号。 taskSceneBaseFieldList Object 是 基础字段。 taskSceneExtendFieldList Object 否 扩展字段。 sceneMode Integer 否 任务场景模式。 1:简单任务 2:关联作业检查清单 3:任务启用工序 4:父子任务 sceneStatus Integer 否 任务场景状态。 0:草稿 1:可用 2:停用 operationFlag String 是 是否是提交或者保存草稿。 Y:提交 N:保存草稿 taskSceneModeList Object 是 任务场景配置模板信息。 headerInfo Object 是 任务场景配置场景信息。 isApplyApprove Integer 否 是否需要申请审批。 0:否 1:是 reviewProcessId Long 否 评审流ID。 reviewProcessName String 否 评审流名称。 adminOrganizationCode String 是 组织单元ID。 adminOrganizationName String 是 组织单元名称。 signInConfig Integer 否 是否启用打卡配置。 1:启用 0:不启用 null:该场景没有引入打卡配置 sceneId Long 是 任务场景ID。 Version String 否 版本号。 taskSceneExtendFieldList扩展字段Object说明 参数 类型 是否必填 描述 fieldName String 是 自定义字段名称。 fieldType Integer 是 扩展字段类型。1:文本 2:枚举 3:多枚举 4:日期 5:时间 6:整数;7:小数;20:短文本 0:无意义,字段默认值。 fieldStatus Integer 是 字段状态。 fieldCode String 是 字段编码。 scopeList Object 是 适用范围。1:标准任务 2:临时任务 fieldOrder Integer 是 字段排序序号,从0开始。 fieldValue String 否 字段枚举值。 fieldDefaultValue String 否 字段默认值。 fieldIsNecessary Integer 否 是否必填。1:必填 2:其它 enumList Object 否 枚举值列表。 sceneExtendEnumFieldList Object 否 枚举值列表。 id Long 是 主键ID(引入时)。 category Integer 是 分属类别。1:任务 2:子任务 stage Integer 否 任务场景扩展属性阶段 1:创建阶段 2:执行阶段,默认为创建阶段 unitName String 否 单位 其中对象信息对照创建任务场景。
  • 请求示例 { "taskSceneFileList": [], "taskSceneBaseFieldList": [ { "itemId": "374104", "fieldName": "作业对象修11", "fieldStatus": 1, "itemAttr1": "2", "fieldCode": "location", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 1, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 1, "_RID": "row_1" }, { "itemId": "374072", "fieldName": "行政区域修改11", "fieldStatus": 1, "itemAttr1": "", "fieldCode": "administrativeDivision", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 2, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 1, "_RID": "row_2" }, { "itemId": "374073", "fieldName": "详细地址11", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "address", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 3, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_3" }, { "itemId": "375297", "fieldName": "项目修改11", "fieldStatus": 2, "itemAttr1": "2", "fieldCode": "projectNo", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 4, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_4" }, { "itemId": "375298", "fieldName": "供应商1", "fieldStatus": 2, "itemAttr1": "2", "fieldCode": "supplier", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 5, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_5" }, { "itemId": "374074", "fieldName": "客户1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "customer", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 6, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_6" }, { "itemId": "374075", "fieldName": "标准作业时长1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "jobDuration", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 7, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_7" }, { "itemId": "374076", "fieldName": "工期1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "projectDuration", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 8, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_8" }, { "itemId": "375299", "fieldName": "计划开始时间1", "fieldStatus": 1, "itemAttr1": "2", "fieldCode": "planBeginDate", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 9, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 1, "_RID": "row_9" }, { "itemId": "375300", "fieldName": "计划完成时间1", "fieldStatus": 1, "itemAttr1": "2", "fieldCode": "planEndDate", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 10, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 1, "_RID": "row_10" }, { "itemId": "374077", "fieldName": "要求开始时间1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "requiredStartTime", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 11, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_11" }, { "itemId": "374078", "fieldName": "要求完成时间1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "requiredEndTime", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 12, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_12" }, { "itemId": "374079", "fieldName": "优先级1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "priority", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 13, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_13" }, { "itemId": "374038", "fieldName": "要求技能1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "skill", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 14, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_14" }, { "itemId": "374080", "fieldName": "调度模式1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "schedulingMode", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 15, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_15" }, { "itemId": "375305", "fieldName": "操作指导1", "fieldStatus": 2, "itemAttr1": "2", "fieldCode": "operationGuide", "itemAttr3": "fieldIsNecessary", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 16, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_16" }, { "itemId": "375304", "fieldName": "附件1", "fieldStatus": 2, "itemAttr1": "2", "fieldCode": "attachment", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 17, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_17" }, { "itemId": "375303", "fieldName": "关联问题1", "fieldStatus": 2, "itemAttr1": "2", "fieldCode": "associatedIssues", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 18, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_18" }, { "itemId": "375302", "fieldName": "任务描述12", "fieldStatus": 2, "itemAttr1": "2", "fieldCode": "taskDescription", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 19, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_19" }, { "itemId": "379610", "fieldName": "抄送人1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "ccPerson", "itemAttr3": "", "itemAttr2": "", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 20, "itemDesc": "", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_20" }, { "itemId": "379746", "fieldName": "责任人1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "owner", "itemAttr3": "", "itemAttr2": "", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 21, "itemDesc": "", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2, "_RID": "row_21" }, { "fieldName": "执行人", "fieldStatus": 1, "fieldIsNecessary": 1, "fieldCode": "executor", "fieldOrder": 22, "fieldDefaultValue": [], "_RID": "row_22" }, { "itemId": "630405", "fieldName": "许可配置1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "licenseConfig", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 23, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2 }, { "itemId": "375301", "fieldName": "审批流配置1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "reviewRuleConfig", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 24, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2 }, { "itemId": "630406", "fieldName": "关联视频设备1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "associatingVideoDevice", "itemAttr3": "", "itemAttr2": "2", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 25, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2 }, { "itemId": "377320", "fieldName": "打卡配置1", "fieldStatus": 2, "itemAttr1": "", "fieldCode": "signInConfig", "itemAttr3": "", "itemAttr2": "", "itemAttr5": "", "itemAttr4": "", "fieldOrder": 26, "itemDesc": "ATTR1:状态(1-可用, 2-停用),ATTR2是否必填(1-必填, 2-不必填),ATTR3不可修改字段", "classifyCode": "QC_TASK_BASE_FIELD", "fieldIsNecessary": 2 } ], "taskSceneExtendFieldList": [ { "id": 2709, "category": 1, "parentExtendId": 0, "fieldName": "长文本有值", "fieldStatus": 1, "fieldIsNecessary": 1, "fieldOrder": 1, "fieldValue": "", "fieldDefaultValue": "12345678902345678901234567890123456789012123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012312345678901234567890123456789012345678901212345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890345678901456789034567890", "scopeList": [ 1, 2 ], "fieldCode": "UDF15", "fieldType": 1, "enumList": [], "_RID": "row_23", "sceneExtendEnumFieldList": [] } ], "sceneMode": 2, "taskSceneModeList": [ { "sceneMode": 2, "templateId": 263489, "templateCode": "QC2022XXXXXXXXXXXX", "templateVersion": "1.0", "templateName": "模板名称023", "templateType": 1, "isAppraisal": 1, "collectionReviewId": "", "collectionReviewName": "", "modeOrder": 1, "sceneModeName": "", "licenseSwitch": 0, "oldSceneModeName": "" } ], "reviewProcessName": "", "reviewProcessId": "", "isApplyApprove": null, "sceneLicense": null, "signInConfig": "1", "headerInfo": { "sceneName": "场景名称1111", "sceneRemark": "场景描述", "adminOrganizationCode": 830, "adminOrganizationName": "杨凌作业系统测试1", "coverId": "", "category": "1", "id": 3294 }, "sceneStatus": 1, "operationFlag": "Y"}
  • 请求参数 参数 类型 是否必填 描述 dataSource String 是 创建来源标识。 submitterAccount String 是 提交人账号。 taskSceneBaseFieldList Object 是 基础字段。 taskSceneExtendFieldList Object 否 扩展字段 subBaseFieldConfig List 否 子任务场景基础字段(父子任务场景中使用) subTaskExtendFieldList List 否 子任务场景扩展字段(父子任务场景中使用) sceneMode Integer 否 任务场景模式。 1:简单任务 2:关联作业检查清单 3:任务启用工序 4:父子任务 sceneStatus Integer 否 任务场景状态。0:草稿 1:可用 2:停用 operationFlag String 是 是否是提交或者保存草稿。 Y:提交 N:保存草稿 taskSceneModeList Object 是 任务场景配置模板信息。 headerInfo Object 是 任务场景配置场景信息。 isApplyApprove Integer 否 是否需要申请审批。0:否 1:是 reviewProcessId Long 否 评审流ID。 reviewProcessName String 否 评审流名称。 adminOrganizationCode String 是 组织单元ID。 adminOrganizationName String 是 组织单元名称。 signInConfig Integer 否 是否启用打卡配置。1:启用 0:不启用 null:该场景没有引入打卡配置 taskSceneBaseFieldList基础字段Object说明: 参数 类型 是否必填 描述 fieldName String 是 字段名称。 fieldStatus Integer 是 字段状态。 1:可用 2:停用 fieldIsNecessary Integer 是 是否必填。 1:必填 2:其它 fieldCode String 是 字段编码。 fieldOrder Integer 是 字段排序序号。 fieldDefaultValue String 否 基础字段默认值。 extraData1 String 否 附加属性。 subBaseFieldConfig子任务场景基础字段Object说明: 参数 类型 是否必填 描述 fieldName String 是 字段名称。 fieldStatus Integer 是 字段状态。1:可用 2:停用 fieldCode String 是 字段编码。 taskSceneExtendFieldList、subTaskExtendFieldList(创建父子任务场景时候填写)扩展字段Object说明: 参数 类型 是否必填 描述 fieldName String 是 自定义字段名称。 fieldType Integer 是 扩展字段类型。1:文本 2:枚举 3:多枚举 4:日期 5:时间 6:整数;7:小数;20:短文本 0:无意义,字段默认值。 fieldStatus Integer 是 字段状态。 fieldCode String 是 字段编码。 scopeList Object 是 适用范围。1:标准任务 fieldOrder Integer 是 字段排序序号,从0开始。 fieldValue String 否 字段枚举值。 fieldDefaultValue String 否 字段默认值。 fieldIsNecessary Integer 否 是否必填。1:必填 2:其它 enumList Object 否 枚举值列表。 sceneExtendEnumFieldList Object 否 枚举值列表。 id Long 是 主键ID(引入时)。 category Integer 是 分属类别。1:任务 2:子任务 stage Integer 否 任务场景扩展属性阶段 1:创建阶段 2:执行阶段 unitName String 否 单位名称 fieldDefaultValue基础字段默认值执行人字段Object说明("fieldCode": "executor"): 参数 类型 是否必填 描述 userId Long 是 用户ID,执行人群组ID。 userName String 是 用户名称。 userType Integer 是 用户类型。 1:执行人 2:执行人群组 taskSceneModeList任务场景配置模板信息Object说明: 参数 类型 是否必填 描述 collectionProcessType Integer 否 审批流类型。 0:标准审批 1:临时审批流 2:自定义审批流 collectionReviewId Long 否 采集评审流ID。 collectionReviewName String 否 用户类型。 1:执行人 2:执行人群组 customCollectionReviewerList Object 否 采集评审人列表。 isAppraisal Integer 否 是否需要采集评审。 0:否 1:是 modeOrder Integer 是 排序序号,从1开始。 sceneMode Integer 否 任务场景模式。 1:简单任务 2:关联作业检查清单 3:任务启用工序 4:父子任务 sceneModeName String 否 不汲及 子任务/工序名称 oldSceneModeName String 否 不汲及 升级前子任务/工序名称 templateCode String 否 模板编码。 templateId Long 否 模板ID。 templateName String 否 模板名称。 templateVersion String 否 模板模板号。 templateType Integer 否 模板类型。 0:安全检查 1:质量检查 2:巡检 templateModel Object 否 创建新的模板,kcpList不为空则直接发布新的模板。 kcpList Object 否 创建新的KCP列表信息。 subTaskExtendFieldList List 否 创建父子任务场景,子任务扩展属性对象 taskSceneModeList中subTaskExtendFieldList子任务场景扩展属性信息Object说明: 参数 类型 是否必填 描述 fieldCode String 是 场景名称。 fieldDefaultValue String 否 场景描述。 stage Integer 否 子任务场景扩展属性阶段 1:创建阶段 2:执行阶段 其中templateModel、kcpList参数参照保存检查单模板KCP、ITEM信息接口。 headerInfo任务场景配置场景信息Object说明: 参数 类型 是否必填 描述 sceneName String 是 场景名称。 sceneRemark String 否 场景描述。 adminOrganizationCode String 是 组织单元ID。 adminOrganizationName String 是 组织单元名称。 category String 否 领域场景。 id Long 否 领域场景(任务类别ID)。 sceneType Integer 否 场景创建类型。 0:按场景创建 1:手动创建虚拟场景 2:许可场景
  • 请求示例 { "taskQueries": [ { "supplierName": "", "taskRemark": "", "beginTimestamp": "", "collectionReviewName": "", "sceneName": "openApi-简单任务场景", "latitude": "23.456", "signSiteName": "bzh00201", "customerTaskId": "1255d-104456789123789001026", "projectNo": "", "assignedUserType": "1", "geoType": "BD", "reviewRuleName": "人员数量", "taskName": "简单任务012", "assignedUser": "15080988442", "endTimestamp": "", "taskExtendList": "", "longitude": "123.456", "toolSet": [ { "toolNo": "T003", "toolName": "子任务2-工序1", "toolLocation": { "x": 100, "y": 200 }, "toolAttrList": [ { "attrName": "显示名称", "attrCode": "displayName", "attrValue": "子任务2-工序1" } ] } ] } ]}
  • 响应示例 { "stateCode": "0", "errorMessage": null, "result": [ { "status": "0", "message": "保存成功", "customerTaskId": null, "taskId": 2900025 } ]}
  • 响应参数 参数 类型 描述 stateCode String 响应状态码。 0:成功 其他:失败 errorMessage String 响应描述。 result Object 响应结果内容data、分页数据。 data出参: 参数 类型 描述 customerTaskId String 客户任务ID taskId Long 创建成功的任务id status Integer 返回状态:0-成功;1-失败 message String 返回的失败消息。
  • 相关API 接口名称 调用说明 获取Token 调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 查询任务场景 调用该接口获取到任务场景的场景名称。 创建任务时,需要输入获取到的场景名称。 查询租户下用户信息(API名称:getPersonListByTenant) 调用该接口获取执行人。 创建任务时,任务模式为“启用子任务”时,需要输入获取到执行人;其他任务模式“执行人”为空则提交后为“待调度”状态,“执行人”填写后提交为“待执行”或“任务申请待审批”状态。 查询父任务 创建任务后,可以调用该接口查询创建的任务。
  • 响应示例 { "stateCode": "0", "errorMessage": null, "result": [ { "extendName": "修改名称", "extendValue": "3-值", "extendType": 1, "udfName": "UDF1", "isNecessary": 2 }, { "extendName": "新增13", "extendValue": null, "extendType": 1, "udfName": "UDF13", "isNecessary": 2 }, { "extendName": "新增18", "extendValue": null, "extendType": 1, "udfName": "UDF14", "isNecessary": 2 }, { "extendName": "23232323", "extendValue": "23232323-值", "extendType": 1, "udfName": "UDF15", "isNecessary": 1 }, { "extendName": "临时任务-文本", "extendValue": null, "extendType": 1, "udfName": "UDF16", "isNecessary": 2 } ]}
  • 响应参数 参数 类型 描述 stateCode String 响应编码。 errorMessage String 错误信息。 result Object 响应数据。 result中对象说明: 参数 类型 描述 extendName String 自定义扩展属性名称。 extendType Integer 扩展字段类型。 1:文本 2:枚举 3:多枚举 4:日期 5:时间 extendValue String 扩展属性值。 udfName String 扩展属性编码。 isNecessary Integer 是否必填。 0:不必填 1:必填
  • 请求示例 https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments{ "project_id" : "55837d272adf4eee90319800e2da6961", "name" : "Environment name", "deploy_type" : 0, "description" : "Environment Description", "os" : "linux"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式) X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表3 请求Body参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目id。 name 是 String 环境名称 deploy_type 是 Integer 部署类型:0表示主机, 1表示kubernetes os 是 String 操作系统:windows|linux,需要和主机集群保持一致 description 否 String 环境描述
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 String 分组id application_ids 是 Array of strings 应用id列表
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result Array of MoveAppToGroupResult objects 移动应用至指定分组结果,仅返回移动失败的列表 status String 请求成功失败状态 表5 MoveAppToGroupResult 参数 参数类型 描述 code String 是否失败 application_id String 应用id application_name String 应用名称 error_code String 错误码 error_msg String 错误信息
  • 请求示例 https://{endpoint}/v1/projects/0a38ce9ba3c740c199a0f872b6163661/applications/groups/move{ "application_ids" : [ "a958794f9f4f4a24a96950c9cb279a4d", "a958794f9f4f4a24a96950c9cb279a4f" ], "group_id" : "ec3ccc617cf3405b8a6236f26223112b"}
  • 响应示例 状态码: 200 OK 请求响应成功 { "result" : [ { "id" : "cb439d016d8641c8a44c177a121fad15", "name" : "Test", "duration" : "00:00:17", "is_disable" : true, "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde", "project_name" : "项目1", "is_care" : false, "can_modify" : true, "can_delete" : true, "can_view" : true, "can_execute" : true, "can_copy" : true, "can_manage" : false, "can_create_env" : false, "can_disable" : false, "create_user_id" : "04ec4661a8df4359b50980a9c958c86d", "create_tenant_id" : "208fbb09068e4820b9209ef9ff4da73d", "create_time" : "2023-07-05 20:34:40.0", "update_time" : "2023-08-02 14:20:30.0", "execution_time" : "2023-08-18 09:40:16", "end_time" : "2023-08-18 09:40:33", "execution_state" : "failed", "release_id" : 4, "executor_id" : "6baa7454109d47c192f22078fe6cda20", "executor_nick_name" : "测试账号", "arrange_infos" : [ { "id" : "e700f15965694253940502911220d76b", "state" : "failed", "deploy_system" : "deployTemplate" } ] } ], "total_num" : 1}
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型(格式) X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表2 请求Body参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id,获取方式请参见获取项目id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 page 是 Integer 参数解释: 分页页码,表示从此页开始查询。 约束限制: 不涉及。 取值范围: 1-99999 默认取值: 不涉及。 size 是 Integer 参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 1-100 默认取值: 不涉及。 sort_name 否 String 参数解释: 排序字段的名称。 约束限制: 不涉及。 取值范围: name: 应用名称 startTime: 开始时间 默认取值: 不涉及。 sort_by 否 String 参数解释: 排序顺序。 约束限制: 不涉及。 取值范围: ASC: 正序 asc: 正序 DESC: 逆序 desc: 逆序 默认取值: 不涉及。 states 否 Array of strings 参数解释: 应用状态列表。 约束限制: 不涉及。 取值范围: abort: 部署中止 failed: 部署失败 not_started: 取消执行 pending: 排队中 running: 正在部署 succeeded: 部署成功 timeout: 部署超时 not_executed: 未执行 默认取值: 不涉及。 group_id 否 String 参数解释: 应用的分组id,传入no_grouped为查询未分组的应用。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符 或者 no_grouped。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total_num Integer 参数解释: 应用总数。 取值范围: 不涉及。 result Array of AppExecutionInfo objects 参数解释: 应用列表数组。 表4 AppExecutionInfo 参数 参数类型 描述 id String 参数解释: 应用id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 name String 参数解释: 应用名称。 取值范围: 由中文字符、英文字母、数字及“_”、“-”组成,且长度为[3-128]个字符。 duration String 参数解释: 部署时间。 取值范围: 不涉及。 is_disable Boolean 参数解释: 当前应用是否被禁用。 取值范围: true: 被禁用 false: 未被禁用 project_id String 参数解释: 项目id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 project_name String 参数解释: 项目名称。 取值范围: 长度为[3,128]个字符。 is_care Boolean 参数解释: 当前用户是否已收藏。 取值范围: true: 已收藏 false: 未收藏 can_modify Boolean 参数解释: 是否有编辑权限。 取值范围: true: 有权限 false: 无权限 can_delete Boolean 参数解释: 是否有删除的权限。 取值范围: true: 有权限 false: 无权限 can_view Boolean 参数解释: 是否有查看权限。 取值范围: true: 有权限 false: 无权限 can_execute Boolean 参数解释: 是否有部署权限。 取值范围: true: 有权限 false: 无权限 can_copy Boolean 参数解释: 是否有复制权限。 取值范围: true: 有权限 false: 无权限 can_manage Boolean 参数解释: 是否有编辑应用权限矩阵的权限。 取值范围: true: 有权限 false: 无权限 can_create_env Boolean 参数解释: 是否有创建环境的权限。 取值范围: true: 有权限 false: 无权限 can_disable Boolean 参数解释: 是否有禁用应用的权限。 取值范围: true: 有权限 false: 无权限 deploy_system String 参数解释: 部署类型模式。 取值范围: deployTemplate: 部署模板 create_user_id String 参数解释: 应用创建者用户id。 取值范围: 由英文字母、数字组成,且长度为[1,32]个字符。 create_tenant_id String 参数解释: 应用创建者租户id。 取值范围: 由英文字母、数字组成,且长度为[1,32]个字符。 create_time String 参数解释: 创建时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 update_time String 参数解释: 修改时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 execution_time String 参数解释: 最后一次部署时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 end_time String 参数解释: 部署结束时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 execution_state String 参数解释: 部署状态。 取值范围: 不涉及。 release_id Integer 参数解释: 部署记录序列号。 取值范围: 不涉及。 executor_id String 参数解释: 部署者id。 取值范围: 由英文字母、数字组成,且长度为[1,32]个字符。 executor_nick_name String 参数解释: 部署者昵称。 取值范围: 不涉及。 arrange_infos Array of TaskBaseResponseBody objects 参数解释: 部署任务信息。 表5 TaskBaseResponseBody 参数 参数类型 描述 id String 参数解释: 部署任务id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 state String 参数解释: 部署任务状态。 取值范围: Available: 可执行状态 Draft: 草稿状态 deploy_system String 参数解释: 部署类型模式。 取值范围: deployTemplate: 部署模板
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result Array of ExecuteRecordV2Body objects 参数解释: 应用历史部署记录列表。 total_num Integer 参数解释: 开始时间和结束时间内应用历史部署记录总数。 取值范围: 不涉及。 表5 ExecuteRecordV2Body 参数 参数类型 描述 duration String 参数解释: 部署用时。 取值范围: 不涉及。 state String 参数解释: 应用状态。 取值范围: 不涉及。 operator String 参数解释: 操作人用户名。 取值范围: 不涉及。 execution_id String 参数解释: 部署记录id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 start_time String 参数解释: 部署应用的开始时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 nickname String 参数解释: 操作人昵称。 取值范围: 不涉及。 end_time String 参数解释: 部署应用的结束时间。格式为yyyy-MM-dd HH:mm:ss。例如:2021-02-25 10:37:27。 取值范围: 不涉及。 release_id Long 参数解释: 部署记录序列号。 取值范围: 不涉及。 type String 参数解释: 部署类型。 取值范围: install: 安装部署
  • 响应示例 状态码: 200 OK 请求响应成功 { "result" : [ { "duration" : "00:16:53", "state" : "succeeded", "type" : "install", "operator" : "devcloud_devcloud_l00490255_01", "execution_id" : "50f18ce454a64ea5a62a33d56617b831", "start_time" : "2022-04-15 15:03:24", "nickname" : "AB边账号", "end_time" : "2022-04-15 15:20:17", "release_id" : 20 }, { "duration" : "00:15:31", "state" : "failed", "type" : "install", "operator" : "devcloud_devcloud_l00490255_01", "execution_id" : "f757fbe93d35494ba0ff73b34e2f79aa", "start_time" : "2022-04-15 15:03:15", "nickname" : "AB边账号", "end_time" : "2022-04-15 15:18:46", "release_id" : 19 } ], "total_num" : 20}
  • URI GET /v2/{project_id}/task/{id}/history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目id,获取方式请参见获取项目id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 id 是 String 参数解释: 部署任务id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 page 是 Integer 参数解释: 分页页码, 表示从此页开始查询。 约束限制: 不涉及。 取值范围: 1-99999 默认取值: 不涉及。 size 是 Integer 参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 1-100 默认取值: 不涉及。 start_date 是 String 参数解释: 区间开始时间。格式为yyyy-MM-dd。例如:2022-03-16。 约束限制: 与end_date配合使用,end_date需大于等于start_date,开始时间和结束时间间隔不能超过30天。 取值范围: 不涉及。 默认取值: 不涉及。 end_date 是 String 参数解释: 区间结束时间。格式为yyyy-MM-dd。例如:2022-04-15。 约束限制: 与start_date配合使用,end_date需大于等于start_date,开始时间和结束时间间隔不能超过30天。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应示例 状态码: 200 OK 请求响应成功 { "result" : [ { "id" : "2c82ffe8d00d4968a4e5f7a36d87ae17", "name" : " 消息通知 ", "state" : "succeeded", "owner" : "devcloud_devcloud_l00490255_01", "duration" : "00:00:50", "project_id" : "332f53cbabc44863a46ce6b4f82a9fe7", "project_name" : "DeployMan-UI-L0", "deploy_system" : "deployTemplate", "create_time" : "2022-02-09 16:34:20", "update_time" : "2022-03-05 09:04:39", "execution_time" : "2022-04-11 15:50:23", "execution_state" : "succeeded", "role_id" : -1, "is_defaut_permission" : false, "executor_id" : "6baa7454109d47c192f22078fe6cda20", "executor_nick_name" : "AB边账号", "nick_name" : "AB边账号", "owner_id" : "6baa7454109d47c192f22078fe6cda20", "is_care" : true, "can_modify" : true, "can_delete" : true, "can_view" : true, "can_execute" : true, "can_copy" : true, "can_manage" : true, "can_disable" : false, "release_id" : 61640, "is_disable" : true }, { "id" : "a9c3ef27a1f34a1abf1dc84d927d7d39", "name" : "412", "state" : "failed", "owner" : "paas_clouddeploy_h00472130_01", "duration" : "00:02:36", "project_id" : "332f53cbabc44863a46ce6b4f82a9fe7", "project_name" : "DeployMan-UI-L0", "deploy_system" : "deployTemplate", "create_time" : "2022-04-12 17:26:07", "update_time" : "2022-04-12 17:26:07", "execution_time" : "2022-04-13 11:45:09", "execution_state" : "failed", "role_id" : -1, "is_defaut_permission" : false, "executor_id" : "04ec4661a8df4359b50980a9c958c86d", "executor_nick_name" : "paas_clouddeploy_h00472130_01", "nick_name" : "paas_clouddeploy_h00472130_01", "owner_id" : "04ec4661a8df4359b50980a9c958c86d", "is_care" : false, "can_modify" : true, "can_delete" : true, "can_view" : true, "can_execute" : true, "can_copy" : true, "can_manage" : true, "can_disable" : false, "release_id" : 29, "is_disable" : true } ], "total_num" : 331}
  • URI GET /v2/{project_id}/tasks/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方式请参见获取项目id。 表2 Query参数 参数 是否必选 参数类型 描述 page 是 Integer 分页页码, 表示从此页开始查询, page大于等于1 size 是 Integer 每页显示的条目数量,size小于等于100
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全