ECS：ECS 中的 CAS 保留

ECS 中的 CAS 保留

CAS C-Clip 具有保留期，可用于控制保留时长。在应用程序可删除关联对象之前，关联对象会保留在 ECS 存储中。


保留期

保留期由 CAS 应用程序在 C-Clip 中为对象指定。

例如，如果财务文档必须自创建之日起保留三年，
您可在与财务文档关联的 C-Clip 中指定三年保留期。此外，
还可以指定无限期保留文档。

保留策略（保留类别）

提醒：Centera 的保留类别概念可映射到 ECS 中的保留策略，
本文档将会使用保留策略。

保留策略使保留应用场景能够被捕获并应用于 C-Clip。例如，
不同类型的文档可能具有不同的保留期。您可能需要
以下保留期：

• 财务：3年
• 法律：5 年
• 电子邮件：6 个月

在您将保留策略应用于多个 C-Clip 后，通过更改策略，
该策略所应用于的所有对象的保留期都会改变。

在 ECS 中，保留策略与命名空间相关联，
并被 CAS 应用程序识别为保留类别。
 

ECS 存储桶级别的保留和 CAS

存储桶级别的保留不是 Centera 中默认的池保留。在 ECS 中，CAS 默认保留
一直为零。
 

写入合规性命名空间中的无对象级别保留的对象中的
默认保留期。

从 ECS 3.0 开始，当应用程序将无对象保留的 C-Clip 写入到合规性命名空间中的 ECS CAS 存储桶
且存储桶具有保留值（例如 6 个月）时，
默认无限保留期 (-1) 将被指定给 C-Clip。绝不会
删除 C-Clip，因为其有效保留期是以下二者之间的最大值：
存储桶级别保留期和默认对象级别保留。
 

CAS 优先级

当 ECS 中的 CAS 对象应用了多个保留期时，无论保留期是如何应用的，
值较大的保留期将会优先采用。
 

如何应用 CAS 保留

您可以在 ECS 门户中为命名空间定义保留策略，
也可以使用 ECS 管理 API 来定义这些保留策略。请参阅设置命名空间保留策略。

外部 CAS 应用程序可以在 C-Clip 创建期间
为其指定固定保留期或保留策略。

通过 API 应用保留期时，请指定以秒为单位的期间。

提醒：对于所有与保留相关的计算，
ECS CAS 采用 C-Clip 的创建时间（而非迁移时间）。

如何使用 ECS 管理 API 创建保留策略。

您可以使用 ECS 创建保留期和策略，
其相关摘要在下面提供。

方法	描述
PUT /object/bucket/{bucketName}/retention	存储桶的保留值定义了 要应用于存储桶中每个对象的 强制性保留期。如果设置的保留期为 1 年， 则一年内无法删除存储桶中的对象。
GET /object/bucket/{bucketName}/retention	返回当前为指定存储桶设置的 保留期。
POST /object/namespaces/namespace/{namespace}/ retention	对于命名空间，保留设置的作用类似于策略， 其中每个策略都是一个<名称>:<保留期>对。 您可以为命名空间定义多个保留策略， 并且可以按名称 将策略指定给命名空间中的对象。这使您可以通过更改 相应的策略来改变 已指定相同策略的 一组对象的保留期。
PUT /object/namespaces/namespace/{namespace}/ retention/{class}	更新与命名空间关联的 保留期的期间。
GET /object/namespaces/namespace/{namespace}/ retention	返回为命名空间定义的保留策略。

您可以在《ECS 数据访问指南》中的 ECS 管理 REST API 简介中
找到有关 ECS 管理 API 的更多信息。这里是在线参考：ECS API 参考。

CAS 应用程序的高级保留：基于事件的保留、诉讼保留和最短/最长调控器

介绍了 CAS API 中提供的受 ECS 支持的高级保留功能。

客户应用程序可使用 CAS API 来启用保留策略。当 CAS 工作负载迁移到 ECS 时，
ECS 对 CAS API 功能的感知允许客户应用程序
继续使用迁移的数据。在 ECS 中，以下高级保留管理 (ARM) 功能
无需单独许可证即可使用：

• 基于事件的保留：在 CAS 应用程序接收到指定事件时，
  通过对象的 C-Clip 配置对象以应用（触发）保留期或保留策略的能力。
• 诉讼保留：在 CAS 应用程序通过对象的 C-Clip 将诉讼保留
  应用于对象时可防止删除对象的能力。通过创建和应用唯一的诉讼保留 ID，CAS 应用程序
  可向一个对象应用多达 100 个诉讼保留。
• 最短/最长调控器：管理员为固定保留期或可变保留期
  设置存储桶级别限制的能力。可变保留期是为支持基于事件的保留
  而设置的保留期。在 ECS 中，系统或命名空间管理员可以使用 ECS 门户
  来设置数值。程序员可以使用 ECS 管理 API 来设置数值。

提醒：对于使用任何迁移到 ECS 的命名方案写入的传统 CAS 数据，
ARM 都受支持。

CAS 存储桶级别的保留的最短/最长调控器

