华为云用户手册

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/generateBusinessCode 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUC CES S：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of BusinessCodeVo objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表4 BusinessCodeVo 参数 参数类型 描述 code String 参数解释： 业务编码。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM 用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 PersistObjectIdsModifierDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 PersistObjectIdsModifierDTO 参数 是否必选 参数类型 描述 ids 是 Array of strings 参数解释： 数据实例 ID列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modifier 否 String 参数解释： 修改人。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/enable 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

响应参数 状态码： 200 表8 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of longs 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/count 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/count{ "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "characterSet" : "UTF8", "isNeedTotal" : true, "isPresentAll" : true, "publicData" : "INCLUDE_PUBLIC_DATA", "decrypt" : false, "filter" : { "joiner" : "and", "ignoreStr" : false, "conditions" : [ { "conditionName" : "rdmExtensionType", "conditionValues" : [ "PersistableModel" ], "operator" : "=", "ignoreStr" : false } ] }, "sorts" : [ ] }}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of integers 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/logicalDeleteBranch{ "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "modifier" : "test1", "masterId" : "602425926667476992", "version" : "A" }}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of integers 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/VersionModel/deleteLatestVersion{ "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : { "modifier" : "test1", "masterId" : "602425926667476992", "version" : "A" }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 VersionModelVersionMasterModifierDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 VersionModelVersionMasterModifierDTO 参数 是否必选 参数类型 描述 masterId 是 String 参数解释： 父模型ID。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 modifier 否 String 参数解释： 修改人。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 version 否 String 参数解释： 版本对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/logicalDeleteBranch 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 VersionModelVersionMasterModifierDTO object 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 VersionModelVersionMasterModifierDTO 参数 是否必选 参数类型 描述 masterId 是 String 参数解释： 父模型ID。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 modifier 否 String 参数解释： 修改人。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 version 否 String 参数解释： 版本对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/deleteLatestVersion 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

URI DELETE /v1/{project_id}/{service_type}/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为[1-36]个字符。 默认取值： 不涉及。 service_type 是 String 参数解释： iDME服务的类型。 约束限制： 不涉及。 取值范围： CLOUD_LINKX：公有云基础版数字主线引擎。 默认取值： 不涉及。 instance_id 是 String 参数解释： 待删除的实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应示例 状态码： 200 OK { "result" : "SUCCESS", "data" : [ { "id" : "123", "creator" : "test1", "modifier" : "XDM_Developer xxx", "createTime" : "2023-12-04T11:52:48.000+0000", "lastUpdateTime" : "2023-12-06T06:47:35.183+0000", "rdmVersion" : 4, "rdmDeleteFlag" : 0, "rdmExtensionType" : "PersistableModel", "tenant" : { "id" : "-1", "creator" : "xdmAdmin", "modifier" : "xdmAdmin", "createTime" : "2023-12-01T01:25:21.000+0000", "lastUpdateTime" : "2023-12-01T01:25:21.000+0000", "rdmVersion" : 1, "rdmDeleteFlag" : 0, "rdmExtensionType" : "Tenant", "tenant" : null, "className" : "Tenant", "name" : "basicTenant", "description" : "默认租户", "kiaguid" : null, "securityLevel" : "internal", "nameEn" : null, "code" : "basicTenant", "disableFlag" : false, "dataSource" : "DefaultDataSource" }, "className" : "PersistableModel", "uniqueKey" : "456" } ], "errors" : [ ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 applicationId 否 String 参数解释： 应用ID。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 params 否 Array of PersistableModelUpdateDTO objects 参数解释： 请求参数对象。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表4 PersistableModelUpdateDTO 参数 是否必选 参数类型 描述 createTime 否 String 参数解释： 创建时间。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 creator 否 String 参数解释： 创建者。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 id 否 String 参数解释： 唯一标识。 约束限制： 不涉及。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 lastUpdateTime 否 String 参数解释： 最后更新时间。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 modifier 否 String 参数解释： 更新者。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 needSetNullAttrs 否 Array of strings 参数解释： 将自定义属性（包括基本属性和扩展属性）设置为空值，其长度不能超过1000个字符。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 rdmExtensionType 否 String 参数解释： 扩展类型。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 uniqueKey 否 String 参数解释： 示例模型的唯一键属性。 约束限制： 实例值不能重复。 取值范围： 不涉及。 默认取值： 不涉及。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result String 参数解释： 请求结果。 取值范围： SUCCESS：请求成功。 FAIL：请求失败。 默认取值： 不涉及。 data Array of PersistableModelViewDTO objects 参数解释： 请求数据。 取值范围： 不涉及。 默认取值： 不涉及。 errors Array of strings 参数解释： 异常信息。 取值范围： 不涉及。 默认取值： 不涉及。 表6 PersistableModelViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime Object 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。 uniqueKey String 参数解释： 示例模型中定义的唯一键属性。 取值范围： 不涉及。 默认取值： 不涉及。 表7 TenantViewDTO 参数 参数类型 描述 className String 参数解释： 类名。 取值范围： 不涉及。 默认取值： 不涉及。 code String 参数解释： 租户编码。 取值范围： 不涉及。 默认取值： 不涉及。 createTime String 参数解释： 创建时间。 取值范围： 不涉及。 默认取值： 不涉及。 creator String 参数解释： 创建者。 取值范围： 不涉及。 默认取值： 不涉及。 dataSource String 参数解释： 租户使用的数据源名称。 取值范围： 不涉及。 默认取值： 不涉及。 description String 参数解释： 描述信息。 取值范围： 不涉及。 默认取值： 不涉及。 disableFlag Boolean 参数解释： 失效标识。 取值范围： true：失效。 false：未失效。 默认取值： false。 id String 参数解释： 唯一标识。 取值范围： -9223372036854775808到9223372036854775807的整数。 默认取值： 不涉及。 kiaguid String 参数解释： KIA密级。 取值范围： 不涉及。 默认取值： 不涉及。 lastUpdateTime String 参数解释： 最后更新时间。 取值范围： 不涉及。 默认取值： 不涉及。 modifier String 参数解释： 修改人。 取值范围： 不涉及。 默认取值： 不涉及。 name String 参数解释： 中文名称。 取值范围： 不涉及。 默认取值： 不涉及。 rdmDeleteFlag Integer 参数解释： 软删除标识。 取值范围： 0：表示未删除。 1：表示已删除。 默认取值： 0。 rdmExtensionType String 参数解释： 扩展类型。 取值范围： 不涉及。 默认取值： 不涉及。 rdmVersion Integer 参数解释： 系统版本。 取值范围： 不涉及。 默认取值： 不涉及。 securityLevel String 参数解释： 安全密级。 取值范围： INTERNAL：内部公开。 SECRET：秘密。 CONFIDENTIAL：机密。 TOP_SECRET：绝密。 默认取值： 不涉及。 tenant TenantViewDTO object 参数解释： 租户信息。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchUpdate 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释： 应用唯一标识。 约束限制： 不涉及。 取值范围： 由英文字母和数字组成，且长度为32个字符。 默认取值： 不涉及。 modelName 是 String 参数解释： 数据模型的英文名称。 约束限制： 不涉及。 取值范围： 大写字母开头，只能包含字母、数字、"_"，且长度为[1-60]个字符。 默认取值： 不涉及。

请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_b3f9b7523a6141f4b2d76b92d6595281_app/publicservices/api/PersistableModel/batchUpdate{ "applicationId" : "b3f9b7523a6141f4b2d76b92d6595281", "params" : [ { "id" : "2", "modifier" : "test1", "creator" : "test1", "rdmExtensionType" : "PersistableModel", "uniqueKey" : "批量更新1" }, { "id" : "3", "modifier" : "test1", "creator" : "test1", "rdmExtensionType" : "PersistableModel", "uniqueKey" : "批量更新2" } ]}

操作步骤 获取待部署的应用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-4", "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缓存，避免频繁调用。

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

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写。其中， accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Sdk-Date: 20240416T095341ZAuthorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************{ "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，HTTPS的默认端口为443。 否 当使用AK/SK认证时，该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 Authorization 签名认证信息。 否 当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。 - X-Sdk-Date 请求发送的时间。 否 当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。 - X-Project-ID Project ID，项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d**********aa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Domain-ID 账号ID。 否 AK/SK认证方式下，全局服务的接口调用时，需在请求消息头中携带X-Domain-ID。 - API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于管理员创建IAM用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/jsonX-Sdk-Date: 20240416T095341ZAuthorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

请求URI 请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.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-4.myhuaweicloud.com），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

响应示例 状态码： 200 OK { "code" : 0, "data" : [ { "accountStatus" : "1", "ucn" : "hid_fje4j2nvnue3xwp", "uid" : "hid_fje4j2nvnue3xwp", "uuid" : "1008600000065234815", "account" : "hid_fje4j2nvnue3xwp" } ], "orderID" : "d7f5caecec33476daf614302f13e67bb"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code Integer 参数解释： 接口返回码。 取值范围： 不涉及。 默认取值： 不涉及。 data Array of UserInfoVo objects 参数解释： 接口响应数据。 取值范围： 不涉及。 默认取值： 不涉及。 orderID String 参数解释： 请求跟踪流水号。 取值范围： 不涉及。 默认取值： 不涉及。 表4 UserInfoVo 参数 参数类型 描述 accountStatus String 参数解释： 账号状态。 取值范围： 不涉及。 默认取值： 不涉及。 ucn String 参数解释： 用户名。 取值范围： 不涉及。 默认取值： 不涉及。 uid String 参数解释： 用户ID。 取值范围： 不涉及。 默认取值： 不涉及。 uuid String 参数解释： 用户UUID。 取值范围： 不涉及。 默认取值： 不涉及。 account String 参数解释： 账号名。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/console/servicetask/api/localMethod/assessment_trilogy/completeTask{ "taskId": "2b542501-e206-11ee-b9f9-7804e3968f51", "processInstanceId": "2b263825-e206-11ee-b9f9-7804e3968f51", "internalOperate": "", "variables": { "sequenceFlow": "Flow_02snpia" }, "operation": "Flow_02snpia", "formList": [ {… "attachmentList": []}