批量删除实例 - BatchDeleteUsingPost
功能介绍
本接口用于根据数据实例的唯一编码(id)列表,批量删除指定数据模型中的多个数据实例。
删除操作不可逆,实例删除后将无法恢复。请在调用前务必确认目标实例ID列表,谨慎操作。
在调用本接口前,请确保目标数据模型已满足实例化条件:
接口约束
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /rdm_{identifier}_app/publicservices/api/{modelName}/batchDelete
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| identifier | 是 | String | 参数解释: 应用的唯一标识。 获取方法请参见获取运行服务清单 - ListEnvs。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| modelName | 是 | String | 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 以大写字母开头,只能包含字母、数字、“_”,且长度为1-60个字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| applicationId | 否 | String | 参数解释: 应用ID,用于指定实例所属的应用。 当URL路径中已能明确应用上下文时,此参数可不传。 获取方法请参见获取租户下的应用清单 - ListApps。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| params | 是 | PersistObjectIdsModifierDTO object | 参数解释: 请求参数对象,包含待失效的实例ID列表及操作人信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ids | 是 | Array of strings | 参数解释: 数据实例ID列表,用于指定待删除的多个实例。 获取方法请参见分页查询实例 - ShowFindUsingPost。 约束限制: 单次请求不超过1000个。 取值范围: -9223372036854775808到9223372036854775807的整数。 默认取值: 不涉及。 |
| modifier | 否 | String | 参数解释: 更新者账号,用于记录执行删除操作的用户。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
请求示例
示例:批量删除多个实例(指定操作人)
删除PersistableModel模型中ID为777和888的两个数据实例,操作人为test1。
POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/PersistableModel/batchDelete
{
"applicationId" : "04219627d6794f37ae26e8aba250415d",
"params" : {
"ids" : [ "777", "888" ],
"modifier" : "test1"
}
} 响应示例
状态码:200
OK,表示请求成功。
{
"result" : "SUCCESS",
"data" : [ 2 ],
"errors" : [ ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK,表示请求成功。 |
错误码
请参见错误码。