华为云用户手册

请求示例 { "name": "场景模版20240621", "version": "1.0.0", "data": { "sceneList": [ "5006334" ], "taskSchedule": true, "taskDemo": true, "issueConfig": true }, "tags": [ "学科", "save" ]}

请求示例 { "locationCode": "打卡", "projectCode": "172725599443750568", "userAccount": "15038709978", "beginTime": "1727366400000", "endTime": "1727539199000", "outsideFlag": "N", "page": { "start": 0, "count": 20 }}

响应示例 { "stateCode": "0", "errorMessage": null, "result": { "data": [ { "signId": 23433, "tenantId": 50568, "tenantName": null, "projectNo": "172725599443750568", "projectName": "打卡", "signSiteCode": "打卡", "signSiteName": "打卡", "signUserId": "74427", "signTimestamp": 1727406647273, "signDate": "2024-09-27T03:10:47.000+00:00", "signLocation": "科技二路", "signDistanceToSite": "59", "signAddress": null, "signDistanceToTask": null, "photoFileList": null, "signNote": null, "signForceHenceFlag": "N", "forceFenceFlag": "N", "createName": "xjx", "outsideFlag": null, "signPhotoModelList": [ { "appName": "lite-isdp-server", "createdBy": 74427, "createName": "xjx", "creationDate": "2024-09-27T03:00:42.000+00:00", "creationTimestamp": 1727406647385, "deleteFlag": 0, "entityName": "signPhoto", "lastUpdateDate": "2024-09-27T03:00:42.000+00:00", "lastUpdatedBy": 74427, "lastUpdateName": "xjx", "lastUpdateTimestamp": 1727406647690, "photoId": 17550515, "signId": 23433, "signPhotoId": 1011, "status": null, "tenantId": 50568, "tenantName": null, "waterMarkId": 17550516, "waterMarkInfo": "", "waterMarkKey": "" } ], "taskName": null, "subTaskName": null, "procedureName": null, "waterMarkId": "17550516", "identityComparisonResult": null, "taskClock": null }, { "signId": 23430, "tenantId": 50568, "tenantName": null, "projectNo": "172725599443750568", "projectName": "打卡", "signSiteCode": "打卡", "signSiteName": "打卡", "signUserId": "74427", "signTimestamp": 1727404701577, "signDate": "2024-09-27T02:38:22.000+00:00", "signLocation": "", "signDistanceToSite": "12455891", "signAddress": null, "signDistanceToTask": null, "photoFileList": null, "signNote": null, "signForceHenceFlag": "N", "forceFenceFlag": "Y", "createName": "xjx", "outsideFlag": null, "signPhotoModelList": [], "taskName": null, "subTaskName": null, "procedureName": null, "waterMarkId": null, "identityComparisonResult": null, "taskClock": null }, { "signId": 23429, "tenantId": 50568, "tenantName": null, "projectNo": "172725599443750568", "projectName": "打卡", "signSiteCode": "打卡", "signSiteName": "打卡", "signUserId": "74427", "signTimestamp": 1727404698271, "signDate": "2024-09-27T02:38:18.000+00:00", "signLocation": "", "signDistanceToSite": "12455891", "signAddress": null, "signDistanceToTask": null, "photoFileList": null, "signNote": null, "signForceHenceFlag": "N", "forceFenceFlag": "Y", "createName": "xjx", "outsideFlag": null, "signPhotoModelList": [], "taskName": null, "subTaskName": null, "procedureName": null, "waterMarkId": null, "identityComparisonResult": null, "taskClock": null } ], "pos": 0, "total_count": 3, "entityName": null, "totalCount": 3 }}

请求参数 参数 类型 是否必填 描述 locationCode String 否 作业对象编码 projectCode String 否 项目编码 userAccount String 否 人员账号 beginTime String 否 打卡开始时间 endTime String 否 打卡结束时间 outsideFlag String 否 是否强制围栏 page 是 { "start":0, "count":20 }

请求示例 { "submitterAccount": "18829266016", "taskList": [ { "subTaskList": [ { "subTaskId": 5031792, "kcpList": [ { "kcpName": "kcp1", "itemList": [ { "outputList": [ { "outputName": "字符", "value": "测试采集字段" } ], "itemName": "Item1" } ] } ] }, { "subTaskId": 5031793, "kcpList": [ { "kcpName": "kcp1", "itemList": [ { "outputList": [ { "outputName": "字符", "value": "测试采集字段" } ], "itemName": "Item1" } ] } ] } ], "taskId": 5085068 } ], "type": "1", "dataSource": "appcube"}

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP请求方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取ISDP+ Token的URL部分，您可以看到其请求方法为“POST”，则其请求为： POST https://isdpcloud-beta.xxx.huawei.com/oauth2/oauth/rest_token

