KRM API オブジェクト object.gdc.goog/v1

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 バケット リソースのポリシーを定義します。指定しない場合、デフォルトのポリシーが適用されます。
location 文字列 バケット内のオブジェクト データが存在する物理的な場所を定義します。指定しない場合、デフォルトはバケットが作成されるロケーションになります。
bucketName 文字列 プロビジョニングされたバケットの名前空間のない名前。これは、ローカル ツールとライブラリを使用するときにバケットを参照するために使用されます。
zonalEndpoints 文字列配列 バケットにアクセスできるゾーン DNS エンドポイント。カスタマイズされたフェイルオーバーが必要な場合は、これらのエンドポイントを使用します。
globalEndpoint 文字列 このバケットのデータを含むゾーンにトラフィックを動的にルーティングするグローバル エンドポイント。自動フェイルオーバーが必要な場合は、このエンドポイントを使用します。
region 文字列 バケットが保存されているリージョン。
encryption EncryptionStatus バケットの暗号化ステータス。
allowDegradedWrites ブール値 同期バケットでのみ使用されます。レプリケーション ゾーンのいずれかが使用できないため、S3 オペレーションを非同期レプリケーションに戻す必要があるかどうかを判断します。これにより、レプリケーション ゾーンのいずれかがダウンした場合に、同期バケットが読み取り専用になるのを防ぐことができます。空の場合、デフォルトで false になります。

BucketInfoStatus

BucketInfo の観測状態を定義します。

表示場所: - BucketInfo

フィールド 説明
conditions 条件の配列

BucketList

バケットのリストが含まれます。

フィールド 説明
apiVersion 文字列 object.gdc.goog/v1
kind 文字列 BucketList
metadata ListMeta metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。
items バケットの配列

BucketPolicy

バケットのポリシーを定義します。

表示場所: - BucketSpec

フィールド 説明
lockingPolicy LockingPolicy オブジェクト ロックのポリシー。設定すると、オブジェクトのバージョニングが有効になり、バケットに保存されているすべてのオブジェクトがこのポリシーの対象になります。ロックされたオブジェクトは、ロックの有効期限が切れるまで削除できません。バケットの作成時にのみ有効にでき、後で無効にすることはできません。有効になっていない場合、オブジェクト ロックとバージョニングは無効になり、有効にすることはできません。
corsPolicy CorsPolicy バケットに設定されたカスタム CORS ポリシー ユーザーのポリシー。バケットに追加の CORS ポリシーが必要な場合は、CorsPolicy を有効にする必要があります。それ以外の場合、バケットにはデフォルトの UI コンソール CORS ポリシーのみが設定されます。CorsPolicy は、バケットの作成後にいつでも追加または変更できます。
lifecyclePolicy LifecyclePolicy バケットに設定されたカスタム ライフサイクル ポリシー ユーザーのポリシー。LifecyclePolicy は、バケットの作成後にいつでも追加、変更、削除できます。

BucketSpec

BucketSpec は、バケット リソースの望ましい状態を定義します。

表示場所: - バケット

フィールド 説明
description 文字列 バケットの内容の説明。
storageClass ObjectStorageClass データへのアクセス頻度を定義します。使用できるオプションには、Standard と Nearline があります。Standard は、ウェブサイト、ストリーミング動画、モバイルアプリなど、頻繁にアクセスされるホットデータに適しています。少なくとも 30 日間保存できるデータに使用されます。Nearline は、データのバックアップやロングテールのマルチメディア コンテンツなど、少なくとも 60 日間保存できるデータに適しています。
bucketPolicy BucketPolicy バケット リソースのポリシーを定義します。指定しない場合、デフォルトのポリシーが適用されます。
location 文字列 バケット内のオブジェクト データが存在する物理的な場所を定義します。指定しない場合、デフォルトはバケットが作成されるロケーションになります。

BucketStatus

バケットの観測状態を定義します。

表示場所: - バケット

フィールド 説明
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 を有効にする必要があります。それ以外の場合、バケットにはデフォルトの UI コンソール CORS ポリシーのみが設定されます。CorsPolicy は、バケットの作成後にいつでも追加または変更できます。
lifecyclePolicy LifecyclePolicy バケットに設定されたカスタム ライフサイクル ポリシー ユーザーのポリシー。LifecyclePolicy は、バケットの作成後にいつでも追加、変更、削除できます。

LifecycleExpiration

表示場所: - LifecycleRule

フィールド 説明
date 時間 オブジェクトを削除する特定の日付。
days 整数 このオブジェクトがルールの対象となる日数。

LifecycleNoncurrentExpiration

表示場所: - LifecycleRule

フィールド 説明
noncurrentDays 整数 ライフサイクル ルールがアクションを実行するまでのオブジェクトの非現行期間の日数。

LifecyclePolicy

表示される場所: - BucketPolicy - GlobalBucketPolicy

フィールド 説明
enable ブール値 ユーザーがバケットでカスタム ライフサイクル ポリシーを有効にするかどうかを定義します。
lifecycleRules LifecycleRule の配列 バケット内のオブジェクトに対して有効期限切れアクションを実行できる 1 つ以上のライフサイクル構成ルールで構成されます。

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 と同じ Namespace に存在する必要があります。
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 鍵がバックエンド ストレージ システムから完全に削除される予定のタイムスタンプです。この時間は、RotationCompleted 条件の LastTransitionTime に ExpirationDelay を加算して計算されます。

タグ

ライフサイクル フィルタで使用できるオブジェクトのタグを定義します。

表示場所: - LifecycleRuleFilter

フィールド 説明
key 文字列
value 文字列