从 ECS 门户中，找到 CAS 存储桶并选择 Edit。除了存储桶保留期功能之外，
以下屏幕上显示的所有功能均为仅限 CAS 功能。存储桶保留
期是所有 ECS 存储桶类型都支持的标准 ECS 存储桶保留功能。

下表说明了 CAS 存储桶保留功能。
 

功能	描述
强制保留	如果开启此功能，则无法在没有保留信息 （期限或策略）的情况下创建任何 CAS 对象。尝试保存此类对象会返回错误。如果开启它， 那么即使在启用合规性的环境中， 也可能无法配置存储桶保留期。 提醒：将 CE+ 模式的 Centera 迁移到 ECS 时， 默认情况下会在存储桶上开启强制保留。
存储桶 保留期	如果指定了存储桶保留期，那么在同时存在存储桶级别保留期和对象级别保留期的情况下， 将会强制执行较长的保留期。在启用合规性的环境中， 除非强制执行对象中的保留信息， 否则存储桶保留期是必填项。但是，一旦配置存储桶保留期，即使强制执行对象中的保留信息， 也无法重置存储桶保留期。
最短的固定 保留期	此功能控制在对象中指定的保留期。如果对象的保留期超出此处指定的范围， 则写入对象的尝试将失败。使用保留策略时，不会强制执行最短/最长设置。为最短的固定保留期选择 Infinite 意味着 所有保留值都必须是无限的。为最长的固定保留期选择“if” 意味着没有最长期间限制。最短/最长保留约束 将应用于写入存储桶的任何 C-Clip。如果 Clip 由任何基于 SDK 的第三方工具 进行迁移，则保留期应该在一定范围内， 否则会出错。
最长的固定 保留期
最短的可变 保留期	此功能控制使用基于事件的 保留 (EBR) 在对象中指定的可变保留期。在 EBR 中，您设置了基本保留期，当触发器触发时，设定的触发器功能 可延长保留期。如果对象的新保留期 超出此处指定的范围，则写入对象 以响应触发器的尝试将失败。使用保留策略时，不会 强制执行最短/最长设置。为最短的可变保留期选择 Infinite 意味着 所有保留值都必须是无限的。为最长的可变保留期选择“if” 意味着没有最长期间限制。最短/最长保留约束 将应用于写入存储桶的任何 C-Clip。如果 Clip 由任何基于 SDK 的第三方工具 进行迁移，则保留期应该在一定范围内，否则会出错。
最长的可变 保留期

提醒：如果系统管理员或程序员没有为固定和可变保留期设置任何值，
ECS 管理 API 的 get 函数将不会为最短/最长设置
返回任何值。强制执行 C-Clip 中的保留信息将返回
默认值 false。
 

基于事件的保留

基于事件的保留 (EBR) 是一条指令，
规定在事件发生前和事件发生后的指定时间段内不能删除记录。在 CAS 中，EBR 是一个 C-Clip，具有指定的基本保留期或保留策略
以及应用程序定义的触发器，
在触发器触发时可设置更长的保留期。保留期仅在触发器触发时才开始。
当 C-Clip 被标记为 EBR 时，除非您使用特权删除
，否则无法在事件发生前将其删除。

使用 EBR 时，C-Clip 生命周期如下所示：

• 创建：应用程序创建新的 C-Clip，并将其标记为处于 EBR 状态下。应用程序
  可以提供某个固定保留期来充当最短保留期，
  并且它必须提供基于事件的保留期或策略。
• 触发事件：应用程序会触发事件，这是基于事件的
  保留期或保留策略的起点。如果新的基于事件的保留期比创建 C-Clip 时
  指定的保留期更长，应用程序可以指定
  此新的保留期。
• 删除：当应用程序尝试删除 C-Clip 时，以下条件必须得到满足：
  策略（命名空间）保留已过期
  存储桶保留已过期
  固定保留已过期
  事件已触发
  创建时设置的 EBR 和事件发生时的任何后续更改（扩展）均已过期

下图显示了处于 EBR 状态下的 C-Clip 的三种可能情况：

• C1 具有固定或最短保留期，在事件触发之前已经过期。
• C2 具有固定或最短保留期，将在 EBR 过期之前过期。
• C3 具有固定或最短保留期，将在 EBR 过期之后过期。

 

对于不合规的命名空间，特权删除命令
可以覆盖 EBR 的固定和可变保留期。

在应用 EBR 保留时，它必须符合
可变保留期的最短/最长调控器设置。

下表显示了适用于基于事件的保留的 CAS API 函数