请求URL 请求URL由如下部分组成。 {URL-scheme}://{Endpoint}/{resource-path}?{query-string} 表1 请求URL 参数 说明 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP。 resource-path 资源路径，即API访问路径。从具体API的URL模块获取，例如“获取ISDP+Token”API的resource-path为“/oauth2/oauth/rest_token”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取ISDP+的Token，“/oauth2/oauth/rest_token”为资源路径，假设ISDP+测试环境域名为“isdpcloud-beta.xxx.huawei.com”，URL拼接起来如下所示。 https://isdpcloud-beta.xxx.huawei.com/oauth2/oauth/rest_token

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取ISDP+ Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。 将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中***********为应用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"}

发起请求 到这里为止这个请求需要的内容就具备齐全了，您可以使用Postman或直接编写代码等方式发送请求调用API。 对于获取ISDP+ Token接口，返回的响应消息体中“access_token”和“token_type”就是组成ISDP+ Token的值。有了Token之后，您就可以使用Token认证调用其他ISDP+ OpenAPI。 ISDP+ Token=“token_type access_token”（注意两个字段之间有空格）。

请求消息头 附加请求头字段，如指定的URL和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 消息头名称 描述 是否必选 Content-Type 消息体的类型（格式），HTTP协议中设定的一个参数，用于标识返回的内容用什么格式去解析。 消息体的类型请参见API接口中API的说明。 是 Authorization ISDP+的Token，调用ISDP+的API要用到的访问令牌，在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 当前示例中API功能为 获取Token ，因此调用该接口时，不用填写本字段。 否 对于获取ISDP+ Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://isdpcloud-beta.xxx.huawei.com/oauth2/oauth/rest_tokenContent-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": "图片" } ] } ] } ] } ]}

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 否 输出项名称

相关接口 接口名称 调用说明 获取Token 调用该接口获取到Token，再调用其他接口时，需要在请求消息头中添加“Authorization”，其值即为Token。 查询任务场景 新增时为防止重复可先进行任务场景的查询，也可以在新增后使用确保新增成功 删除任务场景 新增后如需要删除可使用删除任务场景接口 新增问题类别（API名称：createIssueConfig） 提前预配置好“问题类别” 任务扩展属性列表查询 扩展属性配置中，需提前配置好，可使用该接口查询 查询(上/下级)组织信息（API名称：findPagedOrgListWithDirection） 提前传入“组织单元编码”可使用该接口查询

请求示例 { "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：许可场景

响应示例 { "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：必填

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

终端节点 终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询服务的终端节点。 部署服务的终端节点如表1所示，请您根据业务需要选择对应 区域的终端节点。 表1 部署服务的终端节点 区域名称 区域 终端节点（Endpoint） 协议类型 华南-广州 cn-south-1 codearts-deploy.cn-south-1.myhuaweicloud.com codearts-deploy.cn-south-1.myhuaweicloud.cn HTTPS 华东-上海一 cn-east-3 codearts-deploy.cn-east-3.myhuaweicloud.com codearts-deploy.cn-east-3.myhuaweicloud.cn HTTPS 华东-上海二 cn-east-2 codearts-deploy.cn-east-2.myhuaweicloud.com codearts-deploy.cn-east-2.myhuaweicloud.cn HTTPS 华北-北京四 cn-north-4 codearts-deploy.cn-north-4.myhuaweicloud.com codearts-deploy.cn-north-4.myhuaweicloud.cn HTTPS 华北-北京一 cn-north-1 codearts-deploy.cn-north-1.myhuaweicloud.com codearts-deploy.cn-north-1.myhuaweicloud.cn HTTPS

基本概念 账号 用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参加AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxx为project的名称，如cn-north-1，您可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

步骤1：查询用户的所有主机集群 接口信息： URI：GET /v2/host-groups API Explorer 在线调试请参见：查询主机集群列表 。 请求示例： GET https://{endpoint}/v2/host-groups?region_name=cn-north-7&project_id=6039d4480efc4dddb178abff98719913&offset=1&limit=10&sort_key=create_time&sort_dir=DESC 响应示例： { "total" : 1, "host_groups" : [ { "name" : "testwyk", "description" : "11122211", "os" : "linux", "nick_name" : "AB边账号", "id" : 200001291, "group_id" : "ab7647b0863c4e969c8949d38d591339", "region_name" : "cn-north-7", "project_id" : "6039d4480efc4dddb178abff98719913", "permission" : { "can_view" : true, "can_edit" : true, "can_delete" : true, "can_add_host" : true, "can_manage" : true }, "created_by" : { "user_id" : "6baa7454109d47c192f22078fe6cda20", "user_name" : "devcloud_devcloud_l00490255_01" }, "updated_by" : { "user_id" : "6baa7454109d47c192f22078fe6cda20", "user_name" : "devcloud_devcloud_l00490255_01" }, "auto_connection_test_switch" : 0, "slave_cluster_id" : "", "created_time" : "2021-04-01 17:05:53", "updated_time" : "2021-04-21 14:29:14", "host_count" : 1, "project_name" : null } ] }