Method: projects.locations.identityMappingStores.purgeIdentityMappings

从身份映射存储区中清除指定的身份映射条目或所有身份映射条目。

HTTP 请求

POST https://discoveryengine.googleapis.com/v1beta/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:purgeIdentityMappings

网址采用 gRPC 转码语法。

路径参数

参数
identityMappingStore

string

必需。要从中清除身份映射条目的身份映射存储区的名称。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "filter": string,

  // Union field source can be only one of the following:
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
  "force": boolean
}
字段
filter

string

过滤要清除的匹配身份映射。可用于过滤的字段包括：* updateTime：采用 ISO 8601“zulu”格式。* externalId

示例：

  • 删除在某个时间范围内更新的所有身份映射：updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • 正在删除指定 externalId 的所有身份映射：externalId = "id1"
  • 删除身份映射存储区中的所有身份映射：*

过滤字段之间采用隐式 AND 关系。不应与来源一起使用。如果同时提供这两个参数，则会抛出错误。
联合字段 source。输入的来源。source 只能是下列其中一项：
inlineSource

object (InlineSource)

要从中清除身份映射条目的内嵌来源。
force

boolean

实际执行清除操作。如果 force 设置为 false，则返回预期的完全清除计数，但不删除任何身份映射。此字段仅支持使用过滤条件进行清除。对于输入源，系统会忽略此字段，并清除数据，无论此字段的值为何。

响应正文

如果成功，则响应正文包含一个 Operation 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 identityMappingStore 资源的以下 IAM 权限：

  • discoveryengine.identityMappingStores.purgeIdentityMappings

如需了解详情，请参阅 IAM 文档。

InlineSource

要从中清除身份映射条目的内嵌来源。

JSON 表示法 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ]
}
字段
identityMappingEntries[]

object (IdentityMappingEntry)

一次最多可清除 10,000 个条目