# 软删除实例 - ShowLogicalDeleteUsingPost #### 功能介绍 本接口用于根据数据实例的唯一编码（id），对指定数据模型下的单个数据实例执行软删除（逻辑删除）操作。 软删除操作不会从数据库中物理移除数据，而是将实例标记为已删除状态，并转存至XDM应用的XDMLogicDeleteData内置模型中。如需彻底删除数据，请使用[删除实例 - DeleteUsingPost](https://support.huaweicloud.com/api-idme/DeleteUsingPost.html)接口。 在调用本接口前，请确保目标数据模型已满足实例化条件： 1. 已在应用设计态完成数据模型（数据实体或关系实体）的创建与发布。具体操作请参见[创建数据实体](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0007.html)、[创建关系实体](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0022.html)和[应用发布](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0085.html)。 2. 已将对应应用成功部署至运行态。具体操作请参见[部署应用](https://support.huaweicloud.com/consog-idme/idme_consog_0022.html)。 #### 接口约束 - 软删除后，实例的主键ID保持不变，但其状态标记（如rdmDeleteFlag）将被更新，且数据物理行将迁移至XDMLogicDeleteData模型。原业务视图的常规查询将自动过滤该实例。 - 如果目标实例被其他数据实例引用（如作为参考对象），软删除后，引用方的该属性值可能会显示为空或触发级联软删除（具体行为取决于数据模型设计时的级联规则配置）。 - 建议在请求中传入modifier（更新者账号）参数，以便系统完整记录数据变更的审计日志，满足工业合规要求。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/iDMEClassicAPI/doc?api=ShowLogicalDeleteUsingPost)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-idme/idme_api_0017.html)。 #### URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/logicalDelete 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | identifier | 是 | String | **参数解释：** 应用的唯一标识。 - 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。 - 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。 获取方法请参见[获取运行服务清单 - ListEnvs](https://support.huaweicloud.com/api-idme/ListApps.html)。 **约束限制：** 不涉及。 **取值范围：** - 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。 - 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | modelName | 是 | String | **参数解释：** 数据模型的英文名称。 **约束限制：** 不涉及。 **取值范围：** 以大写字母开头，只能包含字母、数字、"_"，且长度为1-60个字符。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** IAM用户的token。 获取方法请参见[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | applicationId | 否 | String | **参数解释：** 应用ID，用于指定实例所属的应用。 当URL路径中已能明确应用上下文时，此参数可不传。 获取方法请参见[获取租户下的应用清单 - ListApps](https://support.huaweicloud.com/api-idme/ListApps.html)。 **约束限制：** 不涉及。 **取值范围：** 由英文字母和数字组成，且长度固定为32个字符。 **默认取值：** 不涉及。 | | params | 是 | [PersistObjectIdModifierDTO] object | **参数解释：** 请求参数对象。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表4PersistObjectIdModifierDTO | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 是 | String | **参数解释：** 数据实例的唯一标识，用于指定待删除的实例。 **约束限制：** 不涉及。 **取值范围：** -9223372036854775808到9223372036854775807的整数。 **默认取值：** 不涉及。 | | modifier | 否 | String | **参数解释：** 更新者账号，用于记录执行删除操作的用户。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释：** 请求处理结果状态。 **取值范围：** - SUCCESS：请求成功。 - FAIL：请求失败。 | | data | Array of longs | **参数解释：** 请求操作影响的数据数量。 **取值范围：** 不涉及。 | | errors | Array of strings | **参数解释：** 异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。 **取值范围：** 不涉及。 | #### 请求示例 **示例：软删除指定ID的单个实例** 对PersistableModel模型中ID为777的数据实例执行软删除操作，操作人为test1。 ``` POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/PersistableModel/logicalDelete { "applicationId" : "04219627d6794f37ae26e8aba250415d", "params" : { "id" : "777", "modifier" : "test1" } } ``` #### 响应示例 **状态码：200** ``` { "result" : "SUCCESS", "data" : [ 1 ], "errors" : [ ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK，表示请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-idme/APIE-XDM-Runtime-ErrorCode.html)。