华为云用户手册

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 page_num Integer 分页查询时，每页最多展示的记录数。 page_size Integer 分页查询的页数。 total_size Integer 总共条数。 total_pages Integer 总页数。 result Array of result objects 应用详情。 表3 result 参数 参数类型 描述 id String 应用ID。 project_id String 项目ID。 mark_for_delete Integer 删除标记。 0：未删除 1：删除 create_by String 创建人。 create_time Long 创建时间。 update_by String 更新人。 update_time Long 更新时间。 name_cn String 应用的中文名称。 name_en String 应用的英文名称。 desc_cn String 应用的中文描述。 desc_en String 应用的英文描述。 database_type String 应用的数据库类型。 environment String 运行服务的环境标识。 owners Array of strings 应用责任人。

操作步骤 获取待部署的应用ID。 接口相关信息 URI格式：GET /v1/{project_id}/apps 详情请参见获取租户下的应用清单。 请求示例 GET https://{iDME Endpoint}/v1/{project_id}/apps {project_id}请从获取项目ID获取。 响应示例 { "result": [ { "id": "44145d41ae294e111111eafd4da32ea8", "project_id": "cf49a20d85294c93b1111111ca9454bc", "mark_for_delete": 0, "create_by": "59779076d1dc********c91c2c54bd7a", "create_time": 1690427901000, "update_by": "59779076d1dc********c91c2c54bd7a", "update_time": 1690427901000, "name_cn": "TestApp", "name_en": "TestApp", "desc_cn": "", "desc_en": "", "database_type": "mysql", "environment": "beta", "owners": [ "user_1", "idme_container1" ] }, { "id": "c787dcd484944ad11111dd18693e4eb2", "project_id": "cf49a20d85294c93b1111111ca9454bc", "mark_for_delete": 0, "create_by": "59779076d1dc********c91c2c54bd7a", "create_time": 1689622165000, "update_by": "59779076d1dc********c91c2c54bd7a", "update_time": 1689622165000, "name_cn": "工业产品问卷调查", "name_en": "Questionnaire_Survey", "desc_cn": "", "desc_en": "", "database_type": "mysql", "environment": "dev", "owners": [ "dme-console" ] } ], "page_num": 1, "page_size": 500, "total_size": 2, "total_pages": 1 } 获取待部署的运行服务。 接口相关信息 URI格式：GET /v1/{project_id}/envs 详情请参见获取运行服务清单。 请求示例 GET /v1/{project_id}/envs 响应示例 为篇幅起见，这里只展示部分内容。请求成功时，响应参数如下： { "result": [ { "project_id": "cf49a20d85294c93b1111111ca9454bc", "region_id": "cn-north-4", "env_id": "2f25874d-43d4-453c-91f7-3898f397ac22", "env_name": "MySQLTest1", "env_status": "RUNNING", "env_type": "CLOUD_BASIC", "env_app_link_status": "RUNNING", "env_conf_info": "基础版 数据建模引擎 节点*1", "env_app_link_id": "e2ad5c196eb5420657d3cb9eff8c0874", "app_id": "c787dcd484944ad11111dd18693e4eb2", "app_version": "500d48b0724a1111b6dfb4da338d342f_1690974321079", "app_name_en": "Questionnaire_Survey", "app_name_cn": "工业产品问卷调查", "app_environment": "dev", "enabled": false, "last_deploy_time": 1691026735000, "deploy_user_id": "16ee111111111b2c971d8d50ff9d0d42", "charging_mode": "prePaid", "create_time": 1690252391000, "resource_id": "2f25874d-43d4-453c-91f7-3898f397ac22", "resource_spec_code": "dme.instance.basic.standard", "org_code": "9190086000001158862", "org_name": "idme-test", "app_login_url": "https://orgid-test.huaweiapaas.com/oauth2/authorize?response_type=cod******", "app_create_time": 1690496417000, "database_type": "mysql" }, { "project_id": "cf49a20d85294c93b1111111ca9454bc", "region_id": "cn-north-7", "env_id": "5dc54ff9-f659-4ac2-b6f3-fe18227ea05e", "env_name": "测试体验版计费因子", "env_status": "RUNNING", "env_type": "CLOUD_TRIAL", "env_app_link_status": "DEPLOYING", "env_conf_info": "体验版 数据建模引擎 节点*1", "app_id": "44145d41ae294e111111eafd4da32ea8", "app_version": "44f5e16ea3554492a3aad3cff7039152_1690278188344", "app_name_en": "TestApp", "app_name_cn": "TestApp", "app_environment": "dev", "enabled": false, "last_deploy_time": 1691100385000, "deploy_user_id": "7e06441a333849c7bbca280992edd835", "charging_mode": "postPaid", "create_time": 1687650507000, "resource_id": "5dc54ff9-f659-4ac2-b6f3-fe18227ea05e", "resource_spec_code": "dme.instance.trial", "org_code": null, "org_name": null, "app_login_url": null, "app_create_time": 1690236458000, "security_group_id": "test" } ], "page_num": 1, "page_size": 500, "total_size": 5, "total_pages": 1 } 部署应用。 接口相关信息 URI格式：POST /v1/{project_id}/envs/{env_id}/apps/{app_id}/deploy 详情请参见部署应用。 请求示例 PUT https://{iDME Endpoint}/v1/cf49a20d85294c93b1111111ca9454bc/envs/2f25874d-43d4-453c-91f7-3898f397ac22/apps/c787dcd484944ad11111dd18693e4eb2/deploy Body： { "version": "500d48b0724a4445b6dfb4da338d342f_1690974321079", "org_code": "9190086000001158862", "org_name": "idme-test" } 响应示例 状态码为200。

