oracle.dbadmin.gdc.goog/v1
备份
Backup 是 backups 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 |
此 backupplan 配置的 DBCluster 名称。此字段是必需字段且不可更改。 |
backupRetainDays 整数 |
服务将在多少天后删除备份。如果指定了该值，则在此 BackupPlan 下创建的备份会在存留时间达到 create_time + backup_retain_days 后自动删除。有效值为 1 到 90 天。如果未指定，则默认保留 14 天。 |
paused 布尔值 |
用于指示此 BackupPlan 下的备份创建是否暂停的标志。如果设置为 true，服务将暂停在此 BackupPlan 下安排新备份。默认为 False。 |
PITREnabled 布尔值 |
一个标志，用于指示是否已启用日志复制以支持时间点恢复。默认为 False。 nullon(samwise-fleet) |
BackupPlanStatus
BackupPlanStatus 定义观察到的 BackupPlan 状态。
来源： - BackupPlan
| 字段 | 说明 |
|---|---|
observedGeneration 整数 |
内部：控制器观察到的代际。 |
reconciled 布尔值 |
内部：资源是否由控制器进行了协调。 |
criticalIncidents CriticalIncident 数组 |
CriticalIncidents 是所有活跃的严重突发事件的扁平列表。 |
conditions 条件数组 |
Conditions 表示实体当前状态的最新可用观察结果。 |
phase BackupPlanPhase |
|
lastBackupTime 时间 |
LastBackupTime 是最近执行的备份的时间戳。 |
nextBackupTime 时间 |
NextBackupTime 是下一个预定备份的时间戳。 |
recoveryWindow TimeWindow |
RecoveryWindow 是目前可用的恢复时段。 |
BackupSpec
BackupSpec 定义备份的期望状态。
来源： - 备份
| 字段 | 说明 |
|---|---|
dbclusterRef DBClusterRef |
此备份所属的 DBCluster 名称。此字段是必填字段。 |
backupPlanRef BackupPlanRef |
创建此备份时所依据的 BackupPlan 的名称。此字段是必填字段。 |
manual 布尔值 |
指示此备份是预定备份还是手动备份。此字段是可选字段。如果未指定，则默认为 false（预定备份）。 |
BackupStatus
BackupStatus 定义观察到的备份状态。
来源： - 备份
| 字段 | 说明 |
|---|---|
observedGeneration 整数 |
内部：控制器观察到的代际。 |
reconciled 布尔值 |
内部：资源是否由控制器进行了协调。 |
criticalIncidents CriticalIncident 数组 |
CriticalIncidents 是所有活跃的严重突发事件的扁平列表。 |
conditions 条件数组 |
Conditions 表示实体当前状态的最新可用观察结果。 |
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 布尔值 |
IsDeleted 指示删除 DBCluster 的请求。此字段是可选字段，默认值为 false。 此字段会应用于数据库集群的所有实例。如果将此字段设置为 true，控制平面将尝试释放相关资源，包括网络端点。请查看状态字段以了解成功或失败情况（如果存在相关指示）。 |
mode 字符串 |
指示此 DBCluster 的模式。 |
availability 适用范围 |
Availability 包含用于 DBCluster 高可用性功能的可调整设置 |
allowExternalIncomingTraffic 布尔值 |
|
tls TLSSpec |
TLS 是集群的所需服务器证书配置。此字段是可选字段。默认情况下，此字段为空，系统会为集群生成新的自签名 CA 和叶证书。更改此字段后，数据库集群 Pod 会重启以加载指定的证书。status.certificateReference 字段指示当前的 CA 证书 Secret 和密钥。 |
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 布尔值 |
内部：资源是否由控制器进行了协调。 |
criticalIncidents CriticalIncident 数组 |
CriticalIncidents 是所有活跃的严重突发事件的扁平列表。 |
conditions 条件数组 |
Conditions 表示实体当前状态的最新可用观察结果。 |
phase DBClusterPhase |
|
primary PrimaryStatus |
Primary 包含主实例的状态。 |
restoredFrom RestoredFrom |
|
maintenanceStatus MaintenancePolicyStatus |
MaintenanceStatus 提供有关即将进行的维护的信息。nullon(samwise-fleet) |
upgradeScheduledAt 时间 |
UpgradeScheduledAt 是一个时间戳，用于指示下一次升级计划开始的时间。如果为 nil，则表示没有安排即将进行的升级。nullon(samwise-fleet) |
serviceAccounts 对象（键：OpType，值：ServiceAccountRef）OpTypeServiceAccountRef |
ServiceAccounts 包含控制平面所创建的供不同操作使用的服务账号。通过向这些服务账号授予权限，数据库可以与 Kubernetes 生态系统中的其他服务进行交互。如需了解详情（包括所需权限），请参阅各个操作的相应文档。 |
certificateReference CertificateRef |
CertificateReference 引用可用于连接到数据库的服务器 CA 证书的 Secret 和键。 如果提供了 spec.TLS，则在数据库配置为使用提供的服务器证书后，此值应引用相同的 Secret。 |
latestFailoverStatus FailoverStatus |
LatestFailoverStatus 是数据库集群最近更新的故障切换的状态。此状态是数据库集群当前或最近更新的故障切换操作状态的副本。这可用于方便地监控当前正在运行的故障切换操作的状态。 |
migrationStatus MigrationStatus |
MigrationStatus 表示数据库集群的迁移状态。nullon(samwise-fleet) |
availabilityZones AvailabilityZones |
AvailabilityZones 表示多可用区高可用性数据库集群的可用区状态。 |
导出
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 导出数组 |
ExportSpec
ExportSpec 定义了导出作业的预期状态。
来源： - 导出
| 字段 | 说明 |
|---|---|
dbclusterRef DBClusterRef |
DBClusterRef 是同一命名空间中要从中导出的 dbcluster 名称。 |
exportLocation StorageSpec |
ExportLocation 指定导出文件的存储位置。用户应确保操作器中对存储桶具有适当的写入访问权限。 |
ExportStatus
ExportStatus 定义了观察到的导出状态。
来源： - 导出
| 字段 | 说明 |
|---|---|
observedGeneration 整数 |
内部：控制器观察到的代际。 |
reconciled 布尔值 |
内部：资源是否由控制器进行了协调。 |
criticalIncidents CriticalIncident 数组 |
CriticalIncidents 是所有活跃的严重突发事件的扁平列表。 |
conditions 条件数组 |
Conditions 表示实体当前状态的最新可用观察结果。 |
phase ExportPhase |
Phase 是导出的当前状态的摘要。 |
startTime 时间 |
StartTime 是导出开始的时间。 |
completeTime 时间 |
CompleteTime 是导出完成的时间。 |
exportSubDirectory 字符串 |
ExportSubDirectory 是附加到 ExportLocation 以存储导出文件的子目录。 |
导入
Import 是 import API 的架构。
Appears in: - 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 是实例中要导入到其中的数据库资源名称。 |
dumpStorage StorageSpec |
DumpStorage 指定导入转储文件的存储位置。用户应确保操作器中对存储桶具有适当的读取权限。 |
logStorage StorageSpec |
LogStorage 可选择指定要将导入日志复制到的存储位置。用户应确保操作器中对存储桶具有适当的写入访问权限。 |
downloadOnly 布尔值 |
DownloadOnly 设置为 true 表示会下载转储文件，但不会将其导入数据库。默认值为 false。 |
tableExistAction 字符串 |
TableExistAction 是导入到现有表时要采取的操作。默认值为跳过。 |
ImportStatus
ImportStatus 定义了观察到的导入状态。
来源： - 导入
| 字段 | 说明 |
|---|---|
observedGeneration 整数 |
内部：控制器观察到的代际。 |
reconciled 布尔值 |
内部：资源是否由控制器进行了协调。 |
criticalIncidents CriticalIncident 数组 |
CriticalIncidents 是所有活跃的严重突发事件的扁平列表。 |
conditions 条件数组 |
Conditions 表示实体当前状态的最新可用观察结果。 |
phase ImportPhase |
Phase 是导入的当前状态的摘要。 |
startTime 时间 |
StartTime 是导入开始的时间。 |
completeTime 时间 |
CompleteTime 是导入完成的时间。 |
dumpPath 字符串 |
DumpPath 是下载的转储文件的路径，用于仅限下载的导入。 |
OracleInstanceSpec
来源： - DBClusterSpec
| 字段 | 说明 |
|---|---|
version 字符串 |
数据库的版本。nullon(samwise-fleet,samwise-local) |
images 对象（键：字符串，值：字符串） |
已弃用：数据库实例的替换映像。 nullon(samwise-fleet,samwise-local) |
component 对象（键：InstanceComponentName，值：InstanceComponentSpec） |
实例组件的列表。实例由数据层面和 controlPlaneAgent 组件组成。nullon(samwise-fleet) |
dbLoadBalancerOptions DBLoadBalancerOptions |
DBNetworkServiceOptions 使您可以替换为公开与数据库的连接而创建的 Kubernetes 服务的某些详细信息。 |
sourceCidrRanges 字符串数组 |
允许用于客户端的来源 IP CIDR 范围。 |
parameters 对象（键：字符串，值：字符串） |
Parameters 可用于为数据库集群设置数据库参数。此字段是可选字段。 参数将采用与数据库引擎定义的参数名称/值相对应的键值对。 |
services object (keys:Service, values:boolean) |
Services 列出客户可选择的可选半托管式服务。 |
resources 资源 |
数据库容器的资源规范。 当资源中的任何字段发生更改时，操作器会使用新的资源规范重启数据库实例。 |
mode InstanceMode |
Mode 指定操作器将如何管理此实例。 |
databasePatchingTimeout 时长 |
数据库修补的最大阈值。此超时时间分别用于 STS 补丁和 OPatch/datapatch 执行。 nullon(samwise-fleet) |
adminUser AdminUserSpec |
AdminUser 表示管理员用户规范。此字段为必填字段。 这是控制平面创建的初始数据库用户。其他数据库用户由最终用户直接管理。此字段还可用于重置初始用户的密码。 |
isStopped 布尔值 |
IsStopped 在设置为 true 时会停止实例。此字段是可选字段，默认为 false。 停止后，实例的计算资源（CPU、内存）会被释放。不过，实例仍会保留存储资源和网络端点，以便重启对下游服务透明。请查看状态字段以了解成功或失败情况（如果存在相关信息）。 |
availabilityOptions AvailabilityOptions |
AvailabilityOptions 包含用于高可用性功能的可调整设置 |
allowExternalIncomingTrafficToInstance 布尔值 |
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 布尔值 |
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 包含恢复列表
| 字段 | 说明 |
|---|---|
apiVersion 字符串 |
oracle.dbadmin.gdc.goog/v1 |
kind 字符串 |
RestoreList |
metadata ListMeta |
如需了解 metadata 的字段，请参阅 Kubernetes API 文档。 |
items 恢复数组 |
RestoreSpec
RestoreSpec 定义恢复的期望状态。
来源： - 恢复
| 字段 | 说明 |
|---|---|
sourceDBCluster DBClusterRef |
要从中恢复的源 DBCluster 的名称。此字段是必填字段。 |
pointInTime 时间 |
要恢复到的先前时间点。此字段是可选字段。如果未指定，则默认为恢复最新的可用时间点。 |
clonedDBClusterConfig ClonedDBClusterConfig |
克隆的 DBCluster 的设置。这使您可以为克隆的 DBCluster 指定名称。此字段是可选字段。如果未指定，则默认为恢复来源 DBCluster。 |
RestoreStatus
RestoreStatus 定义观察到的恢复状态。
来源： - 恢复
| 字段 | 说明 |
|---|---|
observedGeneration 整数 |
内部：控制器观察到的代际。 |
reconciled 布尔值 |
内部：资源是否由控制器进行了协调。 |
criticalIncidents CriticalIncident 数组 |
CriticalIncidents 是所有活跃的严重突发事件的扁平列表。 |
conditions 条件数组 |
Conditions 表示实体当前状态的最新可用观察结果。 |
phase RestorePhase |
|
createTime 时间 |
相应恢复的创建时间 |
completeTime 时间 |
恢复的完成时间 |
restoredPointInTime 时间 |
相应恢复操作将目标 DBCluster 恢复到的实际时间点。可能与 spec.PointInTime 中指定的值不同。nullon(samwise-fleet) |