object.gdc.goog/v1
包含 Object Storage 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 |
定義 bucket 資源的政策。如未指定，系統會套用預設政策。 |
location 字串 |
定義 bucket 中物件資料的實際儲存位置。如未指定，預設為要建立 bucket 的位置。 |
bucketName 字串 |
已佈建 bucket 的非命名空間名稱。使用本機工具和程式庫時，會用到這個名稱來參照 bucket。 |
zonalEndpoints 字串陣列 |
可存取該水桶的區域 DNS 端點。如需自訂容錯移轉，請使用這些端點。 |
globalEndpoint 字串 |
全域端點，會將流量動態路由至含有這個 bucket 資料的任何區域。如需自動容錯移轉，請使用這個端點。 |
region 字串 |
儲存 bucket 的區域。 |
encryption EncryptionStatus |
值區的加密狀態。 |
allowDegradedWrites boolean |
僅適用於同步處理的 bucket。判斷是否應因其中一個複製區域無法使用，而將 S3 作業還原為非同步複製。這樣一來，即使其中一個複寫區域發生故障，同步處理的 bucket 也不會變成唯讀。如果留空，則預設為 false。 |
BucketInfoStatus
定義 BucketInfo 的觀察狀態。
出現位置： - BucketInfo
| 欄位 | 說明 |
|---|---|
conditions Condition 陣列 |
BucketList
內含 Bucket 清單。
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
object.gdc.goog/v1 |
kind 字串 |
BucketList |
metadata ListMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
items Bucket 陣列 |
BucketPolicy
定義 Bucket 的政策。
顯示位置： - BucketSpec
| 欄位 | 說明 |
|---|---|
lockingPolicy LockingPolicy |
物件鎖定政策。設定後，系統會啟用物件版本管理功能，且儲存在 bucket 中的所有物件都會套用這項政策。鎖定的物件必須等到鎖定到期才能刪除。只能在建立 bucket 時啟用，啟用後無法停用。如果未啟用，物件鎖定和版本管理功能就會停用，且無法啟用。 |
corsPolicy CorsPolicy |
為值區設定自訂 CORS 政策的使用者政策。如要在 bucket 上新增 CORS 政策，必須啟用 CorsPolicy。否則，bucket 只會採用預設的 UI 控制台 CORS 政策。建立 bucket 後，隨時可以新增或修改 CorsPolicy。 |
lifecyclePolicy LifecyclePolicy |
為值區設定自訂生命週期政策的使用者政策。建立 bucket 後，您可以隨時新增、修改或移除 LifecyclePolicy。 |
BucketSpec
BucketSpec 定義 Bucket 資源的所需狀態。
顯示位置： - Bucket
| 欄位 | 說明 |
|---|---|
description 字串 |
值區內容說明。 |
storageClass ObjectStorageClass |
定義資料存取頻率。可用選項包括 Standard 和 Nearline。Standard 適合經常存取的熱資料，例如網站、串流影片和行動應用程式。適用於至少會儲存 30 天的內容。Nearline 適用於至少會儲存 60 天的內容，包括備份資料和長尾型多媒體內容。 |
bucketPolicy BucketPolicy |
定義 bucket 資源的政策。如未指定，系統會套用預設政策。 |
location 字串 |
定義 bucket 中物件資料的實際儲存位置。如未指定，預設為要建立 bucket 的位置。 |
BucketStatus
定義 Bucket 的觀察狀態。
顯示位置： - Bucket
| 欄位 | 說明 |
|---|---|
fullyQualifiedName 字串 |
已佈建的 bucket 名稱。使用外部工具和程式庫時，會用到這個名稱來參照 bucket。 |
conditions Condition 陣列 |
指定 bucket 的狀態。支援的條件包括 BucketReady。如果 BucketReady 為 True，表示值區已佈建完成，可供使用。 |
endpoint 字串 |
可存取該值區的 DNS 端點。 |
region 字串 |
儲存 bucket 的區域。 |
encryption EncryptionStatus |
值區的加密狀態。 |
errorStatus ErrorStatus |
ErrorStatus 會保留最近的錯誤，並包含觀察到的時間。 |
CorsPolicy
定義在 bucket 中設定自訂 CORS 政策的策略。
顯示位置： - BucketPolicy - GlobalBucketPolicy
| 欄位 | 說明 |
|---|---|
enableCorsPolicy boolean |
定義使用者是否要讓自訂政策在 bucket 生效。如果是，系統會讀取 CorsDetail 中定義的自訂政策。否則即使已設定自訂政策，系統也不會使用 CorsDetail。 |
corsDetail CorsRule 陣列 |
設定的自訂 CORS 政策詳細資料。 |
CorsRule
定義與 CORS 規則相關的資訊。
出現位置： - CorsPolicy
| 欄位 | 說明 |
|---|---|
allowedHeaders 字串陣列 |
Access-Control-Request-Headers 標頭中指定的標頭。 |
allowedMethods 字串陣列 |
允許的來源可執行的 HTTP 方法。 |
allowedOrigins 字串陣列 |
可存取 bucket 的來源。 |
exposeHeaders 字串陣列 |
這是指可以存取的回應標頭。 |
id 字串 |
規則的專屬 ID。值不得超過 255 個字元。 |
EncryptionStatus
EncryptionStatus 定義 bucket 的加密狀態。
出現位置： - BucketInfoSpec - BucketStatus
| 欄位 | 說明 |
|---|---|
type EncryptionType |
定義要用於儲存空間的加密類型。可用選項包括：- CMEK - 客戶管理式加密金鑰，可建立以 HSM 為基礎的 KMS 支援金鑰，客戶需支付相關費用。 客戶可以透過 KMS 存取及管理這些金鑰。 |
keyRef ObjectReference |
KeyRef 會參照用來加密值區中物件的預設金鑰。 |
GlobalBucketPolicy
定義 Bucket 的政策。
顯示位置： - BucketInfoSpec
| 欄位 | 說明 |
|---|---|
lockingPolicy LockingPolicy |
物件鎖定政策。設定後，系統會啟用物件版本管理功能，且儲存在 bucket 中的所有物件都會套用這項政策。鎖定的物件必須等到鎖定到期才能刪除。只能在建立 bucket 時啟用，啟用後無法停用。 |
corsPolicy CorsPolicy |
為值區設定自訂 CORS 政策的使用者政策。如要在 bucket 上新增 CORS 政策，必須啟用 CorsPolicy。否則，bucket 只會採用預設的 UI 控制台 CORS 政策。建立 bucket 後，隨時可以新增或修改 CorsPolicy。 |
lifecyclePolicy LifecyclePolicy |
為值區設定自訂生命週期政策的使用者政策。建立 bucket 後，您可以隨時新增、修改或移除 LifecyclePolicy。 |
LifecycleExpiration
出現位置： - LifecycleRule
| 欄位 | 說明 |
|---|---|
date 時間 |
物件的刪除日期。 |
days 整數 |
物件受規則限制的天數。 |
LifecycleNoncurrentExpiration
出現位置： - LifecycleRule
| 欄位 | 說明 |
|---|---|
noncurrentDays 整數 |
物件成為非現行版本後，生命週期規則採取行動前的天數。 |
LifecyclePolicy
顯示位置： - BucketPolicy - GlobalBucketPolicy
| 欄位 | 說明 |
|---|---|
enable boolean |
定義使用者是否要在 bucket 上啟用自訂生命週期政策。 |
lifecycleRules LifecycleRule 陣列 |
包含一或多項生命週期設定規則，可對 bucket 中的物件採取到期動作。 |
LifecycleRule
顯示於： - LifecyclePolicy
| 欄位 | 說明 |
|---|---|
id 字串 |
規則的專屬 ID。值不得超過 255 個字元。 |
status LifecycleRuleStatus |
生命週期規則的狀態。指出這項規則是否會採取行動。狀態隨時可以變更，但只有「已啟用」的規則才會生效。 |
expiration LifecycleExpiration |
現行版本物件的到期行為。請提供「Expiration」或「NoncurrentExpiration」，或兩者皆提供。系統會忽略沒有到期行為的規則。 |
noncurrentExpiration LifecycleNoncurrentExpiration |
非現行物件的到期行為。 |
filter LifecycleRuleFilter |
篩選規則。如果篩選器為空白，表示規則適用於值區中的所有物件。 |
LifecycleRuleFilter
定義可針對生命週期規則設定的篩選器。
出現位置： - LifecycleRule
| 欄位 | 說明 |
|---|---|
prefixFilter 字串 |
比對具有指定前置字串的物件。前置字串為空字串，表示適用於值區中的所有物件。 |
tagFilters 標記陣列 |
比對物件與提供的標記。物件上的標記必須與鍵和值完全相符。 |
LifecycleRuleStatus
基礎類型： string
出現位置： - LifecycleRule
LockingPolicy
定義 Bucket 物件的鎖定策略。
顯示位置： - BucketPolicy - GlobalBucketPolicy
| 欄位 | 說明 |
|---|---|
defaultObjectRetentionDays 整數 |
指定每個物件的每個版本至少要保留的天數。在保留期限內，物件無法刪除。如果 bucket 含有任何物件，也無法刪除。如果未指定，系統不會設定預設物件保留期限。建立後可以修改，但變更只會套用至新物件和版本。現有物件和版本仍會使用先前的值。 |
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 是 Kubernetes Secret 的名稱，其中包含需要輪替的 S3 憑證。Secret 必須與這個 S3CredentialRotationRequest 位於相同命名空間。 |
expirationDelay 時間長度 |
ExpirationDelay 會指定舊的輪替 S3 金鑰在建立新金鑰後，仍保持有效的時間長度。這段期間，用戶端和應用程式可以順利轉換至新憑證。如未指定，預設 Webhook 會將這個值設為 72 小時。如果值為「0 秒」，表示新金鑰啟用後，舊金鑰應立即撤銷。格式為 Go 的 time.ParseDuration 函式可剖析的持續時間字串。例如「72h」、「90m」、「30s」。請注意，系統不支援「d」(天) 等單位。如要進一步瞭解格式，請參閱 https://pkg.go.dev/time#ParseDuration。 |
requestTTL 時間長度 |
RequestTTL 會定義這個 S3CredentialRotationRequest 物件本身的存留時間 (TTL)。憑證輪替完成後 (即 RotationCompleted 狀態條件變成 True 時)，TTL 計時器就會開始計時。經過這段時間後，系統會自動對要求物件執行垃圾收集作業。這項機制會將要求保留為稽核記錄，保留時間可自行設定。如未指定，預設 Webhook 會將此值設為 90 天。格式為 Go 的 time.ParseDuration 函式可剖析的持續時間字串。例如「2160h」(90 天)、「72h」、「30m」。請注意，系統不支援「d」(天) 等單位。如要進一步瞭解格式，請參閱 https://pkg.go.dev/time#ParseDuration。 |
S3CredentialRotationRequestStatus
S3CredentialRotationRequestStatus 定義 S3CredentialRotationRequest 的觀察狀態。 並提供憑證輪替程序的進度和結果意見回饋。
顯示位置： - S3CredentialRotationRequest
| 欄位 | 說明 |
|---|---|
conditions Condition 陣列 |
「條件」代表輪替要求狀態的最新可用觀察結果。並詳細列出輪替程序，包括目前階段和可能發生的任何錯誤。 |
oldKeyRevocationTimestamp 時間 |
OldKeyRevocationTimestamp 是指舊的輪替 S3 金鑰預計從後端儲存系統永久撤銷的時間戳記。計算方式是將 ExpirationDelay 加到 RotationCompleted 條件的 LastTransitionTime。 |
標記
定義生命週期篩選器可使用的物件標記。
顯示位置： - LifecycleRuleFilter
| 欄位 | 說明 |
|---|---|
key 字串 |
|
value 字串 |