前提条件 已开通工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME），并根据开通区域确定调用API的Endpoint，详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证，具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

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

前提条件 已开通工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）/数字化制造基础服务，并根据开通区域确定调用API的Endpoint，详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证，具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

操作步骤 获取接口相关信息。 URI格式：POST /wom/v1/wos/batch-cancel 详情请参见批量取消工单。 在Request Header中增加“X-Auth-Token”。 发送“POST https://{iDME Endpoint}/wom/v1/wos/batch-cancel”。 Body [ "1417639245421830258", "1425789631742573107" ] 查看请求响应结果。 请求成功时，响应参数如下： { "status" : "200", "message" : "success", "data" : 1 } 请求异常时，错误码请参见错误码。

操作步骤 获取接口相关信息。 URI格式：POST /wom/v1/wos/batch-create 详情请参见导入工单。 在Request Header中增加“X-Auth-Token”。 发送“POST https://{iDME Endpoint}/wom/v1/wos/batch-create”。 Body [ { "wo_order" : "WOP123456", "erp_wo_order" : "QWERTYUI", "parent_wo_order" : "WOP147369", "part_no" : "TEST2023", "part_revision" : "1", "lot_unit" : 1, "wo_qty" : 100, "site_no" : "TEST210213", "data_source" : "MANUAL" } ] 查看请求响应结果。 请求成功时，响应参数如下： { "status" : "200", "message" : "success", "data" : "1" } 请求异常时，错误码请参见错误码。

前提条件 已开通工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）/数字化制造基础服务，并根据开通区域确定调用API的Endpoint，详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证，具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

前提条件 已开通工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）/数字化制造基础服务，并根据开通区域确定调用API的Endpoint，详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证，具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

操作步骤 获取接口相关信息。 URI格式：POST /wom/v1/wos/batch-instantiate 详情请参见批量实例化工单。 在Request Header中增加“X-Auth-Token”。 发送“POST https://{iDME Endpoint}/wom/v1/wos/batch-instantiate”。 Body [ "1417639245421830258", "1425789631742573107" ] 查看请求响应结果。 请求成功时，响应参数如下： { "status" : "200", "message" : "success", "data" : 1 } 请求异常时，错误码请参见错误码。

操作步骤 获取接口相关信息。 URI格式：GET /v1/{project_id}/apps 详情请参见获取租户下的应用清单。 在Request Header中增加“X-Auth-Token”。 发送“GET https://{iDME Endpoint}/v1/{project_id}/apps”。 {project_id}请从获取项目ID获取。 查看请求响应结果。 请求成功时，响应参数如下： { "result": [ { "id": "44145d41ae294e111111eafd4da32ea8", "project_id": "cf49a20d85294c93b1111111ca9454bc", "mark_for_delete": 0, "create_by": "59779076d1dc********c91c2c54bd7a", "create_time": 1690427901000, "update_by": "59779076d1dc********c91c2c54bd7a", "update_time": 1690427901000, "name_cn": "TestApp", "name_en": "TestApp", "desc_cn": "", "desc_en": "", "database_type": "mysql", "environment": "beta", "owners": [ "user_1", "idme_container1" ] }, { "id": "c787dcd484944ad11111dd18693e4eb2", "project_id": "cf49a20d85294c93b1111111ca9454bc", "mark_for_delete": 0, "create_by": "59779076d1dc********c91c2c54bd7a", "create_time": 1689622165000, "update_by": "59779076d1dc********c91c2c54bd7a", "update_time": 1689622165000, "name_cn": "工业产品问卷调查", "name_en": "Questionnaire_Survey", "desc_cn": "", "desc_en": "", "database_type": "mysql", "environment": "dev", "owners": [ "dme-console" ] } ], "page_num": 1, "page_size": 500, "total_size": 2, "total_pages": 1 } 请求异常时，错误码请参见错误码。