函数	描述
FPClip_EnableEBRWithClass	此函数将 C-Clip 设置为有资格接收未来事件， 并使基于事件的保留 (EBR) 类别 能够在 C-Clip 创建时指定给 C-Clip。
FPClip_EnableEBRWithPeriod	此函数将 C-Clip 设置为有资格接收未来事件， 并使基于事件的保留 (EBR) 期间 能够在 C-Clip 创建时指定给 C-Clip。
FPClip_IsEBREnabled	此函数会返回布尔值，以指示是否为基于事件的保留 (EBR) 启用了 C-Clip 。
FPClip_GetEBRClassName	此函数会检索已指定给 C-Clip 的基于事件的保留 (EBR) 策略的名称。
FPClip_GetEBREventTime	当触发该 C-Clip 的基于事件的保留 (EBR) 事件时， 此函数会返回在 C-Clip 上设置的事件时间。
FPClip_GetEBRPeriod	此函数会返回与 C-Clip 关联的 基于事件的保留 (EBR) 期间的值（以秒为单位）。
FPClip_TriggerEBREvent	此函数会触发启用了 基于事件的保留 (EBR) 的 C-Clip 事件。
FPClip_TriggerEBREventWithClass	此函数会触发启用了基于事件的保留 (EBR) 的 C-Clip 事件， 并将新的 EBR 策略指定给 C-Clip。
FPClip_TriggerEBREventWithPeriod	此函数会触发启用了基于事件的保留 (EBR) 的 C-Clip 事件， 并将新的 EBR 期间指定给 C-Clip。

 

 

诉讼保留

诉讼保留允许 CAS 应用程序暂时阻止 C-Clip 的删除。对于受到官方调查、传票传唤出庭作证或查询的数据
以及在调查结束之前不得删除的数据，
诉讼保留非常有用。一旦不需要保留数据，应用程序就可以解除诉讼保留，
恢复正常的保留行为。CAS 应用程序
可在 C-Clip 级别实施和删除诉讼保留。

提醒：即使是特权删除也无法删除处于诉讼保留状态下的 C-Clip。

一个 C-Clip 可能会处于多个诉讼保留状态下。应用程序必须生成唯一的诉讼保留 ID，
并能够跟踪与 C-Clip 关联的特定诉讼保留。应用程序
无法向 C-Clip 查询此信息。只有一个函数可确定 C-Clip 的诉讼
保留状态。如果 C-Clip 上存在一个或多个诉讼保留，
则此函数将返回 true，否则会返回 false。

使用诉讼保留时，C-Clip 生命周期如下所示：

• 创建：应用程序创建新的 C-Clip，
  并提供固定和/或基于事件的保留期。
• 设置诉讼保留：应用程序将 C-Clip 置于保留状态。此应用程序可能
  与写入 C-Clip 的应用程序不同。
• 解除诉讼保留：应用程序解除 C-Clip 的保留状态。此应用程序可能
  与设置诉讼保留或写入 C-Clip 的应用程序不同。
• 删除：当应用程序尝试删除 C-Clip 时，以下条件必须得到满足：
  C-Clip 上没有其他未完成的诉讼保留。
  策略保留已过期。
  标准存储桶保留已过期。（标准存储桶保留适用于所有 ECS 对象类型，但不推荐用于 CAS。）
  固定保留期已过期（仅限 CAS 功能）。
  基于事件的保留已过期（仅限 CAS 功能）。

下图显示了置于诉讼保留状态下的 C-Clip 的三种可能情况：

• C1 具有固定保留期，在置于保留状态下时已过期。
• C2 具有固定保留期，在保留期间过期。
• C3 具有固定保留期，将在解除保留后过期。

您可为一个 C-Clip 指定多个诉讼保留。如果是这种情况，每个诉讼保留
都需要单独的 API 调用，并为诉讼保留提供唯一的标识符。

提醒：诉讼保留 ID 的最大大小为 64 个字符。每个 C-Clip 的
最大诉讼保留 ID 数为 100。这些限制由 CAS API 强制执行。

下表显示了适用于诉讼保留的 CAS API 函数
 

函数	描述
FPClip_GetRetentionHold	此函数会确定 C-Clip 的保留状态， 并返回 true 或 false。
FPClip_SetRetentionHold	此函数可为 C-Clip 保留设置或重置保留状态。对于多个诉讼保留， 为每个保留提供 唯一的诉讼保留 ID。对于多个保留，请为每个 ID 执行一次调用。

《ECS 数据访问指南》中详细介绍了下面与 CAS 相关的主题，并且这些主题将分成不同的知识库文章：

• ECS：在 ECS 中设置 CAS 支持 - 知识库文章 538783
  • 在 ECS 中设置 CAS 支持
  • 冷存储
• ECS：CAS 的合规性 - 知识库文章 538784
  • 平台强化与合规性
  • 合规性与保留策略
  • 合规性代理程序
• ECS：ECS 中的 CAS 保留 - 知识库文章 538782
  • CAS 保留
  • CAS 应用程序的高级保留：基于事件的保留、诉讼保留和最短/最长调控器
• ECS：为 CAS 设置命名空间保留策略 - 知识库文章 538786
• ECS：CAS 用户和存储桶管理最佳实践 - 知识库文章 478327
  • 为 CAS 用户创建和设置存储桶
  • 设置 CAS 对象用户
• ECS：为 CAS 设置存储桶 ACL - 知识库文章 538789
• ECS：支持 CAS 用户的 ECS 管理 API - 知识库文章 538790
• ECS：内容可寻址存储 (CAS) SDK API 支持 - 知识库文章 538791
• ECS：CAS (Centera) SDK 错误代码 - 知识库文章 427034