object.gdc.goog/v1
包含对象存储 v1 API 组的 API 架构定义。
存储桶
定义了 Buckets API 的架构。
来源： - BucketList
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
object.gdc.goog/v1 |
kind 字符串 |
Bucket |
metadata ObjectMeta |
如需了解 metadata 的字段，请参阅 Kubernetes API 文档。 |
spec BucketSpec |
|
status BucketStatus |
BucketInfo
定义 BucketInfo API 的架构。
来源： - BucketInfoList
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
object.gdc.goog/v1 |
kind 字符串 |
BucketInfo |
metadata ObjectMeta |
如需了解 metadata 的字段，请参阅 Kubernetes API 文档。 |
spec BucketInfoSpec |
|
status BucketInfoStatus |
BucketInfoList
包含 BucketInfo 列表。
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
object.gdc.goog/v1 |
kind 字符串 |
BucketInfoList |
metadata ListMeta |
如需了解 metadata 的字段，请参阅 Kubernetes API 文档。 |
items BucketInfo 数组 |
BucketInfoSpec
BucketInfoSpec 定义 BucketInfo 资源的期望状态。
来源： - BucketInfo
| 字段 | 说明 |
|---|---|
description 字符串 |
存储桶内容的说明。 |
storageClass ObjectStorageClass |
定义了需要访问数据的频率。可用选项包括 Standard 和 Nearline。Standard 适合频繁访问的热数据，例如网站、流式视频和移动应用。它适用于可存储至少 30 天的数据。Nearline 适合至少可存储 60 天的数据，包括数据备份和长尾多媒体内容。 |
bucketPolicy GlobalBucketPolicy |
定义存储桶资源的政策。如果未指定，则应用默认政策。 |
location 字符串 |
定义存储桶中的对象数据所在的物理位置。如果未指定，则默认为创建相应存储桶的位置。 |
bucketName 字符串 |
已配置存储桶的非命名空间名称。在本地工具和库中使用时，此变量用于指代相应存储桶。 |
zonalEndpoints 字符串数组 |
存储桶可访问的可用区级 DNS 端点。如果需要自定义故障切换，请使用这些端点。 |
globalEndpoint 字符串 |
全球端点，可将流量动态路由到包含相应存储桶数据的任何可用区。如果需要自动故障切换，请使用此端点。 |
region 字符串 |
存储桶所在的区域。 |
encryption EncryptionStatus |
相应存储桶的加密状态。 |
allowDegradedWrites 布尔值 |
仅用于同步存储分区。确定是否应因某个复制可用区不可用而将 S3 操作恢复为异步复制。这样可以防止同步存储分区在其中一个复制区域出现故障时变为只读。如果为空，则默认为 false。 |
BucketInfoStatus
定义观察到的 BucketInfo 状态。
来源： - BucketInfo
| 字段 | 说明 |
|---|---|
conditions 条件数组 |
BucketList
包含一个 Bucket 列表。
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
object.gdc.goog/v1 |
kind 字符串 |
BucketList |
metadata ListMeta |
如需了解 metadata 的字段，请参阅 Kubernetes API 文档。 |
items 存储分区数组 |
BucketPolicy
定义相应存储分区的政策。
来源： - BucketSpec
| 字段 | 说明 |
|---|---|
lockingPolicy LockingPolicy |
对象锁定政策。如果设置了此属性，则会启用对象版本控制，并且存储桶中存储的所有对象都将受此政策的约束。在锁定过期之前，无法删除已锁定的对象。只能在创建存储桶时启用，之后无法停用。如果未启用，对象锁定和版本控制功能将被停用，并且无法启用。 |
corsPolicy CorsPolicy |
为存储桶设置的自定义 CORS 政策用户的政策。如果需要对存储分区应用额外的 CORS 政策，则必须启用 CorsPolicy。否则，存储桶将仅具有默认的界面控制台 CORS 政策。创建存储桶后，您可以随时添加或修改 CorsPolicy。 |
lifecyclePolicy LifecyclePolicy |
为存储桶设置的自定义生命周期政策的用户政策。创建存储桶后，您可以随时添加、修改或移除 LifecyclePolicy。 |
BucketSpec
BucketSpec 定义了 Bucket 资源的期望状态。
来源： - 存储分区
| 字段 | 说明 |
|---|---|
description 字符串 |
存储桶内容的说明。 |
storageClass ObjectStorageClass |
定义了需要访问数据的频率。可用选项包括 Standard 和 Nearline。Standard 适合频繁访问的热数据，例如网站、流式视频和移动应用。它适用于可存储至少 30 天的数据。Nearline 适合至少可存储 60 天的数据，包括数据备份和长尾多媒体内容。 |
bucketPolicy BucketPolicy |
定义存储桶资源的政策。如果未指定，则应用默认政策。 |
location 字符串 |
定义存储桶中的对象数据所在的物理位置。如果未指定，则默认为创建相应存储桶的位置。 |
BucketStatus
定义观察到的 Bucket 状态。
来源： - 存储分区
| 字段 | 说明 |
|---|---|
fullyQualifiedName 字符串 |
已预配存储桶的名称。在使用外部工具和库时，此名称用于指代相应存储桶。 |
conditions 条件数组 |
指定相应存储桶的状态。支持的条件包括 BucketReady。如果 BucketReady 为 True，则表示相应存储桶已完成配置，可以开始使用。 |
endpoint 字符串 |
存储桶可访问的 DNS 端点。 |
region 字符串 |
存储桶所在的区域。 |
encryption EncryptionStatus |
相应存储桶的加密状态。 |
errorStatus ErrorStatus |
ErrorStatus 包含最近的错误，并附带观测时间。 |
CorsPolicy
定义在存储桶上设置自定义 CORS 政策的策略。
来源： - BucketPolicy - GlobalBucketPolicy
| 字段 | 说明 |
|---|---|
enableCorsPolicy 布尔值 |
定义用户是否希望自定义政策在存储桶上生效。如果为 true，系统将读取在 CorsDetail 中定义的自定义政策。否则，即使设置了自定义政策，也不会使用 CorsDetail。 |
corsDetail CorsRule 数组 |
正在设置的自定义 CORS 政策的详细信息。 |
CorsRule
定义与 CORS 规则相关的信息。
来源： - CorsPolicy
| 字段 | 说明 |
|---|---|
allowedHeaders 字符串数组 |
Access-Control-Request-Headers 标头中指定的标头。 |
allowedMethods 字符串数组 |
允许的来源可以执行的 HTTP 方法。 |
allowedOrigins 字符串数组 |
可访问相应存储桶的来源。 |
exposeHeaders 字符串数组 |
响应中可访问的标头。 |
id 字符串 |
规则的唯一标识符。值不得超过 255 个字符。 |
EncryptionStatus
EncryptionStatus 定义了相应存储桶的加密状态。
显示在： - BucketInfoSpec - BucketStatus
| 字段 | 说明 |
|---|---|
type EncryptionType |
定义要用于相应存储桶的加密类型。可用的选项包括：- CMEK - 客户管理的加密密钥，用于创建以 HSM 为根的 KMS 支持的密钥，客户需要为此付费。 客户可以通过 KMS 访问和管理这些密钥。 |
keyRef ObjectReference |
KeyRef 引用用作默认密钥的密钥，以加密存储桶中的对象。 |
GlobalBucketPolicy
定义相应存储分区的政策。
来源： - BucketInfoSpec
| 字段 | 说明 |
|---|---|
lockingPolicy LockingPolicy |
对象锁定政策。如果设置了此属性，则会启用对象版本控制，并且存储桶中存储的所有对象都将受此政策的约束。在锁定过期之前，无法删除已锁定的对象。只能在创建存储桶时启用，之后无法停用。 |
corsPolicy CorsPolicy |
为存储桶设置的自定义 CORS 政策用户的政策。如果需要对存储分区应用额外的 CORS 政策，则必须启用 CorsPolicy。否则，存储桶将仅具有默认的界面控制台 CORS 政策。创建存储桶后，您可以随时添加或修改 CorsPolicy。 |
lifecyclePolicy LifecyclePolicy |
为存储桶设置的自定义生命周期政策的用户政策。创建存储桶后，您可以随时添加、修改或移除 LifecyclePolicy。 |
LifecycleExpiration
来源： - LifecycleRule
| 字段 | 说明 |
|---|---|
date 时间 |
应删除对象的具体日期。 |
days 整数 |
相应对象受规则约束的天数。 |
LifecycleNoncurrentExpiration
来源： - LifecycleRule
| 字段 | 说明 |
|---|---|
noncurrentDays 整数 |
对象成为非当前版本后，生命周期规则开始执行操作之前的天数。 |
LifecyclePolicy
来源： - BucketPolicy - GlobalBucketPolicy
| 字段 | 说明 |
|---|---|
enable 布尔值 |
定义用户是否希望在存储桶上启用自定义生命周期政策。 |
lifecycleRules LifecycleRule 数组 |
包含一条或多条生命周期配置规则，这些规则可以对存储桶中的对象执行过期操作。 |
LifecycleRule
来源： - LifecyclePolicy
| 字段 | 说明 |
|---|---|
id 字符串 |
规则的唯一标识符。值不能超过 255 个字符。 |
status LifecycleRuleStatus |
生命周期规则的状态。指明此规则是否会采取行动。状态可以随时更改，但只有“已启用”的规则才会生效。 |
expiration LifecycleExpiration |
当前版本中对象的过期行为。应提供 Expiration 和/或 NoncurrentExpiration。没有过期行为的规则会被忽略。 |
noncurrentExpiration LifecycleNoncurrentExpiration |
非当前对象的过期行为。 |
filter LifecycleRuleFilter |
规则的过滤条件。空过滤器表示相应规则适用于存储桶中的所有对象。 |
LifecycleRuleFilter
定义可针对生命周期规则设置的过滤条件。
来源： - LifecycleRule
| 字段 | 说明 |
|---|---|
prefixFilter 字符串 |
匹配具有指定前缀的对象。空字符串前缀表示应用于存储桶中的所有对象。 |
tagFilters 标记数组 |
匹配具有所提供标记的对象。对象上的标记必须与键和值完全匹配。 |
LifecycleRuleStatus
基础类型： string
来源： - LifecycleRule
LockingPolicy
定义锁定相应存储分区的对象所用的策略。
来源： - BucketPolicy - GlobalBucketPolicy
| 字段 | 说明 |
|---|---|
defaultObjectRetentionDays 整数 |
指定每个对象的所有版本将保留的最短天数。在保留期限内，无法删除对象。如果存储桶包含任何对象，也无法删除。如果未指定，则不会设置默认的对象保留期限。可以在创建后修改，但更改只会对新对象和版本生效。现有对象和版本仍将使用之前的值。 |
S3CredentialRotationRequest
S3CredentialRotationRequest 是 S3CredentialRotationRequests API 的架构
来源： - S3CredentialRotationRequestList
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
object.gdc.goog/v1 |
kind 字符串 |
S3CredentialRotationRequest |
metadata ObjectMeta |
如需了解 metadata 的字段，请参阅 Kubernetes API 文档。 |
spec S3CredentialRotationRequestSpec |
|
status S3CredentialRotationRequestStatus |
S3CredentialRotationRequestList
S3CredentialRotationRequestList 包含 S3CredentialRotationRequest 的列表
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
object.gdc.goog/v1 |
kind 字符串 |
S3CredentialRotationRequestList |
metadata ListMeta |
如需了解 metadata 的字段，请参阅 Kubernetes API 文档。 |
items S3CredentialRotationRequest 数组 |
S3CredentialRotationRequestSpec
S3CredentialRotationRequestSpec 定义 S3CredentialRotationRequest 的所需状态。 此规范用于启动存储在 Kubernetes Secret 中的 S3 凭据的轮换。
来源： - S3CredentialRotationRequest
| 字段 | 说明 |
|---|---|
secretName 字符串 |
SecretName 是包含需要轮换的 S3 凭据的 Kubernetes Secret 的名称。Secret 必须与此 S3CredentialRotationRequest 位于同一命名空间中。 |
expirationDelay 时长 |
ExpirationDelay 指定了在创建新密钥后，轮替后的旧 S3 密钥将保持有效的时间。这样，客户端和应用就可以在宽限期内顺利切换到新凭据。如果未指定，则此值会由默认设置 Webhook 默认设置为 72 小时。值为“0s”表示应在新密钥激活后立即撤消旧密钥。格式是可由 Go 的 time.ParseDuration 函数解析的时长字符串。例如，“72h”“90m”“30s”。请注意，系统不支持“d”（天）等单位。如需详细了解此格式，请参阅 https://pkg.go.dev/time#ParseDuration。 |
requestTTL 时长 |
RequestTTL 用于定义相应 S3CredentialRotationRequest 对象本身的存留时间 (TTL)。TTL 计时器会在凭据轮替完成后（即 RotationCompleted 状态条件变为 True 时）开始计时。在此时长过后，系统会自动对请求对象进行垃圾回收。此机制会将请求保留为审核记录，保留期限可配置。如果未指定，此值将由默认 webhook 默认设置为 90 天。格式是可由 Go 的 time.ParseDuration 函数解析的时长字符串。例如，“2160h”（90 天）、“72h”“30m”。请注意，系统不支持“d”（天）等单位。如需详细了解此格式，请参阅 https://pkg.go.dev/time#ParseDuration。 |
S3CredentialRotationRequestStatus
S3CredentialRotationRequestStatus 定义了 S3CredentialRotationRequest 的观测状态。 它会针对凭据轮替流程的进度和结果提供反馈。
来源： - S3CredentialRotationRequest
| 字段 | 说明 |
|---|---|
conditions 条件数组 |
Conditions 表示轮换请求状态的最新可用观测结果。它详细介绍了轮换流程，包括当前阶段和可能发生的任何错误。 |
oldKeyRevocationTimestamp 时间 |
OldKeyRevocationTimestamp 是指旧的轮换 S3 密钥计划从后端存储系统永久撤消的时间戳。此时间是通过将 ExpirationDelay 添加到 RotationCompleted 条件的 LastTransitionTime 来计算的。 |
标记
定义生命周期过滤条件可使用的对象的标记。
来源： - LifecycleRuleFilter
| 字段 | 说明 |
|---|---|
key 字符串 |
|
value 字符串 |