前提条件 已开通工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME），并根据开通区域确定调用API的Endpoint，详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证，具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

状态码 状态码如表1所示： 表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获取项目ID 项目ID还用通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

从控制台获取项目ID 从控制台获取项目ID（project_id）和名称（project name）的步骤如下： 登录管理控制台。 鼠标移动到页面右上角账号名，然后在下拉列表中单击“我的凭证”，进入“我的凭证”页面。 如果登录的是华为云官网，而非管理控制台。在单击用户名后，选择下拉列表中的“帐号中心”，然后单击“管理我的凭证”进入“我的凭证”页面。 在“API凭证”页面的项目列表中查看项目ID和名称（即“项目”）。 图1 查看项目ID

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 status String 响应状态 message String 响应信息 data Object 返回结果 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息 状态码： 500 表4 响应Body参数 参数 参数类型 描述 status String 响应状态 message String 响应信息 data Object 返回结果

响应示例 状态码： 200 请求成功 { "status" : "200", "message" : "success", "data" : 1 } 状态码： 400 参数校验异常 { "error_code" : "IDT.06031001", "error_msg" : "{0} is required and cannot be empty." } 状态码： 500 API执行异常 { "status" : "500", "message" : "API执行异常", "data" : null }

操作步骤 获取接口相关信息。 URI格式：POST /wom/v1/wos/batch-detail 详情请参见分页查询工单。 在Request Header中增加“X-Auth-Token”。 发送“POST https://{iDME Endpoint}/wom/v1/wos/batch-detail”。 Body { "wo_id" : "1417639245421830258", "wo_order" : "WOP123456", "erp_wo_order" : "QWERTYUI", "part_no" : "TEST2023", "wo_type_list" : [ "10" ], "site_no" : "TEST210213", "wo_status_list" : [ "10" ], "start_time" : "2023-08-14 00:00:00", "end_time" : "2023-08-14 00:00:00", "actual_start_time" : "2023-08-14 00:00:00", "actual_end_time" : "2023-08-14 00:00:00", "split_flag" : "1", "solution_flag" : "2", "hold_flag" : "0" } 查看请求响应结果。 请求成功时，响应参数如下： { "status" : "200", "message" : "success", "data" : { "count" : 1, "limit" : 20, "offset" : 0, "data" : [ { "tenant_id" : "xdm_ytjtest", "created_by" : "zhangsan", "created_date" : "2023-07-11 00:00:00", "created_by_name" : "张三", "last_updated_by" : "wangwu", "last_updated_date" : "2023-07-11 00:00:00", "last_updated_by_name" : "王五", "wo_id" : "1417639245421830258", "wo_order" : "WOP123456", "erp_wo_id" : "1457698771257845", "erp_wo_order" : "QWERTYUI", "parent_wo_id" : "1478932452572618", "parent_wo_order" : "WOP147369", "wo_type" : "10", "part_id" : "1564789221484123", "part_no" : "TEST2023", "part_desc" : "MODEL测试", "part_revision" : "1", "lot_unit" : 1, "wo_qty" : 100, "site_id" : "22DF4572394G485KF502", "site_no" : "TEST210213", "completed_qty" : 1, "wo_status" : "10", "hold_flag" : "0", "split_flag" : "1", "solution_flag" : "2", "sn_generate_flag" : "0", "erp_plan_start_date" : "2023-07-11 00:00:00", "erp_plan_end_date" : "2023-07-11 00:00:00", "data_source" : "MANUAL", "actual_wo_start_date" : "2023-07-11 00:00:00", "actual_wo_complete_date" : "2023-07-11 00:00:00", "org_id" : "1", "org_code" : "1", "synchronization_date" : "2023-07-11 00:00:00", "production_mode" : "10" } ] } } 请求异常时，错误码请参见错误码。

前提条件 已开通工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）/数字化制造基础服务，并根据开通区域确定调用API的Endpoint，详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证，具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

