# 批量删除结构化文档分享权限 - BatchDeleteShareDocs #### 功能介绍 本接口用于批量删除结构化文档的分享权限记录，撤销已共享文档的访问权限。当项目结束、人员岗位变动或文档权限需要回收时，可调用本接口一次性撤销多个用户的文档分享权限。 - 调用本接口时，需在ids中传入待删除的分享权限记录ID列表，系统将对列表中的分享记录执行批量删除。 - 分享权限删除后，被分享用户将无法再通过原分享渠道访问该文档。 #### 接口约束 - 目标数据模型已在应用设计态配置了"结构化文档管理"功能。 - 待删除的分享权限记录必须已存在。 - 当前用户需具备删除目标分享权限的权限。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/iDMEClassicAPI/doc?api=BatchDeleteShareDocs)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-idme/idme_api_0017.html)。 #### URI DELETE /rdm_{identifier}_app/publicservices/api/{modelName}/structured-doc/share-doc/batch 表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)。 **约束限制：** 不涉及。 **取值范围：** - 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。 - 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | params | 是 | [DeleteDocParamDto] object | **参数解释：** 批量删除请求参数对象，包含待删除分享权限记录的文档ID列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表4DeleteDocParamDto | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ids | 是 | Array of strings | **参数解释：** 待删除分享权限记录的ID集合。可以通过接口"查询结构化文档分享授权列表"的StructuredDocShareViewDTO.id进行获取。 **约束限制：** 不涉及。 **取值范围：** -9223372036854775808到9223372036854775807的整数。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释：** 请求处理结果状态。 **取值范围：** - SUCCESS：请求成功。 - FAIL：请求失败。 | | data | Array of integers | **参数解释：** 请求数据，返回本次操作影响的记录数。 **取值范围：** 不涉及。 | | errors | Array of strings | **参数解释：** 异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。 **取值范围：** 不涉及。 | #### 请求示例 **示例：批量删除结构化文档分享权限** 批量删除分享权限记录ID为721366695490363392的结构化文档分享权限。 ``` DELETE https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/StructuredDocableModel/structured-doc/share-doc/batch { "params" : { "ids" : [ "721366695490363392" ] } } ``` #### 响应示例 **状态码：200** OK，表示请求成功。 ``` { "result" : "SUCCESS", "data" : [ ], "errors" : [ ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK，表示请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-idme/APIE-XDM-Runtime-ErrorCode.html)。