oracle.dbadmin.gdc.goog/v1
備份
備份是備份 API 的結構定義
顯示位置： - BackupList
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
Backup |
metadata ObjectMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
spec BackupSpec |
|
status BackupStatus |
BackupList
BackupList 包含 Backup 清單
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
BackupList |
metadata ListMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
items 備份陣列 |
BackupPlan
BackupPlan 是 backupplans API 的結構定義
顯示位置： - BackupPlanList
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
BackupPlan |
metadata ObjectMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
spec BackupPlanSpec |
|
status BackupPlanStatus |
BackupPlanList
BackupPlanList 包含 BackupPlan 清單
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
BackupPlanList |
metadata ListMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
items BackupPlan 陣列 |
BackupPlanSpec
BackupPlanSpec 會定義 BackupPlan 的所需狀態。
顯示位置： - BackupPlan
| 欄位 | 說明 |
|---|---|
dbclusterRef DBClusterRef |
這個備份方案設定的 DBCluster 名稱。這是必填欄位，且無法變更。 |
backupRetainDays 整數 |
服務會在多少天後刪除備份。如果指定，根據這個 BackupPlan 建立的備份，在達到 create_time + backup_retain_days 的時間後，就會自動刪除。有效值為 1 到 90 天。如未指定，預設為保留 14 天。 |
paused boolean |
這個旗標表示是否已暫停根據這個 BackupPlan 建立備份。如果設為 true，服務會暫停排定這項 BackupPlan 的新備份作業。預設值為 False。 |
PITREnabled boolean |
此標記用於註明是否已啟用記錄檔複製功能，以支援時間點復原。預設值為 False。nullon(samwise-fleet) |
BackupPlanStatus
BackupPlanStatus 會定義觀察到的 BackupPlan 狀態。
顯示位置： - BackupPlan
| 欄位 | 說明 |
|---|---|
observedGeneration 整數 |
內部：控制器觀察到的世代。 |
reconciled boolean |
內部：資源是否已由控制器調解。 |
criticalIncidents CriticalIncident 陣列 |
CriticalIncidents 是所有有效重大事件的平面清單。 |
conditions Condition 陣列 |
「條件」代表實體目前狀態的最新觀察結果。 |
phase BackupPlanPhase |
|
lastBackupTime 時間 |
LastBackupTime 是最近一次執行備份的時間戳記。 |
nextBackupTime 時間 |
NextBackupTime 是下次排定備份作業的時間戳記。 |
recoveryWindow TimeWindow |
RecoveryWindow 是目前可用的復原時間範圍。 |
BackupSpec
BackupSpec 會定義備份作業的所需狀態。
| 欄位 | 說明 |
|---|---|
dbclusterRef DBClusterRef |
這個備份所屬的 DBCluster 名稱。這是必填欄位。 |
backupPlanRef BackupPlanRef |
建立這個備份的 BackupPlan 名稱。這是必填欄位。 |
manual boolean |
指出這項備份是排定備份還是手動備份。這是選填欄位。如未指定，則預設為 false (排定備份)。 |
BackupStatus
BackupStatus 會定義觀察到的備份狀態。
| 欄位 | 說明 |
|---|---|
observedGeneration 整數 |
內部：控制器觀察到的世代。 |
reconciled boolean |
內部：資源是否已由控制器調解。 |
criticalIncidents CriticalIncident 陣列 |
CriticalIncidents 是所有有效重大事件的平面清單。 |
conditions Condition 陣列 |
「條件」代表實體目前狀態的最新觀察結果。 |
phase BackupPhase |
|
createTime 時間 |
備份建立時間 |
completeTime 時間 |
備份完成時間 |
DBCluster
DBCluster 是 dbclusters API 的結構定義
顯示位置： - DBClusterList
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
DBCluster |
metadata ObjectMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
spec DBClusterSpec |
|
status DBClusterStatus |
DBClusterList
DBClusterList 包含 DBCluster 清單
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
DBClusterList |
metadata ListMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
items DBCluster 陣列 |
DBClusterSpec
DBClusterSpec 會定義 DBCluster 的所需狀態
出現位置： - DBCluster
| 欄位 | 說明 |
|---|---|
primaryCluster 字串 |
nullon(samwise-fleet) |
isDeleted boolean |
IsDeleted 表示刪除 DBCluster 的要求。這個欄位為選填，預設值為 false。這個欄位會套用至資料庫叢集的所有執行個體。如果設為 true，控制層會嘗試釋出相關資源，包括網路端點。查看狀態欄位，瞭解是否有任何成功或失敗的指標。 |
mode 字串 |
指出這個 DBCluster 的模式。 |
availability 適用情況 |
可用性包含 DBCluster HA 功能的可調整設定 |
allowExternalIncomingTraffic boolean |
|
tls TLSSpec |
TLS 是叢集所需的伺服器憑證設定。這是選填欄位。根據預設，這個欄位是空白的，系統會為叢集產生新的自行簽署 CA 和葉子憑證。變更這個欄位時，資料庫叢集 Pod 會重新啟動，以載入指定的憑證。status.certificateReference 欄位會指出目前的 CA 憑證密鑰和金鑰。 |
databaseVersion 字串 |
DatabaseVersion 是叢集的所需資料庫版本，例如「15.4.5」。這是必填欄位。這個版本會套用至資料庫叢集的所有執行個體。如果是新的資料庫叢集，系統會使用指定版本建立執行個體。如果是現有的資料庫叢集，運算子會嘗試升級或降級至指定的 databaseVersion。status.currentDatabaseVersion 欄位會指出目前的資料庫版本。 |
controlPlaneAgentsVersion 字串 |
ControlPlaneAgentsVersion 是叢集的所需控制層代理程式版本，例如「0.5.2」。這是必填欄位。controlPlaneAgentsVersion 必須與所選的 databaseVersion 相容。如要瞭解相容的版本，請查看{link}中的可用版本清單。這個版本會套用至資料庫叢集的所有執行個體。如果是新的資料庫叢集，系統會使用指定版本建立執行個體。如果是現有資料庫叢集，運算子會嘗試升級或降級至指定的 controlPlaneAgentsVersion。status.currentControlPlaneAgentsVersion 欄位會指出控制層代理程式的目前版本。 |
databaseImage 字串 |
DatabaseImage 是容器登錄中自訂資料庫映像檔的 URI，例如「gcr.io/foo/bar/alloydbomni:15-7-2-customized」。這是選填欄位。如果指定 databaseImage，運算子會使用這個資料庫的容器映像檔，而不是指定 databaseVersion 的預設資料庫容器映像檔。建議 databaseImage 容器以所選 databaseVersion 使用的預設資料庫映像檔為基礎。 |
primarySpec OracleInstanceSpec |
DBClusterStatus
DBClusterStatus 定義了 DBCluster 的觀察狀態
出現位置： - DBCluster
| 欄位 | 說明 |
|---|---|
observedGeneration 整數 |
內部：控制器觀察到的世代。 |
reconciled boolean |
內部：資源是否已由控制器調解。 |
criticalIncidents CriticalIncident 陣列 |
CriticalIncidents 是所有有效重大事件的平面清單。 |
conditions Condition 陣列 |
「條件」代表實體目前狀態的最新觀察結果。 |
phase DBClusterPhase |
|
primary PrimaryStatus |
Primary 包含主要執行個體的狀態。 |
restoredFrom RestoredFrom |
|
maintenanceStatus MaintenancePolicyStatus |
MaintenanceStatus 提供即將進行的維護作業相關資訊。nullon(samwise-fleet) |
upgradeScheduledAt 時間 |
UpgradeScheduledAt 是時間戳記，表示下一次升級預計開始的時間。如果為空值，表示沒有排定近期升級。nullon(samwise-fleet) |
serviceAccounts 物件 (鍵：OpType，值：ServiceAccountRef) |
ServiceAccounts 包含控制層建立的服務帳戶，供不同作業使用。授予這些服務帳戶權限後，資料庫就能與 Kubernetes 生態系統中的其他服務互動。如要進一步瞭解各項作業，包括所需權限，請參閱相關說明文件。 |
certificateReference CertificateRef |
CertificateReference 是指伺服器 CA 憑證的密鑰和金鑰，可用於連線至資料庫。如果提供 spec.TLS，在資料庫設定為使用提供的伺服器憑證後，這個值應參照相同的密鑰。 |
latestFailoverStatus FailoverStatus |
LatestFailoverStatus 是資料庫叢集最近一次更新的容錯移轉狀態。這個狀態是資料庫叢集目前或最近一次更新的容錯移轉作業狀態副本。這項功能可用於輕鬆監控目前執行的容錯移轉作業狀態。 |
migrationStatus MigrationStatus |
MigrationStatus 代表資料庫叢集的遷移狀態。nullon(samwise-fleet) |
availabilityZones AvailabilityZones |
AvailabilityZones 代表多區域 HA 資料庫叢集的可用區狀態。 |
匯出
Export 是匯出 API 的結構定義。
顯示於： - ExportList
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
Export |
metadata ObjectMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
spec ExportSpec |
|
status ExportStatus |
ExportList
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
ExportList |
metadata ListMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
items Export 陣列 |
ExportSpec
ExportSpec 定義了 Export 的所需狀態。
| 欄位 | 說明 |
|---|---|
dbclusterRef DBClusterRef |
DBClusterRef 是要匯出的相同命名空間中的 dbcluster 名稱。 |
exportLocation StorageSpec |
ExportLocation 會指定匯出檔案的儲存位置。使用者必須確保從 Operator 內可正確寫入儲存空間 bucket。 |
ExportStatus
ExportStatus 定義了觀察到的 Export 狀態。
| 欄位 | 說明 |
|---|---|
observedGeneration 整數 |
內部：控制器觀察到的世代。 |
reconciled boolean |
內部：資源是否已由控制器調解。 |
criticalIncidents CriticalIncident 陣列 |
CriticalIncidents 是所有有效重大事件的平面清單。 |
conditions Condition 陣列 |
「條件」代表實體目前狀態的最新觀察結果。 |
phase ExportPhase |
階段：匯出作業目前狀態的摘要。 |
startTime 時間 |
StartTime 是匯出作業的開始時間。 |
completeTime 時間 |
CompleteTime 是匯出作業完成的時間。 |
exportSubDirectory 字串 |
ExportSubDirectory 是附加至 ExportLocation 的子目錄，用於儲存匯出的檔案。 |
匯入
Import 是匯入 API 的結構定義。
顯示位置： - ImportList
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
Import |
metadata ObjectMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
spec ImportSpec |
|
status ImportStatus |
ImportList
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
ImportList |
metadata ListMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
items 匯入陣列 |
ImportSpec
ImportSpec 會定義匯入作業的所需狀態。
| 欄位 | 說明 |
|---|---|
dbclusterRef DBClusterRef |
DBClusterRef 是要匯入的相同命名空間中的 dbcluster 名稱。 |
databaseName 字串 |
DatabaseName 是要匯入的 Instance 內資料庫資源名稱。 |
dumpStorage StorageSpec |
DumpStorage 會指定匯入傾印檔案的儲存位置。使用者必須確保從運算子內部正確讀取儲存空間值區。 |
logStorage StorageSpec |
LogStorage 可選擇指定儲存位置，用來複製匯入記錄。使用者必須確保從 Operator 內可正確寫入儲存空間 bucket。 |
downloadOnly boolean |
如果設為 true，表示系統只會下載傾印檔案，但不會匯入資料庫。預設值是 false。 |
tableExistAction 字串 |
TableExistAction 是指匯入現有資料表時應採取的動作。系統預設為略過。 |
ImportStatus
ImportStatus 會定義 Import 的觀察狀態。
| 欄位 | 說明 |
|---|---|
observedGeneration 整數 |
內部：控制器觀察到的世代。 |
reconciled boolean |
內部：資源是否已由控制器調解。 |
criticalIncidents CriticalIncident 陣列 |
CriticalIncidents 是所有有效重大事件的平面清單。 |
conditions Condition 陣列 |
「條件」代表實體目前狀態的最新觀察結果。 |
phase ImportPhase |
階段：匯入作業目前狀態的摘要。 |
startTime 時間 |
StartTime 是指匯入作業的開始時間。 |
completeTime 時間 |
CompleteTime 是匯入完成的時間。 |
dumpPath 字串 |
DumpPath 是下載的傾印檔案路徑，僅適用於下載匯入。 |
OracleInstanceSpec
出現位置： - DBClusterSpec
| 欄位 | 說明 |
|---|---|
version 字串 |
資料庫版本。nullon(samwise-fleet,samwise-local) |
images 物件 (鍵：字串，值：字串) |
已淘汰：資料庫執行個體的替代映像檔。nullon(samwise-fleet,samwise-local) |
component 物件 (鍵：InstanceComponentName，值：InstanceComponentSpec) |
執行個體元件清單。執行個體是由 dataplane 和 controlPlaneAgent 元件組成。nullon(samwise-fleet) |
dbLoadBalancerOptions DBLoadBalancerOptions |
DBNetworkServiceOptions 可覆寫為公開資料庫連線而建立的 Kubernetes 服務部分詳細資料。 |
sourceCidrRanges 字串陣列 |
允許用戶端使用的來源 IP CIDR 範圍。 |
parameters 物件 (鍵：字串，值：字串) |
參數可讓您為資料庫叢集設定資料庫參數。這是選填欄位。參數會採用與資料庫引擎定義的參數名稱/值對應的鍵/值組合。 |
services object (keys:Service, values:boolean) |
服務：列出顧客可選擇的選用半代管服務。 |
resources 資源 |
資料庫容器的資源規格。當資源內的任何欄位變更時，運算子會使用新的資源規格重新啟動資料庫執行個體。 |
mode InstanceMode |
模式會指定運算子管理這個執行個體的方式。 |
databasePatchingTimeout 時間長度 |
資料庫修補作業的上限門檻。這個逾時時間會分別用於 sts 修補和 OPatch/datapatch 執行作業。nullon(samwise-fleet) |
adminUser AdminUserSpec |
AdminUser 代表管理員使用者規格。這是必填欄位。這是控制層建立的初始資料庫使用者。其他資料庫使用者則由使用者直接管理。這個欄位也可用來重設初始使用者的密碼。 |
isStopped boolean |
如果設為 true，IsStopped 會停止執行個體。這個欄位為選填，預設值為 false。停止執行個體時，系統會釋出執行個體的運算資源 (CPU、記憶體)。不過，執行個體仍會保留儲存空間資源和網路端點，因此重新啟動時，下游服務不會受到影響。查看狀態欄位，瞭解是否有任何成功或失敗的記錄。 |
availabilityOptions AvailabilityOptions |
AvailabilityOptions 包含 HA 功能的可調整設定 |
allowExternalIncomingTrafficToInstance boolean |
AllowExternalIncomingTrafficToInstance 會用於設定外部 LB 建立作業。 |
auditLogTarget AuditLogTargetSpec |
AuditLogTarget 會設定資料庫稽核記錄的接收器 |
replication ReplicationSpec |
複製功能會設定與其他資料庫執行個體的複製連線 nullon(samwise-fleet) |
tls TLSSpec |
TLS 是執行個體所需的伺服器憑證設定。這是選填欄位。變更這個欄位時，執行個體 Pod 會重新啟動，載入指定的憑證 |
schedulingconfig SchedulingConfig |
SchedulingConfig 會指定執行個體在 Kubernetes 節點上的排程方式。排程設定中的任何欄位變更時，可能會導致 k8s Pod 根據設定重新排程至不同節點。 |
cdbName 字串 |
CDBName 是 CDB 屬性的預期名稱。如果 CDBName 與原始名稱 (建立 CDB 時使用的名稱) 不同，系統會重新命名 CDB。 |
characterSet 字串 |
用於建立資料庫的字元集 (預設為 AL32UTF8)。 |
memoryPercent 整數 |
MemoryPercent 代表應為 Oracle SGA 分配的記憶體百分比 (預設為 25%)。 |
EnableTLS boolean |
EnableTLS 可啟用 TLS 加密連線。 |
還原
Restore 是 restores API 的結構定義
顯示位置： - RestoreList
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
Restore |
metadata ObjectMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
spec RestoreSpec |
|
status RestoreStatus |
RestoreList
RestoreList 包含 Restore 清單
| 欄位 | 說明 |
|---|---|
apiVersion 字串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字串 |
RestoreList |
metadata ListMeta |
如需 metadata 的欄位，請參閱 Kubernetes API 說明文件。 |
items Restore 陣列 |
RestoreSpec
RestoreSpec 會定義還原作業的所需狀態。
| 欄位 | 說明 |
|---|---|
sourceDBCluster DBClusterRef |
要還原的來源 DBCluster 名稱。這是必填欄位。 |
pointInTime 時間 |
要還原至過去的哪個時間點。這是選填欄位。如未指定，預設會還原至最新的可用時間點。 |
clonedDBClusterConfig ClonedDBClusterConfig |
複製的 DBCluster 設定。您可以指定複製的 DBCluster 名稱。這是選填欄位。如未指定，則預設為還原來源 DBCluster。 |
RestoreStatus
RestoreStatus 會定義觀察到的 Restore 狀態。
| 欄位 | 說明 |
|---|---|
observedGeneration 整數 |
內部：控制器觀察到的世代。 |
reconciled boolean |
內部：資源是否已由控制器調解。 |
criticalIncidents CriticalIncident 陣列 |
CriticalIncidents 是所有有效重大事件的平面清單。 |
conditions Condition 陣列 |
「條件」代表實體目前狀態的最新觀察結果。 |
phase RestorePhase |
|
createTime 時間 |
還原作業的建立時間 |
completeTime 時間 |
還原完成時間 |
restoredPointInTime 時間 |
還原作業實際將目標 DBCluster 帶入的時間點。可能與 spec.PointInTime 中指定的值不同。nullon(samwise-fleet) |