操作步骤 获取接口相关信息。 URI格式：GET /v1/{project_id}/envs 详情请参见获取运行服务清单。 在Request Header中增加“X-Auth-Token”。 发送“GET https://{iDME Endpoint}/v1/{project_id}/envs”。 {project_id}请从获取项目ID获取。 查看请求响应结果。 为篇幅起见，这里只展示部分内容。请求成功时，响应参数如下： { "result": [ { "project_id": "cf49a20d85294c93b1111111ca9454bc", "region_id": "cn-north-4", "env_id": "2f25874d-43d4-453c-91f7-3898f397ac22", "env_name": "MySQLTest1", "env_status": "RUNNING", "env_type": "CLOUD_BASIC", "env_app_link_status": "RUNNING", "env_conf_info": "基础版 数据建模引擎 节点*1", "env_app_link_id": "e2ad5c196eb5420657d3cb9eff8c0874", "app_id": "c787dcd484944ad11111dd18693e4eb2", "app_version": "500d48b0724a1111b6dfb4da338d342f_1690974321079", "app_name_en": "Questionnaire_Survey", "app_name_cn": "工业产品问卷调查", "app_environment": "dev", "enabled": false, "last_deploy_time": 1691026735000, "deploy_user_id": "16ee111111111b2c971d8d50ff9d0d42", "charging_mode": "prePaid", "create_time": 1690252391000, "resource_id": "2f25874d-43d4-453c-91f7-3898f397ac22", "resource_spec_code": "dme.instance.basic.standard", "org_code": "9190086000001158862", "org_name": "idme-test", "app_login_url": "https://orgid-test.huaweiapaas.com/oauth2/authorize?response_type=cod******", "app_create_time": 1690496417000, "database_type": "mysql" }, { "project_id": "cf49a20d85294c93b1111111ca9454bc", "region_id": "cn-north-7", "env_id": "5dc54ff9-f659-4ac2-b6f3-fe18227ea05e", "env_name": "测试体验版计费因子", "env_status": "RUNNING", "env_type": "CLOUD_TRIAL", "env_app_link_status": "DEPLOYING", "env_conf_info": "体验版 数据建模引擎 节点*1", "app_id": "44145d41ae294e111111eafd4da32ea8", "app_version": "44f5e16ea3554492a3aad3cff7039152_1690278188344", "app_name_en": "TestApp", "app_name_cn": "TestApp", "app_environment": "dev", "enabled": false, "last_deploy_time": 1691100385000, "deploy_user_id": "7e06441a333849c7bbca280992edd835", "charging_mode": "postPaid", "create_time": 1687650507000, "resource_id": "5dc54ff9-f659-4ac2-b6f3-fe18227ea05e", "resource_spec_code": "dme.instance.trial", "org_code": null, "org_name": null, "app_login_url": null, "app_create_time": 1690236458000, "security_group_id": "test" } ], "page_num": 1, "page_size": 500, "total_size": 5, "total_pages": 1 } 请求异常时，错误码请参见错误码。

前提条件 已开通工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME），并根据开通区域确定调用API的Endpoint，详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证，具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。

响应示例 状态码： 200 请求成功 { "status" : "200", "message" : "success", "data" : 1 } 状态码： 400 参数校验异常 { "error_code" : "IDT.06031001", "error_msg" : "{0} is required and cannot be empty." } 状态码： 500 API执行异常 { "status" : "500", "message" : "API执行异常", "data" : null }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 status String 响应状态 message String 响应信息 data Object 返回结果 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息 状态码： 500 表4 响应Body参数 参数 参数类型 描述 status String 响应状态 message String 响应信息 data Object 返回结果

