# 删除数据 V2-RunDeleteData #### 功能介绍 删除指定服务实例中的对应数据，支持指定ID删除和条件删除。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ImageSearch/doc?api=RunDeleteData)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI POST /v2/{project_id}/mms/{service_name}/data/delete 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 用户的项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-imagesearch/imagesearch_02_0035.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 不涉及。 | | service_name | 是 | String | **参数解释：** 服务实例的名称，用户创建服务实例时设置的实例名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | force | 否 | Boolean | **参数解释：** 是否幂等删除数据。 **约束限制：** 仅对指定ID删除生效。 **取值范围：** - false: 数据不存在时返回错误信息。 - true: 数据不存在时返回成功，用于幂等删除场景。 **默认取值：** 默认为false。 | | item_id | 否 | String | **参数解释：** 数据的服务实例级唯一标识。 **约束限制：** - item_id/custom_tags/custom_num_tags中必须给定至少一个参数，以支持对服务实例中的数据进行指定ID删除或条件删除。 - 如给定item_id参数，则进行指定ID删除，否则进行条件删除。 **取值范围：** 字符长度范围为\[1, 256\]。 **默认取值：** 不涉及。 | | custom_tags | 否 | Map\\> | **参数解释：** 自定义字符标签，用于对服务实例中的数据进行条件删除。格式为键值对{key:value}。 **约束限制：** - key: 必须为服务实例custom_tags中已存在的key，可在创建服务实例时进行配置，或在更新服务实例时进行新增。 - value: 标签值列表，列表内多个标签值为"或"关系，即满足一个即可。 **取值范围：** value: 列表长度范围为\[1, 32\]，标签值类型为字符串，字符长度范围为\[1, 64\]。 **默认取值：** 不涉及。 | | custom_num_tags | 否 | Map\ | **参数解释：** 自定义数值标签，用于对服务实例中的数据进行custom_num_tags条件删除。格式为键值对{key:value}。 **约束限制：** - key: 必须为服务实例custom_num_tags中已存在的key，可在创建服务实例时进行配置，或在更新服务实例时进行新增。针对没有设置该数值标签的数据，会直接过滤。 - value: 标签值的取值范围，标签值在给定的取值范围内即视为符合条件。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3RangeParam | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | from | 否 | Double | **参数解释：** 数值下界，默认包含该下界。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | to | 否 | Double | **参数解释：** 数值上界，默认包含该上界。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释：** 删除数据完成返回success。 **取值范围：** 不涉及。 | | data | [DeleteRestInfo] object | **参数解释：** 删除数据的相关信息，仅在条件删除时存在该字段。 **取值范围：** 不涉及。 | 表5DeleteRestInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | items | Array of [items] objects | **参数解释：** 删除数据列表。 **取值范围：** 不涉及。 | | delete_info | [DeleteInfo] object | **参数解释：** 删除结果的相关信息。 **取值范围：** 不涉及。 | 表6items | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 数据唯一ID。 **取值范围：** 不涉及。 | 表7DeleteInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | **参数解释：** 符合条件的结果总数。 **取值范围：** 不涉及。 | | delete_num | Integer | **参数解释：** 本次删除的结果总数，目前一次请求最多删除100条结果。 **取值范围：** 不涉及。 | **状态码： 400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 调用失败时的错误码，具体请参见[错误码](https://support.huaweicloud.com/api-imagesearch/imagesearch_02_0043.html)。 调用成功时无此字段。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败时的错误信息。 调用成功时无此字段。 **取值范围：** 不涉及。 | #### 请求示例 删除数据 ``` POST https://{endpoint}/v2/{project_id}/mms/{service_name}/data/delete { "item_id" : "electronics_01" } ``` #### 响应示例 **状态码： 200** 成功响应示例 ``` { "result" : "success" } ``` **状态码： 400** 失败响应示例 ``` { "error_code" : "MMS.0003", "error_msg" : "Invalid parameter: item_id" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功响应示例。 | | 400 | 失败响应示例。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-imagesearch/imagesearch_02_0043.html)。