响应示例 状态码： 200 OK { "id" : "", "project_id" : "", "mark_for_delete" : 0, "create_by" : "", "create_time" : 1685987901000, "update_by" : "", "update_time" : 1685987901000, "name_cn" : "wdqw222", "name_en" : "QDwqwq222", "desc_cn" : "QDwqwq222", "desc_en" : "qewqew222", "database_type" : "mysql", "environment" : "dev", "versions" : null }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 id String 应用ID。 project_id String 项目ID。 mark_for_delete Integer 删除标记。 0：未删除 1：删除 create_by String 创建人。 create_time Long 创建时间。 update_by String 更新人。 update_time Long 更新时间。 name_cn String 应用的中文名称。 name_en String 应用的英文名称。 desc_cn String 应用的中文描述。 desc_en String 应用的英文描述。 database_type String 应用的数据库类型。 environment String 运行服务的环境标识。 versions String 应用责任人。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM用户的token。 获取方法请参见获取IAM用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 应用ID。 description 是 String 应用的中文描述。 description_en 是 String 应用的英文描述。 app_user_list 是 Array of AppUserList objects 应用责任人。 表4 AppUserList 参数 是否必选 参数类型 描述 id 否 String 用户ID。 name 否 String 用户名。

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 IDT.04000028 Param {0} is invalid. 请求参数输入错误 请修改相应的请求参数 400 IDT.04011004 Env is illegal 运行环境不合法 请修改运行环境 400 IDT.04011005 validate the relationship fail between app and env 应用与运行环境的关系验证失败 请检查运行环境是否存在此应用 400 IDT.04011006 The number of tenant applications has exceeded the upper limit of 20 创建应用的数量超过限制 请联系技术支持 400 IDT.04011007 The application does not exist. 应用不存在 请修改应用 400 IDT.04011008 The application has been deployed, uninstall the application first. 无法删除已部署的应用 请先卸载应用，再删除 400 IDT.04011014 Fail to uninstall app because invalid app env relation 运行环境异常，导致卸载应用失败 请检查运行环境是否正常，或者联系技术支持 400 IDT.04011017 env and app database not consistent 运行环境与应用间的数据库类型不匹配 请检查运行环境的数据库类型与应用的数据库类型是否一致 500 IDT.04000002 Server busy, please try later. 系统繁忙，请稍后重试 请稍后重试，或者联系技术支持 500 IDT.04000034 Request 3rd party client error. 第三方服务错误 - 客户端错误 请联系技术支持 500 IDT.04000035 Request 3rd party service error, detail: {0}. 第三方服务错误 - 服务端错误 请联系技术支持 父主题： 附录

响应示例 状态码： 200 请求成功 { "status" : "200", "message" : "success", "data" : [ { "wo_id" : "1574698325467510369", "wo_order" : "WOP123456", "erp_wo_id" : "1457698771257845", "erp_wo_order" : "QWERTYUI", "parent_wo_id" : "1478932452572618", "parent_wo_order" : "WOP147369", "wo_type" : "10", "part_id" : "1564789221484123", "part_no" : "TEST2023", "part_desc" : "MODEL测试", "part_revision" : "1", "lot_unit" : 1, "wo_qty" : 100, "site_id" : "22DF4572394G485KF502", "site_no" : "TEST210213", "completed_qty" : 1, "wo_status" : "10", "hold_flag" : "0", "split_flag" : "1", "solution_flag" : "2", "sn_generate_flag" : "0", "erp_plan_start_date" : "2023-08-14 00:00:00", "erp_plan_end_date" : "2023-08-14 00:00:00", "data_source" : "MANUAL", "actual_wo_start_date" : "2023-08-14 00:00:00", "actual_wo_complete_date" : "2023-08-14 00:00:00", "org_id" : "1" } ] } 状态码： 400 参数校验异常 { "error_code" : "IDT.0604xxxx", "error_msg" : "xxx does not exist" } 状态码： 500 API执行异常 { "error_code" : "IDT.0604xxxx", "error_msg" : "xxx does not exist" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of OpenWoInfo objects 请求成功 表4 OpenWoInfo 参数 参数类型 描述 wo_id String 工单ID wo_order String 工单号 erp_wo_id String ERP工单ID erp_wo_order String ERP工单号 parent_wo_id String 父项工单ID parent_wo_order String 父项工单号 wo_type String 工单类型 10：生产工单 20：返工工单 30：预加工工单 part_id String 产品编码ID part_no String 产品编码 part_desc String 产品描述 part_revision String 版本 lot_unit Integer 产品单LOT批量 wo_qty Integer 工单批量 site_id String 加工区域ID site_no String 加工区域代码 completed_qty Integer 完工数量 wo_status String 工单状态 10：初始化 20：已排产 30：已下发 40：开始生产 50：工单完工 60：工单关闭 10000：已取消 hold_flag String 冻结标识（默认为0） 0：正常 1：冻结 split_flag String 预加工单拆分标识（默认为0） 0：初始化 1：拆分成功 2：拆分失败 solution_flag String 工单方案生成标识（默认为0） 0：初始化 1：生成成功 2：生成失败 3：实例化成功 4：实例化失败 8：生成中 9：实例化中 sn_generate_flag String SN展开标识（默认为0） 0：初始化 1：生成成功 2：生成失败 erp_plan_start_date String ERP计划开工时间 erp_plan_end_date String ERP计划完工时间 data_source String 数据来源 actual_wo_start_date String 工单实际开工时间 actual_wo_complete_date String 工单实际完工时间 org_id String 组织号ID 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误代码 error_msg String 错误信息

前提条件 已开通工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）/数字化制造基础服务，并根据开通区域确定调用API的Endpoint，详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证，具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。