openapi: 3.0.1 info: contact: name: https://docs.yugabyte.com description: Backups, Restores, and Replication subset of the YugabyteDB Anywhere v1 REST API, split from the canonical platform-go-client OpenAPI bundle. license: name: Polyform Free Trial License 1.0.0 url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt termsOfService: TODO(chirag) title: YugabyteDB Anywhere v1 — Backups, Restores, and Replication version: v1 x-source: https://github.com/yugabyte/platform-go-client/blob/master/api/openapi.yaml x-split-from: yugabytedb-anywhere-v1-openapi.yaml externalDocs: description: About YugabyteDB Anywhere url: https://docs.yugabyte.com/latest/yugabyte-platform/ servers: - url: / tags: - name: Asynchronous Replication - name: Backups - name: Customer Configuration - name: Disaster Recovery - name: Schedule management paths: /api/v1/customers/{cUUID}/backups: delete: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Use 'Delete backups V2' instead. operationId: deleteBackups parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTasks' examples: DeleteBackups200Example: summary: Default deleteBackups 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete Backups - Deprecated tags: - Backups x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createbackup parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupRequestParams' examples: CreatebackupRequestExample: summary: Default createbackup request x-microcks-default: true value: expectedUniverseVersion: 5 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser useRoles: true alterLoadBalancer: true baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true keyspaceTableList: - keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sleepAfterTServerRestartMillis: 3 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 enablePointInTimeRestore: true ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 9 expiryTimeUnit: NANOSECONDS parallelism: 4 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK backupType: PGSQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybcSoftwareVersion: ybcSoftwareVersion incrementalBackupFrequencyTimeUnit: NANOSECONDS backupCategory: YB_BACKUP_SCRIPT creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion useLocalTimezone: true disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 3 backupStats: true parallelDBBackups: 0 ybPrevSoftwareVersion: ybPrevSoftwareVersion dumpRoleChecks: true cronExpression: cronExpression universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString frequencyTimeUnit: NANOSECONDS installYbc: true schedulingFrequency: 8 incrementalBackupFrequency: 9 cmkArn: cmkArn previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: Backup data to be created required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: Createbackup200Example: summary: Default createbackup 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create a Backup V2 tags: - Backups x-codegen-request-body-name: Backup x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/backups/delete: post: operationId: deleteBackupsV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteBackupParams' examples: DeleteBackupsV2RequestExample: summary: Default deleteBackupsV2 request x-microcks-default: true value: deleteBackupInfos: - storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deleteForcefully: true description: Parameters of the backup to be deleted required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTasks' examples: DeleteBackupsV2200Example: summary: Default deleteBackupsV2 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete Backups V2 tags: - Backups x-codegen-request-body-name: deleteBackup x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/backups/page: post: operationId: listBackupsV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupPagedApiQuery' examples: ListBackupsV2RequestExample: summary: Default listBackupsV2 request x-microcks-default: true value: filter: showHidden: true dateRangeEnd: '2022-12-12T13:07:18+00:00' storageConfigUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspaceList: - keyspaceList - keyspaceList dateRangeStart: '2022-12-12T13:07:18+00:00' backupUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 scheduleUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeNameList: - universeNameList - universeNameList onlyShowDeletedConfigs: true universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 onlyShowDeletedUniverses: true states: - InProgress - InProgress offset: 6 needTotalCount: true limit: 0 sortBy: createTime direction: ASC required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackupPagedApiResponse' examples: ListBackupsV2200Example: summary: Default listBackupsV2 200 response x-microcks-default: true value: entities: - scheduleName: scheduleName isFullBackup: true expiryTimeUnit: NANOSECONDS hasIncrementalBackups: true lastBackupState: InProgress commonBackupInfo: tableByTableBackup: true sse: true updateTime: 2022-12-12 13:07:18+00:00 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 responseList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation state: InProgress totalBackupSizeInBytes: 5 backupType: YQL_TABLE_TYPE isUniversePresent: true onDemand: true universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 lastIncrementalBackupTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryTime: 2022-12-12 13:07:18+00:00 fullChainSizeInBytes: 5 isStorageConfigPresent: true category: YB_BACKUP_SCRIPT useTablespaces: true storageConfigType: S3 universeName: universeName - scheduleName: scheduleName isFullBackup: true expiryTimeUnit: NANOSECONDS hasIncrementalBackups: true lastBackupState: InProgress commonBackupInfo: tableByTableBackup: true sse: true updateTime: 2022-12-12 13:07:18+00:00 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 responseList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation state: InProgress totalBackupSizeInBytes: 5 backupType: YQL_TABLE_TYPE isUniversePresent: true onDemand: true universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 lastIncrementalBackupTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryTime: 2022-12-12 13:07:18+00:00 fullChainSizeInBytes: 5 isStorageConfigPresent: true category: YB_BACKUP_SCRIPT useTablespaces: true storageConfigType: S3 universeName: universeName hasPrev: true hasNext: true totalCount: 2 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Backups (paginated) V2 tags: - Backups x-codegen-request-body-name: PageBackupsRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/backups/{backupUUID}: get: operationId: getBackupV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: backupUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/Backup' examples: GetBackupV2200Example: summary: Default getBackupV2 200 response x-microcks-default: true value: scheduleName: scheduleName parentBackup: true expiryTimeUnit: NANOSECONDS retryCount: 1 hasKMSHistory: true kubernetesOperatorControlled: true updateTime: 2022-12-12 13:07:18+00:00 incrementalBackup: true taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: V1 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiry: 2022-12-12 13:07:18+00:00 state: DELETED category: YB_BACKUP_SCRIPT firstSnapshotTime: 1 backupInfo: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 universeName: universeName description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Backup V2 tags: - Backups x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Edit a backup operationId: editBackupV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: backupUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/EditBackupParams' examples: EditBackupV2RequestExample: summary: Default editBackupV2 request x-microcks-default: true value: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryTimeUnit: NANOSECONDS timeBeforeDeleteFromPresentInMillis: 0 description: Parameters of the backup to be edited required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Backup' examples: EditBackupV2200Example: summary: Default editBackupV2 200 response x-microcks-default: true value: scheduleName: scheduleName parentBackup: true expiryTimeUnit: NANOSECONDS retryCount: 1 hasKMSHistory: true kubernetesOperatorControlled: true updateTime: 2022-12-12 13:07:18+00:00 incrementalBackup: true taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: V1 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiry: 2022-12-12 13:07:18+00:00 state: DELETED category: YB_BACKUP_SCRIPT firstSnapshotTime: 1 backupInfo: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 universeName: universeName description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit a Backup V2 tags: - Backups x-codegen-request-body-name: backup x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/backups/{backupUUID}/list_increments: get: operationId: listIncrementalBackups parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: backupUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CommonBackupInfo' type: array examples: ListIncrementalBackups200Example: summary: Default listIncrementalBackups 200 response x-microcks-default: true value: - tableByTableBackup: true sse: true updateTime: 2022-12-12 13:07:18+00:00 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 responseList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation state: InProgress totalBackupSizeInBytes: 5 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Incremental Backups tags: - Backups x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/backups/{backupUUID}/stop: post: description: Stop an in-progress backup operationId: stopBackup parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: backupUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: StopBackup200Example: summary: Default stopBackup 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Stop a Backup tags: - Backups x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/backups/{baseBackupUUID}/restorable_keyspace_tables: get: description: 'WARNING: This is a preview API that could change. List of all restorable entities in the incremental backup chain.' operationId: listRestorableKeyspaceTables parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: baseBackupUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/KeyspaceTables' type: array examples: ListRestorableKeyspaceTables200Example: summary: Default listRestorableKeyspaceTables 200 response x-microcks-default: true value: - keyspace: keyspace tableNames: - tableNames - tableNames description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List of All Restorable Entities in the Incremental Backup Chain tags: - Backups x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/cloud/{cloud}/buckets: post: operationId: listBuckets parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: cloud required: true schema: type: string example: example-cloud - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerConfigData' examples: ListBucketsRequestExample: summary: Default listBuckets request x-microcks-default: true value: {} description: Credentials to list buckets required: true responses: '200': content: application/json: schema: type: object examples: ListBuckets200Example: summary: Default listBuckets 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Buckets with Provided Credentials tags: - Customer Configuration x-codegen-request-body-name: Credentials x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/configs: get: operationId: getListOfCustomerConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CustomerConfigUI' type: array examples: GetListOfCustomerConfig200Example: summary: Default getListOfCustomerConfig 200 response x-microcks-default: true value: - configName: backup20-01-2021 configUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' universeDetails: '{"name": "jd-aws-21-6-21-test4"}' inUse: true kubernetesOperatorControlled: true name: S3 state: Active type: STORAGE description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Customer Configurations tags: - Customer Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createCustomerConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerConfig' examples: CreateCustomerConfigRequestExample: summary: Default createCustomerConfig request x-microcks-default: true value: configName: backup20-01-2021 configUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' kubernetesOperatorControlled: true name: S3 state: Active type: STORAGE description: Configuration data to be created required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerConfig' examples: CreateCustomerConfig200Example: summary: Default createCustomerConfig 200 response x-microcks-default: true value: configName: backup20-01-2021 configUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' kubernetesOperatorControlled: true name: S3 state: Active type: STORAGE description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create a Customer Configuration tags: - Customer Configuration x-codegen-request-body-name: Config x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/configs/{configUUID}: delete: deprecated: true description: Deprecated since YBA version 2.25.0.0.

Use 'Delete a customer configuration V2' instead. operationId: deleteCustomerConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: isDeleteBackups schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: DeleteCustomerConfig200Example: summary: Default deleteCustomerConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Customer Configuration tags: - Customer Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: editCustomerConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerConfig' examples: EditCustomerConfigRequestExample: summary: Default editCustomerConfig request x-microcks-default: true value: configName: backup20-01-2021 configUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' kubernetesOperatorControlled: true name: S3 state: Active type: STORAGE description: Configuration data to be updated required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerConfig' examples: EditCustomerConfig200Example: summary: Default editCustomerConfig 200 response x-microcks-default: true value: configName: backup20-01-2021 configUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' kubernetesOperatorControlled: true name: S3 state: Active type: STORAGE description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Update a Customer Configuration tags: - Customer Configuration x-codegen-request-body-name: Config x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/configs/{configUUID}/backup_dirs: get: operationId: getListOfYbaBackupDirsCustomerConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: type: string type: array examples: GetListOfYbaBackupDirsCustomerConfig200Example: summary: Default getListOfYbaBackupDirsCustomerConfig 200 response x-microcks-default: true value: - string description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List All Backup Dirs Within a Customer Configurations tags: - Customer Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/configs/{configUUID}/delete: delete: operationId: deleteCustomerConfigV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: isDeleteBackups schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: DeleteCustomerConfigV2200Example: summary: Default deleteCustomerConfigV2 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Customer Configuration V2 tags: - Customer Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/configs/{configUUID}/edit: put: operationId: editCustomerConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: configUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerConfig' examples: EditCustomerConfigRequestExample: summary: Default editCustomerConfig request x-microcks-default: true value: configName: backup20-01-2021 configUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' kubernetesOperatorControlled: true name: S3 state: Active type: STORAGE description: Configuration data to be updated required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerConfig' examples: EditCustomerConfig200Example: summary: Default editCustomerConfig 200 response x-microcks-default: true value: configName: backup20-01-2021 configUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' kubernetesOperatorControlled: true name: S3 state: Active type: STORAGE description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Update a Customer Configuration V2 tags: - Customer Configuration x-codegen-request-body-name: Config x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/create_backup_schedule: post: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Use 'Create Backup Schedule Async' instead. operationId: createBackupSchedule parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupRequestParams' examples: CreateBackupScheduleRequestExample: summary: Default createBackupSchedule request x-microcks-default: true value: expectedUniverseVersion: 5 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser useRoles: true alterLoadBalancer: true baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true keyspaceTableList: - keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sleepAfterTServerRestartMillis: 3 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 enablePointInTimeRestore: true ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 9 expiryTimeUnit: NANOSECONDS parallelism: 4 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK backupType: PGSQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybcSoftwareVersion: ybcSoftwareVersion incrementalBackupFrequencyTimeUnit: NANOSECONDS backupCategory: YB_BACKUP_SCRIPT creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion useLocalTimezone: true disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 3 backupStats: true parallelDBBackups: 0 ybPrevSoftwareVersion: ybPrevSoftwareVersion dumpRoleChecks: true cronExpression: cronExpression universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString frequencyTimeUnit: NANOSECONDS installYbc: true schedulingFrequency: 8 incrementalBackupFrequency: 9 cmkArn: cmkArn previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: Parameters of the backup to be restored required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Schedule' examples: CreateBackupSchedule200Example: summary: Default createBackupSchedule 200 response x-microcks-default: true value: scheduleName: scheduleName ownerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nextScheduleTaskTime: 2022-12-12 13:07:18+00:00 kubernetesOperatorControlled: true incrementBacklogStatus: true frequency: 6 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS taskType: CloudBootstrap nextIncrementScheduleTaskTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true userEmail: userEmail backlogStatus: true failureCount: 0 status: Deleting description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create Backup Schedule - Deprecated tags: - Backups x-codegen-request-body-name: backup x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/create_backup_schedule_async: post: operationId: createBackupScheduleAsync parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupRequestParams' examples: CreateBackupScheduleAsyncRequestExample: summary: Default createBackupScheduleAsync request x-microcks-default: true value: expectedUniverseVersion: 5 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser useRoles: true alterLoadBalancer: true baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true keyspaceTableList: - keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sleepAfterTServerRestartMillis: 3 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 enablePointInTimeRestore: true ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 9 expiryTimeUnit: NANOSECONDS parallelism: 4 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK backupType: PGSQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybcSoftwareVersion: ybcSoftwareVersion incrementalBackupFrequencyTimeUnit: NANOSECONDS backupCategory: YB_BACKUP_SCRIPT creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion useLocalTimezone: true disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 3 backupStats: true parallelDBBackups: 0 ybPrevSoftwareVersion: ybPrevSoftwareVersion dumpRoleChecks: true cronExpression: cronExpression universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString frequencyTimeUnit: NANOSECONDS installYbc: true schedulingFrequency: 8 incrementalBackupFrequency: 9 cmkArn: cmkArn previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: Parameters of the backup to be restored required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: CreateBackupScheduleAsync200Example: summary: Default createBackupScheduleAsync 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create Backup Schedule Async tags: - Backups x-codegen-request-body-name: backup x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs: post: description: 'WARNING: This is a preview API that could change.' operationId: createDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/DrConfigCreateForm' examples: CreateDrConfigRequestExample: summary: Default createDrConfig request x-microcks-default: true value: targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 dryRun: true bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 dbs: '["0000412b000030008000000000000000", "0000412b000030008000000000000001"]' name: Dr-config1 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 pitrParams: snapshotIntervalSec: 1 retentionPeriodSec: 6 description: Disaster Recovery Create Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: CreateDrConfig200Example: summary: Default createDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create Disaster Recovery Config tags: - Disaster Recovery x-codegen-request-body-name: disaster_recovery_create_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}: delete: description: 'WARNING: This is a preview API that could change.' operationId: deleteXClusterConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: isForceDelete schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: DeleteXClusterConfig200Example: summary: Default deleteXClusterConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete Xcluster Config tags: - Disaster Recovery x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: 'WARNING: This is a preview API that could change.' operationId: getDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: syncWithDB schema: default: true type: boolean example: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DrConfigGetResp' examples: GetDrConfig200Example: summary: Default getDrConfig 200 response x-microcks-default: true value: paused: true replicationGroupName: replicationGroupName bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 xclusterConfigUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 drReplicaUniverseState: Unconfigured for DR type: Basic uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 xclusterConfigsUuid: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: UNKNOWN tables: - tables - tables modifyTime: 2022-12-12 13:07:18+00:00 primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 drReplicaUniverseActive: true state: Initializing primaryUniverseState: Unconfigured for DR tableDetails: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: 2022-12-12 13:07:18+00:00 bootstrapCreateTime: 2022-12-12 13:07:18+00:00 indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: 2022-12-12 13:07:18+00:00 bootstrapCreateTime: 2022-12-12 13:07:18+00:00 indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated dbDetails: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated pitrConfigs: - dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 - dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 primaryUniverseActive: true automaticDdlMode: true dbs: - dbs - dbs createTime: 2022-12-12 13:07:18+00:00 webhooks: - uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 url: url - uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 url: url name: name drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspacePending: keyspacePending pitrRetentionPeriodSec: 2 pitrSnapshotIntervalSec: 7 status: Initialized description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Disaster Recovery Config tags: - Disaster Recovery x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/edit: post: description: 'WARNING: This is a preview API that could change.' operationId: editDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/DrConfigEditForm' examples: EditDrConfigRequestExample: summary: Default editDrConfig request x-microcks-default: true value: bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 webhookUrls: - webhookUrls - webhookUrls pitrParams: snapshotIntervalSec: 1 retentionPeriodSec: 6 description: Disaster Recovery Edit Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: EditDrConfig200Example: summary: Default editDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit Disaster Recovery Config tags: - Disaster Recovery x-codegen-request-body-name: disaster_recovery_edit_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/failover: post: description: 'WARNING: This is a preview API that could change.' operationId: failoverDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/DrConfigFailoverForm' examples: FailoverDrConfigRequestExample: summary: Default failoverDrConfig request x-microcks-default: true value: namespaceIdSafetimeEpochUsMap: key: 0 drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: Disaster Recovery Failover Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: FailoverDrConfig200Example: summary: Default failoverDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Failover a Disaster Recovery Config tags: - Disaster Recovery x-codegen-request-body-name: disaster_recovery_failover_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause: post: description: 'WARNING: This is a preview API that could change.' operationId: pauseDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: PauseDrConfig200Example: summary: Default pauseDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Pause DR Config tags: - Disaster Recovery x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/pause_universes: post: description: 'WARNING: This is a preview API that could change.' operationId: pauseDrUniverses parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: PauseDrUniverses200Example: summary: Default pauseDrUniverses 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Pause DR Config and Universes Associated with DR tags: - Disaster Recovery x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/replace_replica: post: description: 'WARNING: This is a preview API that could change.' operationId: replaceReplicaDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/DrConfigReplaceReplicaForm' examples: ReplaceReplicaDrConfigRequestExample: summary: Default replaceReplicaDrConfig request x-microcks-default: true value: bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: Disaster Recovery Replace Replica Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: ReplaceReplicaDrConfig200Example: summary: Default replaceReplicaDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Replace Replica in a Disaster Recovery Config tags: - Disaster Recovery x-codegen-request-body-name: disaster_recovery_replace_replica_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/restart: post: description: 'WARNING: This is a preview API that could change.' operationId: restartDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: isForceDelete schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/DrConfigRestartForm' examples: RestartDrConfigRequestExample: summary: Default restartDrConfig request x-microcks-default: true value: bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 dbs: '["0000412b000030008000000000000000", "0000412b000030008000000000000001"]' description: Disaster Recovery Restart Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: RestartDrConfig200Example: summary: Default restartDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Restart Disaster Recovery Config tags: - Disaster Recovery x-codegen-request-body-name: disaster_recovery_restart_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume: post: description: 'WARNING: This is a preview API that could change.' operationId: resumeDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: ResumeDrConfig200Example: summary: Default resumeDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Resume DR Config tags: - Disaster Recovery x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/resume_universes: post: description: 'WARNING: This is a preview API that could change.' operationId: resumeDrUniverses parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: ResumeDrUniverses200Example: summary: Default resumeDrUniverses 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Resume DR Config and Universes Associated with DR tags: - Disaster Recovery x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/safetime: get: description: 'WARNING: This is a preview API that could change.' operationId: getDrConfigSafetime parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/DrConfigSafetimeResp' examples: GetDrConfigSafetime200Example: summary: Default getDrConfigSafetime 200 response x-microcks-default: true value: safetimes: - namespaceId: namespaceId safetimeLagUs: 1 estimatedDataLossMs: 0.8008281904610115 safetimeEpochUs: 6 namespaceName: namespaceName safetimeSkewUs: 5 - namespaceId: namespaceId safetimeLagUs: 1 estimatedDataLossMs: 0.8008281904610115 safetimeEpochUs: 6 namespaceName: namespaceName safetimeSkewUs: 5 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Disaster Recovery Config Safetime tags: - Disaster Recovery x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_dbs: put: description: 'WARNING: This is a preview API that could change.' operationId: setDatabasesDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/DrConfigSetDatabasesForm' examples: SetDatabasesDrConfigRequestExample: summary: Default setDatabasesDrConfig request x-microcks-default: true value: dbs: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' description: Disaster Recovery Set Databases Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: SetDatabasesDrConfig200Example: summary: Default setDatabasesDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Set Databases in Disaster Recovery Config tags: - Disaster Recovery x-codegen-request-body-name: disaster_recovery_set_databases_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/set_tables: post: description: 'WARNING: This is a preview API that could change.' operationId: setTablesDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/DrConfigSetTablesForm' examples: SetTablesDrConfigRequestExample: summary: Default setTablesDrConfig request x-microcks-default: true value: tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 autoIncludeIndexTables: true description: Disaster Recovery Set Tables Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: SetTablesDrConfig200Example: summary: Default setTablesDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Set Tables in Disaster Recovery Config tags: - Disaster Recovery x-codegen-request-body-name: disaster_recovery_set_tables_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/switchover: post: description: 'WARNING: This is a preview API that could change.' operationId: switchoverDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/DrConfigSwitchoverForm' examples: SwitchoverDrConfigRequestExample: summary: Default switchoverDrConfig request x-microcks-default: true value: drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: Disaster Recovery Switchover Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: SwitchoverDrConfig200Example: summary: Default switchoverDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Switchover a Disaster Recovery Config tags: - Disaster Recovery x-codegen-request-body-name: disaster_recovery_switchover_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/dr_configs/{drUUID}/sync: post: description: 'WARNING: This is a preview API that could change.' operationId: syncDrConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: drUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: SyncDrConfig200Example: summary: Default syncDrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Sync Disaster Recovery Config tags: - Disaster Recovery x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/restore: post: description: Restore from a backup V2. Running restore preflight before calling actual restore is recommended. operationId: restoreBackupV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreBackupParams' examples: RestoreBackupV2RequestExample: summary: Default restoreBackupV2 request x-microcks-default: true value: backupStorageInfoList: - errorIfTablespacesExists: true selectiveTableRestore: true sse: true storageLocation: storageLocation newOwner: newOwner ignoreErrors: true errorIfRolesExists: true backupType: YQL_TABLE_TYPE keyspace: keyspace useRoles: true oldOwner: oldOwner tableNameList: - tableNameList - tableNameList useTablespaces: true - errorIfTablespacesExists: true selectiveTableRestore: true sse: true storageLocation: storageLocation newOwner: newOwner ignoreErrors: true errorIfRolesExists: true backupType: YQL_TABLE_TYPE keyspace: keyspace useRoles: true oldOwner: oldOwner tableNameList: - tableNameList - tableNameList useTablespaces: true expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser parallelism: 6 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK nodeIp: nodeIp prefixUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybcSoftwareVersion: ybcSoftwareVersion alterLoadBalancer: true creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true enableVerboseLogs: true platformVersion: platformVersion disableChecksum: true restoreTimeStamp: restoreTimeStamp sleepAfterTServerRestartMillis: 5 disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybPrevSoftwareVersion: ybPrevSoftwareVersion deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true actionType: RESTORE universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 installYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 restoreToPointInTimeMillis: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 category: YB_BACKUP_SCRIPT cmkArn: cmkArn sleepAfterMasterRestartMillis: 5 useTablespaces: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: Parameters of the backup to be restored required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: RestoreBackupV2200Example: summary: Default restoreBackupV2 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Restore from a Backup V2 tags: - Backups x-codegen-request-body-name: backup x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/restore/advanced_restore_preflight: post: description: 'WARNING: This is a preview API that could change. Advanced restore preflight checks. Recommended to run before actual restore to retrieve the metadata associated with the backup, as well as check for conflicts with existing keyspaces. Additionally, this checks for unsupported tablespaces. In case of restore to PIT this checks whether backup can restore to the timestamp provided, fails otherwise.' operationId: advancedRestorePreflight parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/Parameters for Advanced Restore preflight checks' description: Parameters for advanced restore preflight checks required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestorePreflightResponse' examples: AdvancedRestorePreflight200Example: summary: Default advancedRestorePreflight 200 response x-microcks-default: true value: perLocationBackupInfoMap: key: backupLocation: backupLocation perBackupLocationKeyspaceTables: originalKeyspace: originalKeyspace tableNameList: - tableNameList - tableNameList pointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tablespaceResponse: conflictingTablespaces: - conflictingTablespaces - conflictingTablespaces unsupportedTablespaces: - unsupportedTablespaces - unsupportedTablespaces containsTablespaces: true isYSQLBackup: true isSelectiveRestoreSupported: true backupCategory: YB_BACKUP_SCRIPT hasKMSHistory: true description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Advanced Restore Preflight Checks tags: - Backups x-codegen-request-body-name: AdvancedRestorePreflightParams x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/restore/page: post: operationId: listBackupRestoresV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/RestorePagedApiQuery' examples: ListBackupRestoresV2RequestExample: summary: Default listBackupRestoresV2 request x-microcks-default: true value: filter: showHidden: true dateRangeEnd: '2022-12-12T13:07:18+00:00' storageConfigUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 dateRangeStart: '2022-12-12T13:07:18+00:00' onlyShowDeletedSourceUniverses: true universeNameList: - universeNameList - universeNameList sourceUniverseNameList: - sourceUniverseNameList - sourceUniverseNameList universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 restoreUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 states: - Created - Created offset: 6 needTotalCount: true limit: 0 sortBy: createTime direction: ASC required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestorePagedApiResponse' examples: ListBackupRestoresV2200Example: summary: Default listBackupRestoresV2 200 response x-microcks-default: true value: entities: - restoreSizeInBytes: 6 backupCreatedOnDate: 2022-12-12 13:07:18+00:00 restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateTime: 2022-12-12 13:07:18+00:00 targetUniverseName: targetUniverseName backupType: YQL_TABLE_TYPE universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseName: sourceUniverseName createTime: 2022-12-12 13:07:18+00:00 restoreKeyspaceList: - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isSourceUniversePresent: true state: Created - restoreSizeInBytes: 6 backupCreatedOnDate: 2022-12-12 13:07:18+00:00 restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateTime: 2022-12-12 13:07:18+00:00 targetUniverseName: targetUniverseName backupType: YQL_TABLE_TYPE universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseName: sourceUniverseName createTime: 2022-12-12 13:07:18+00:00 restoreKeyspaceList: - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isSourceUniversePresent: true state: Created hasPrev: true hasNext: true totalCount: 1 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Backup Restores (paginated) tags: - Backups x-codegen-request-body-name: PageRestoresRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/restore/preflight: post: description: Restore preflight checks. Recommended to run before actual restore to retrieve the metadata associated with the backup, as well as check for conflicts with existing keyspaces. Additionally, this checks for unsupported tablespaces. In case of restore to PIT this returns the backup from the backup chain which can be restored to the timestamp provided, fails otherwise. operationId: restorePreflight parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/Parameters for Restore preflight checks' description: Parameters for restore preflight check required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RestorePreflightResponse' examples: RestorePreflight200Example: summary: Default restorePreflight 200 response x-microcks-default: true value: perLocationBackupInfoMap: key: backupLocation: backupLocation perBackupLocationKeyspaceTables: originalKeyspace: originalKeyspace tableNameList: - tableNameList - tableNameList pointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tablespaceResponse: conflictingTablespaces: - conflictingTablespaces - conflictingTablespaces unsupportedTablespaces: - unsupportedTablespaces - unsupportedTablespaces containsTablespaces: true isYSQLBackup: true isSelectiveRestoreSupported: true backupCategory: YB_BACKUP_SCRIPT hasKMSHistory: true description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Restore Preflight Checks tags: - Backups x-codegen-request-body-name: RestorePreflightParams x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/restore/validate_restorable_keyspace_tables: post: description: 'WARNING: This is a preview API that could change. Validate keyspace and tables to Restore against Backup.' operationId: validateKeyspaceTablesToRestore parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/Parameters for validating Restorable keyspace and tables in backup' description: Parameters for validating Restorable keyspace and tables required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: ValidateKeyspaceTablesToRestore200Example: summary: Default validateKeyspaceTablesToRestore 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Validate Keyspace and Tables to Restore Against Backup tags: - Backups x-codegen-request-body-name: RestoreItemsValidationParams x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/schedules: get: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Use 'List schedules V2' instead. operationId: listSchedules parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Schedule' type: array examples: ListSchedules200Example: summary: Default listSchedules 200 response x-microcks-default: true value: - scheduleName: scheduleName ownerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nextScheduleTaskTime: 2022-12-12 13:07:18+00:00 kubernetesOperatorControlled: true incrementBacklogStatus: true frequency: 6 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS taskType: CloudBootstrap nextIncrementScheduleTaskTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true userEmail: userEmail backlogStatus: true failureCount: 0 status: Deleting description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Schedules - Deprecated tags: - Schedule management x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/schedules/page: post: operationId: listSchedulesV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/SchedulePagedApiQuery' examples: ListSchedulesV2RequestExample: summary: Default listSchedulesV2 request x-microcks-default: true value: filter: taskTypes: - CloudBootstrap - CloudBootstrap universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: - Deleting - Deleting offset: 6 needTotalCount: true limit: 0 sortBy: taskType direction: ASC required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SchedulePagedApiResponse' examples: ListSchedulesV2200Example: summary: Default listSchedulesV2 200 response x-microcks-default: true value: entities: - scheduleName: scheduleName tableByTableBackup: true nextExpectedTask: 2022-12-12 13:07:18+00:00 incrementBacklogStatus: true frequency: 5 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS prevCompletedTask: 2022-12-12 13:07:18+00:00 taskType: CloudBootstrap customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 incrementalBackupFrequencyTimeUnit: NANOSECONDS scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true incrementalBackupFrequency: 5 backlogStatus: true backupInfo: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE failureCount: 1 status: Deleting - scheduleName: scheduleName tableByTableBackup: true nextExpectedTask: 2022-12-12 13:07:18+00:00 incrementBacklogStatus: true frequency: 5 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS prevCompletedTask: 2022-12-12 13:07:18+00:00 taskType: CloudBootstrap customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 incrementalBackupFrequencyTimeUnit: NANOSECONDS scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true incrementalBackupFrequency: 5 backlogStatus: true backupInfo: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE failureCount: 1 status: Deleting hasPrev: true hasNext: true totalCount: 2 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Schedules V2 tags: - Schedule management x-codegen-request-body-name: PageScheduleRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/schedules/{sUUID}: delete: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Use 'Delete a schedule V2' instead. operationId: deleteSchedule parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: sUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteSchedule200Example: summary: Default deleteSchedule 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Schedule - Deprecated tags: - Schedule management x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: getSchedule parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: sUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/Schedule' examples: GetSchedule200Example: summary: Default getSchedule 200 response x-microcks-default: true value: scheduleName: scheduleName ownerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nextScheduleTaskTime: 2022-12-12 13:07:18+00:00 kubernetesOperatorControlled: true incrementBacklogStatus: true frequency: 6 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS taskType: CloudBootstrap nextIncrementScheduleTaskTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true userEmail: userEmail backlogStatus: true failureCount: 0 status: Deleting description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Schedule tags: - Schedule management x-microcks-operation: delay: 0 dispatcher: FALLBACK put: deprecated: true description: Deprecated since YBA version 2024.2.0.0.

Use 'Edit a backup schedule async' instead. operationId: editBackupScheduleV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: sUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/EditBackupScheduleParams' examples: EditBackupScheduleV2RequestExample: summary: Default editBackupScheduleV2 request x-microcks-default: true value: cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS incrementalBackupFrequencyTimeUnit: NANOSECONDS timeBeforeDelete: 1 incrementalBackupFrequency: 6 runImmediateBackupOnResume: true frequency: 0 status: Deleting required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Schedule' examples: EditBackupScheduleV2200Example: summary: Default editBackupScheduleV2 200 response x-microcks-default: true value: scheduleName: scheduleName ownerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nextScheduleTaskTime: 2022-12-12 13:07:18+00:00 kubernetesOperatorControlled: true incrementBacklogStatus: true frequency: 6 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS taskType: CloudBootstrap nextIncrementScheduleTaskTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true userEmail: userEmail backlogStatus: true failureCount: 0 status: Deleting description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit a Backup Schedule V2 - Deprecated tags: - Schedule management x-codegen-request-body-name: body x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/schedules/{sUUID}/delete: delete: deprecated: true description: Deprecated since YBA version 2024.2.0.0.

Use 'Delete a backup schedule async' instead. operationId: deleteScheduleV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: sUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: DeleteScheduleV2200Example: summary: Default deleteScheduleV2 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Schedule V2 - Deprecated tags: - Schedule management x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/backups: get: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Use 'List Backups (paginated) V2' instead. operationId: ListOfBackups parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Backup' type: array examples: ListOfBackups200Example: summary: Default ListOfBackups 200 response x-microcks-default: true value: - scheduleName: scheduleName parentBackup: true expiryTimeUnit: NANOSECONDS retryCount: 1 hasKMSHistory: true kubernetesOperatorControlled: true updateTime: 2022-12-12 13:07:18+00:00 incrementalBackup: true taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: V1 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiry: 2022-12-12 13:07:18+00:00 state: DELETED category: YB_BACKUP_SCRIPT firstSnapshotTime: 1 backupInfo: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 universeName: universeName description: successful operation '500': content: application/json: schema: $ref: '#/components/schemas/YBPError' examples: ListOfBackups500Example: summary: Default ListOfBackups 500 response x-microcks-default: true value: success: false requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create error: There was a problem creating the universe httpMethod: POST errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' description: If there was a server or database issue when listing the backups security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List a Customer's Backups - Deprecated tags: - Backups x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/backups/restore: post: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Use 'Restore from a backup V2' instead. operationId: restore parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupTableParams' examples: RestoreRequestExample: summary: Default restore request x-microcks-default: true value: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 description: Parameters of the backup to be restored required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: Restore200Example: summary: Default restore 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Restore from a Backup - Deprecated tags: - Backups x-codegen-request-body-name: backup x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/backups/tasks/{tUUID}: get: operationId: fetchBackupsByTaskUUID parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: tUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Backup' type: array examples: FetchBackupsByTaskUUID200Example: summary: Default fetchBackupsByTaskUUID 200 response x-microcks-default: true value: - scheduleName: scheduleName parentBackup: true expiryTimeUnit: NANOSECONDS retryCount: 1 hasKMSHistory: true kubernetesOperatorControlled: true updateTime: 2022-12-12 13:07:18+00:00 incrementalBackup: true taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: V1 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiry: 2022-12-12 13:07:18+00:00 state: DELETED category: YB_BACKUP_SCRIPT firstSnapshotTime: 1 backupInfo: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 universeName: universeName description: successful operation '500': content: application/json: schema: $ref: '#/components/schemas/YBPError' examples: FetchBackupsByTaskUUID500Example: summary: Default fetchBackupsByTaskUUID 500 response x-microcks-default: true value: success: false requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create error: There was a problem creating the universe httpMethod: POST errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' description: If there was a server or database issue when listing the backups security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List Backups Associated with a Task tags: - Backups x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backup: put: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Use BackupsController. operationId: createMultiTableBackup parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/MultiTableBackupRequestParams' examples: CreateMultiTableBackupRequestExample: summary: Default createMultiTableBackup request x-microcks-default: true value: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 2 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 - backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 3 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 description: Table backup data to be created required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Schedule' examples: CreateMultiTableBackup200Example: summary: Default createMultiTableBackup 200 response x-microcks-default: true value: scheduleName: scheduleName ownerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nextScheduleTaskTime: 2022-12-12 13:07:18+00:00 kubernetesOperatorControlled: true incrementBacklogStatus: true frequency: 6 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS taskType: CloudBootstrap nextIncrementScheduleTaskTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true userEmail: userEmail backlogStatus: true failureCount: 0 status: Deleting description: If requested schedule backup. security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create a Multi-table Backup - Deprecated tags: - Backups x-codegen-request-body-name: Table backup x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/need_bootstrap: post: description: 'WARNING: This is a preview API that could change.' operationId: needBootstrapTable parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: configType schema: default: 'null' type: string example: 'null' - in: query name: includeDetails schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/XClusterConfigNeedBootstrapFormData' examples: NeedBootstrapTableRequestExample: summary: Default needBootstrapTable request x-microcks-default: true value: targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isDrConfig: true tables: '["000033df00003000800000000000400b"]' description: XCluster Need Bootstrap Form Data required: true responses: '200': content: application/json: schema: additionalProperties: properties: {} type: object type: object examples: NeedBootstrapTable200Example: summary: Default needBootstrapTable 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Whether Tables Need Bootstrap Before Setting Up Cross Cluster Replication tags: - Asynchronous Replication x-codegen-request-body-name: xcluster_need_bootstrap_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/delete_backup_schedule_async: delete: description: 'WARNING: This is a preview API that could change. Delete a backup schedule async.' operationId: deleteBackupScheduleAsync parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: sUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: DeleteBackupScheduleAsync200Example: summary: Default deleteBackupScheduleAsync 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete a Backup Schedule Async tags: - Schedule management x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/edit_backup_schedule_async: put: description: 'WARNING: This is a preview API that could change. Edit a backup schedule async.' operationId: editBackupScheduleAsync parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: sUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupScheduleEditParams' examples: EditBackupScheduleAsyncRequestExample: summary: Default editBackupScheduleAsync request x-microcks-default: true value: cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS incrementalBackupFrequencyTimeUnit: NANOSECONDS timeBeforeDelete: 1 schedulingFrequency: 6 incrementalBackupFrequency: 0 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: EditBackupScheduleAsync200Example: summary: Default editBackupScheduleAsync 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit a Backup Schedule Async tags: - Schedule management x-codegen-request-body-name: body x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/schedules/{sUUID}/pause_resume: put: description: 'WARNING: This is a preview API that could change. Toggle a backup schedule. Only allowed to toggle backup schedule state between Active and Stopped.' operationId: toggleBackupSchedule parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: sUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupScheduleToggleParams' examples: ToggleBackupScheduleRequestExample: summary: Default toggleBackupSchedule request x-microcks-default: true value: runImmediateBackupOnResume: true status: Deleting required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: ToggleBackupSchedule200Example: summary: Default toggleBackupSchedule 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Toggle a Backup Schedule tags: - Schedule management x-codegen-request-body-name: body x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backup: put: deprecated: true description: Deprecated since YBA version 2.20.0.0.

Use BackupsController. operationId: createSingleTableBackup parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: tableUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupTableParams' examples: CreateSingleTableBackupRequestExample: summary: Default createSingleTableBackup request x-microcks-default: true value: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 description: Backup data to be created required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: CreateSingleTableBackup200Example: summary: Default createSingleTableBackup 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create a Single-table Backup - Deprecated tags: - Backups x-codegen-request-body-name: Backup x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/ybc_throttle_params: get: operationId: getThrottleParams parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responses: '200': content: application/json: schema: $ref: '#/components/schemas/YbcThrottleParametersResponse' examples: GetThrottleParams200Example: summary: Default getThrottleParams 200 response x-microcks-default: true value: throttleParamsMap: key: presetValues: minValue: 5 defaultValue: 6 maxValue: 1 currentValue: 0 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Throttle Params from YB-Controller tags: - Backups x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Deprecated since YBA version 2025.2.0.0.

Use 'Set throttle params in YB-Controller( async )' instead. operationId: setThrottleParams parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: uniUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/YbcThrottleParameters' examples: SetThrottleParamsRequestExample: summary: Default setThrottleParams request x-microcks-default: true value: diskWriteBytesPerSecond: 6 maxConcurrentDownloads: 1 maxConcurrentUploads: 5 perDownloadNumObjects: 5 diskReadBytesPerSecond: 0 perUploadNumObjects: 2 resetDefaults: true description: Parameters for YB-Controller throttling required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: SetThrottleParams200Example: summary: Default setThrottleParams 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Set Throttle Params in YB-Controller - Deprecated tags: - Backups x-codegen-request-body-name: throttleParams x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/xcluster_configs: post: description: Available since YBA version 2.16.0.0. operationId: createXClusterConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/XClusterConfigCreateFormData' examples: CreateXClusterConfigRequestExample: summary: Default createXClusterConfig request x-microcks-default: true value: targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' dryRun: true bootstrapParams: tables: '["000033df000030008000000000004006"]' allowBootstrap: true backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 name: Repl-config1 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 configType: Basic description: XCluster Replication Create Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: CreateXClusterConfig200Example: summary: Default createXClusterConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create Xcluster Config tags: - Asynchronous Replication x-codegen-request-body-name: xcluster_replication_create_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/xcluster_configs/sync: post: deprecated: true description: Deprecated since YBA version 2.23.0.0.

Sync xcluster config (V2) instead. operationId: syncXClusterConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: targetUniverseUUID schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: SyncXClusterConfig200Example: summary: Default syncXClusterConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Sync Xcluster Config - Deprecated tags: - Asynchronous Replication x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}: delete: description: Available since YBA version 2.16.0.0. operationId: deleteXClusterConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: xccUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: isForceDelete schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: DeleteXClusterConfig200Example: summary: Default deleteXClusterConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete Xcluster Config tags: - Asynchronous Replication x-microcks-operation: delay: 0 dispatcher: FALLBACK get: description: Available since YBA version 2.16.0.0. operationId: getXClusterConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: xccUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: syncWithDB schema: default: true type: boolean example: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/XClusterConfigGetResp' examples: GetXClusterConfig200Example: summary: Default getXClusterConfig 200 response x-microcks-default: true value: paused: true replicationGroupName: replicationGroupName targetUniverseState: Unconfigured for DR type: Basic usedForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: UNKNOWN tables: - tables - tables lag: '{}' modifyTime: 2022-12-12 13:07:18+00:00 targetActive: true imported: true namespaceDetails: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated tableDetails: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: 2022-12-12 13:07:18+00:00 bootstrapCreateTime: 2022-12-12 13:07:18+00:00 indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: 2022-12-12 13:07:18+00:00 bootstrapCreateTime: 2022-12-12 13:07:18+00:00 indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 pitrConfigs: - dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 - dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 secondary: true automaticDdlMode: true dbs: - dbs - dbs createTime: 2022-12-12 13:07:18+00:00 name: name sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspacePending: keyspacePending sourceActive: true namespaces: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated sourceUniverseState: Unconfigured for DR status: Initialized description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Get Xcluster Config tags: - Asynchronous Replication x-microcks-operation: delay: 0 dispatcher: FALLBACK post: description: Available since YBA version 2.16.0.0. operationId: restartXClusterConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: xccUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: isForceDelete schema: default: false type: boolean example: false - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/XClusterConfigRestartFormData' examples: RestartXClusterConfigRequestExample: summary: Default restartXClusterConfig request x-microcks-default: true value: tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' dryRun: true bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 description: XCluster Replication Restart Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: RestartXClusterConfig200Example: summary: Default restartXClusterConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Restart Xcluster Config tags: - Asynchronous Replication x-codegen-request-body-name: xcluster_replication_restart_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: Available since YBA version 2.16.0.0. operationId: editXClusterConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: xccUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/XClusterConfigEditFormData' examples: EditXClusterConfigRequestExample: summary: Default editXClusterConfig request x-microcks-default: true value: tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' dryRun: true bootstrapParams: tables: '["000033df000030008000000000004006"]' allowBootstrap: true backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 dbs: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' autoIncludeIndexTables: true targetRole: ACTIVE name: Repl-config1 sourceRole: ACTIVE status: Running description: XCluster Replication Edit Form Data required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: EditXClusterConfig200Example: summary: Default editXClusterConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Edit Xcluster Config tags: - Asynchronous Replication x-codegen-request-body-name: xcluster_replication_edit_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/need_bootstrap: post: description: YbaApi Internal. operationId: NeedBootstrapXClusterConfig parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: xccUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/XClusterConfigNeedBootstrapFormData' examples: NeedBootstrapXClusterConfigRequestExample: summary: Default NeedBootstrapXClusterConfig request x-microcks-default: true value: targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isDrConfig: true tables: '["000033df00003000800000000000400b"]' description: XCluster Need Bootstrap Form Data required: true responses: '200': content: application/json: schema: additionalProperties: properties: {} type: object type: object examples: NeedBootstrapXClusterConfig200Example: summary: Default NeedBootstrapXClusterConfig 200 response x-microcks-default: true value: {} description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Whether Tables in an XCluster Replication Config Have Fallen Far Behind and Need Bootstrap tags: - Asynchronous Replication x-codegen-request-body-name: xcluster_need_bootstrap_form_data x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/xcluster_configs/{xccUUID}/sync: post: description: Available since YBA version 2.23.0.0 operationId: syncXClusterConfigV2 parameters: - in: path name: cUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: xccUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: SyncXClusterConfigV2200Example: summary: Default syncXClusterConfigV2 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Sync Xcluster Config (V2) tags: - Asynchronous Replication x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{customerUUID}/universes/{universeUUID}/universe_backup: post: description: 'WARNING: This is a preview API that could change.' operationId: Universe Backup parameters: - in: path name: customerUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: path name: universeUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/UniverseBackupRequestFormData' examples: Universe BackupRequestExample: summary: Default Universe Backup request x-microcks-default: true value: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString timeBeforeDelete: 0 platformVersion: platformVersion previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: Universe Backup data to be created required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: Universe Backup200Example: summary: Default Universe Backup 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Create a Universe Backup tags: - Backups x-codegen-request-body-name: Backup Universe x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: apiKeyAuth: description: API token passed as header in: header name: X-AUTH-YW-API-TOKEN type: apiKey schemas: NamespaceSafetime: example: namespaceId: namespaceId safetimeLagUs: 1 estimatedDataLossMs: 0.8008281904610115 safetimeEpochUs: 6 namespaceName: namespaceName safetimeSkewUs: 5 properties: estimatedDataLossMs: format: double type: number example: 1.5 namespaceId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 namespaceName: type: string example: example-namespaceName safetimeEpochUs: format: int64 type: integer example: 1000 safetimeLagUs: format: int64 type: integer example: 1000 safetimeSkewUs: format: int64 type: integer example: 1000 required: - estimatedDataLossMs - namespaceId - namespaceName - safetimeEpochUs - safetimeLagUs - safetimeSkewUs type: object ExtraDependencies: description: Extra dependencies example: installNodeExporter: true properties: installNodeExporter: description: Install node exporter on nodes type: boolean example: true type: object PerLocationBackupInfo: example: backupLocation: backupLocation perBackupLocationKeyspaceTables: originalKeyspace: originalKeyspace tableNameList: - tableNameList - tableNameList pointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tablespaceResponse: conflictingTablespaces: - conflictingTablespaces - conflictingTablespaces unsupportedTablespaces: - unsupportedTablespaces - unsupportedTablespaces containsTablespaces: true isYSQLBackup: true isSelectiveRestoreSupported: true properties: backupLocation: description: Backup location type: string example: example-backupLocation isSelectiveRestoreSupported: description: Whether selective table restore is supported for this backup type: boolean example: true isYSQLBackup: description: Whether backup type is YSQL type: boolean example: true perBackupLocationKeyspaceTables: $ref: '#/components/schemas/PerBackupLocationKeyspaceTables' pointInTimeRestoreWindow: $ref: '#/components/schemas/BackupPointInTimeRestoreWindow' tablespaceResponse: $ref: '#/components/schemas/TablespaceResponse' type: object CommunicationPorts: description: Communication ports example: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 properties: internalYsqlServerRpcPort: description: Internal YSQL RPC port format: int32 type: integer example: 5433 masterHttpPort: description: Master table HTTP port format: int32 type: integer example: 5433 masterRpcPort: description: Master table RCP port format: int32 type: integer example: 5433 nodeExporterPort: description: Node exporter port format: int32 type: integer example: 5433 otelCollectorMetricsPort: description: Otel Collector metrics port format: int32 type: integer example: 5433 redisServerHttpPort: description: Redis HTTP port format: int32 type: integer example: 5433 redisServerRpcPort: description: Redis RPC port format: int32 type: integer example: 5433 tserverHttpPort: description: Tablet server HTTP port format: int32 type: integer example: 5433 tserverRpcPort: description: Tablet server RPC port format: int32 type: integer example: 5433 ybControllerHttpPort: description: Yb controller HTTP port format: int32 type: integer example: 5433 ybControllerrRpcPort: description: Yb controller RPC port format: int32 type: integer example: 5433 yqlServerHttpPort: description: YQL HTTP port format: int32 type: integer example: 5433 yqlServerRpcPort: description: YQL RPC port format: int32 type: integer example: 5433 ysqlServerHttpPort: description: YSQL HTTP port format: int32 type: integer example: 5433 ysqlServerRpcPort: description: YSQL RPC port format: int32 type: integer example: 5433 type: object BackupPointInTimeRestoreWindow: example: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 properties: timestampRetentionWindowEndMillis: format: int64 type: integer example: 1000 timestampRetentionWindowStartMillis: format: int64 type: integer example: 1000 required: - timestampRetentionWindowEndMillis - timestampRetentionWindowStartMillis type: object CustomerConfigData: type: object XClusterConfigGetResp: description: xcluster get response example: paused: true replicationGroupName: replicationGroupName targetUniverseState: Unconfigured for DR type: Basic usedForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: UNKNOWN tables: - tables - tables lag: '{}' modifyTime: 2022-12-12 13:07:18+00:00 targetActive: true imported: true namespaceDetails: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated tableDetails: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: 2022-12-12 13:07:18+00:00 bootstrapCreateTime: 2022-12-12 13:07:18+00:00 indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: 2022-12-12 13:07:18+00:00 bootstrapCreateTime: 2022-12-12 13:07:18+00:00 indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 pitrConfigs: - dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 - dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 secondary: true automaticDdlMode: true dbs: - dbs - dbs createTime: 2022-12-12 13:07:18+00:00 name: name sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspacePending: keyspacePending sourceActive: true namespaces: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated sourceUniverseState: Unconfigured for DR status: Initialized properties: automaticDdlMode: readOnly: true type: boolean example: true createTime: description: Create time of the xCluster config example: 2022-12-12 13:07:18+00:00 format: date-time type: string dbs: items: type: string readOnly: true type: array uniqueItems: true example: - example-dbs imported: description: YbaApi Internal. Whether this xCluster replication config was imported type: boolean example: true keyspacePending: description: 'WARNING: This is a preview API that could change. The keyspace name that the xCluster task is working on; used for disaster recovery' type: string example: example-key lag: description: Lag metric data properties: {} type: object example: {} modifyTime: description: Last modify time of the xCluster config example: 2022-12-12 13:07:18+00:00 format: date-time type: string name: description: XCluster config name type: string example: example-name namespaceDetails: description: Namespaces participating in this xCluster config items: $ref: '#/components/schemas/XClusterNamespaceConfig' readOnly: true type: array uniqueItems: true example: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: '2022-12-12T13:07:18+00:00' sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated namespaces: items: $ref: '#/components/schemas/XClusterNamespaceConfig' type: array uniqueItems: true example: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: '2022-12-12T13:07:18+00:00' sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated paused: description: Whether this xCluster replication config is paused type: boolean example: true pitrConfigs: description: 'WARNING: This is a preview API that could change. The list of PITR configs used for the txn xCluster config' items: $ref: '#/components/schemas/PitrConfig' type: array example: - dbName: dbName updateTime: '2022-12-12T13:07:18+00:00' createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 replicationGroupName: description: Replication group name in the target universe cluster config readOnly: true type: string example: example-replicationGroupName secondary: description: 'WARNING: This is a preview API that could change. Whether this xCluster config is used as a secondary config for a DR config' type: boolean example: true sourceActive: description: Whether the source is active in txn xCluster type: boolean example: true sourceUniverseState: description: 'WARNING: This is a preview API that could change. The replication status of the source universe; used for disaster recovery' enum: - Unconfigured for DR - Ready to replicate - Waiting for DR - Replicating data - Preparing for switchover - Switching to DR replica - Universe marked as DR failed type: string example: Unconfigured for DR sourceUniverseUUID: description: Source Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: description: Status enum: - Initialized - Running - Updating - DeletedUniverse - DeletionFailed - Failed type: string example: Initialized tableDetails: description: Tables participating in this xCluster config items: $ref: '#/components/schemas/XClusterTableConfig' type: array uniqueItems: true example: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: '2022-12-12T13:07:18+00:00' bootstrapCreateTime: '2022-12-12T13:07:18+00:00' indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated tableType: description: tableType enum: - UNKNOWN - YSQL - YCQL type: string example: UNKNOWN tables: items: type: string readOnly: true type: array uniqueItems: true example: - example-tables targetActive: description: Whether the target is active in txn xCluster type: boolean example: true targetUniverseState: description: 'WARNING: This is a preview API that could change. The replication status of the target universe; used for disaster recovery' enum: - Unconfigured for DR - Bootstrapping - Receiving data, Ready for reads - Switching to DR primary - Universe marked as DR failed type: string example: Unconfigured for DR targetUniverseUUID: description: Target Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: description: Whether the config is basic, txn, or db scoped xCluster enum: - Basic - Txn - Db type: string example: Basic usedForDr: description: 'WARNING: This is a preview API that could change. Whether the xCluster config is used as part of a DR config' readOnly: true type: boolean example: true uuid: description: XCluster config UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - lag - namespaces type: object DrConfigReplaceReplicaForm: description: drConfig edit form example: bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: bootstrapParams: $ref: '#/components/schemas/RestartBootstrapParams' drReplicaUniverseUuid: description: New dr replica universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 primaryUniverseUuid: description: The current primary universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object GetWebhookResponse: description: Webhook get response example: uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 url: url properties: url: description: Webhook url type: string example: https://example.com uuid: description: Webhook UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object EncryptionAtRestConfig: description: Encryption at rest configuration example: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK properties: encryptionAtRestEnabled: description: Whether a universe is currently encrypted at rest type: boolean example: true kmsConfigUUID: description: KMS configuration UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 opType: description: 'Operation type: enable, disable, or rotate the universe key/encryption at rest' enum: - ENABLE - DISABLE - UNDEFINED type: string example: ENABLE type: description: Whether to generate a data key or just retrieve the CMK ARN enum: - CMK - DATA_KEY type: string example: CMK type: object NamespaceInfoResp: description: Namespace information response example: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: name: description: Namespace name type: string example: example-name namespaceUUID: description: Namespace UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: description: Table type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE type: object PitrParams: description: PITR parameters example: snapshotIntervalSec: 1 retentionPeriodSec: 6 properties: retentionPeriodSec: description: Retention period of a snapshot in seconds format: int64 type: integer example: 1000 snapshotIntervalSec: description: Deprecated since YBA version 2024.2.0.0. Time interval between snapshots in seconds format: int64 type: integer example: 1000 type: object CloudSpecificInfo: description: Node information reported by the cloud provider example: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type properties: assignPublicIP: description: True if the node has a public IP address assigned type: boolean example: true az: description: The node's availability zone type: string example: example-az cloud: description: The node's cloud provider type: string example: example-cloud instance_type: description: The node's instance type type: string example: DEFAULT kubernetesNamespace: description: Kubernetes namespace type: string example: example-kubernetesNamespace kubernetesPodName: description: Pod name in Kubernetes type: string example: example-kubernetesPodName lun_indexes: description: Mounted disks LUN indexes items: format: int32 type: integer type: array example: - 100 mount_roots: description: Mount roots type: string example: example-mount_roots private_dns: description: The node's private DNS type: string example: example-private_dns private_ip: description: The node's private IP address type: string example: 10.0.0.1 public_dns: description: The node's public DNS name type: string example: example-public_dns public_ip: description: The node's public IP address type: string example: 10.0.0.1 region: description: The node's region type: string example: us-east-1 root_volume: description: Root volume ID or name type: string example: example-root_volume secondary_private_ip: description: Secondary Private IP type: string example: 10.0.0.1 secondary_subnet_id: description: Secondary Subnet IP type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 subnet_id: description: ID of the subnet on which this node is deployed type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useTimeSync: description: True if `use time sync` is enabled type: boolean example: true type: object EditBackupParams: description: Edit backup parameters example: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryTimeUnit: NANOSECONDS timeBeforeDeleteFromPresentInMillis: 0 properties: expiryTimeUnit: description: Time unit for backup expiry enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS storageConfigUUID: description: New backup Storage config format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timeBeforeDeleteFromPresentInMillis: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer example: 1000 type: object YBPTasks: type: object CloudVolumeEncryption: description: Volume encryption settings for AWS EBS volumes example: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: enableVolumeEncryption: description: To enable volume encryption or not type: boolean example: true kmsConfigUUID: description: KMS config UUID to be used for volume encryption format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object UniverseDetailSubset: description: A small subset of universe information example: universePaused: true updateSucceeded: true name: name updateInProgress: true creationDate: 1 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: creationDate: format: int64 type: integer example: 1000 name: type: string example: example-name universePaused: type: boolean example: true updateInProgress: type: boolean example: true updateSucceeded: type: boolean example: true uuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - creationDate - name - universePaused - updateInProgress - updateSucceeded - uuid type: object RegionLocations: example: LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION properties: HOST_BASE: type: string example: yugabyte.example.com LOCATION: type: string example: example-LOCATION REGION: type: string example: us-east-1 required: - HOST_BASE - LOCATION - REGION type: object DrConfigGetResp: description: disaster recovery get response example: paused: true replicationGroupName: replicationGroupName bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 xclusterConfigUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 drReplicaUniverseState: Unconfigured for DR type: Basic uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 xclusterConfigsUuid: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: UNKNOWN tables: - tables - tables modifyTime: 2022-12-12 13:07:18+00:00 primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 drReplicaUniverseActive: true state: Initializing primaryUniverseState: Unconfigured for DR tableDetails: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: 2022-12-12 13:07:18+00:00 bootstrapCreateTime: 2022-12-12 13:07:18+00:00 indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: 2022-12-12 13:07:18+00:00 bootstrapCreateTime: 2022-12-12 13:07:18+00:00 indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated dbDetails: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated pitrConfigs: - dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 - dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 primaryUniverseActive: true automaticDdlMode: true dbs: - dbs - dbs createTime: 2022-12-12 13:07:18+00:00 webhooks: - uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 url: url - uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 url: url name: name drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspacePending: keyspacePending pitrRetentionPeriodSec: 2 pitrSnapshotIntervalSec: 7 status: Initialized properties: automaticDdlMode: description: Whether the config is using automatic DDL replication mode. type: boolean example: true bootstrapParams: $ref: '#/components/schemas/RestartBootstrapParams' createTime: description: Create time of the DR config example: 2022-12-12 13:07:18+00:00 format: date-time type: string dbDetails: description: 'WARNING: This is a preview API that could change. List of db details in replication' items: $ref: '#/components/schemas/XClusterNamespaceConfig' type: array uniqueItems: true example: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: '2022-12-12T13:07:18+00:00' sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated dbs: description: 'WARNING: This is a preview API that could change. List of db ids in replication' items: type: string type: array uniqueItems: true example: - example-dbs drReplicaUniverseActive: description: Whether the dr replica universe is active type: boolean example: true drReplicaUniverseState: description: 'WARNING: This is a preview API that could change. The replication status of the dr replica universe.' enum: - Unconfigured for DR - Bootstrapping - Receiving data, Ready for reads - Switching to DR primary - Universe marked as DR failed type: string example: Unconfigured for DR drReplicaUniverseUuid: description: DR Replica Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspacePending: description: 'WARNING: This is a preview API that could change. The keyspace name that the current task is working on.' type: string example: example-key modifyTime: description: Last modify time of the DR config example: 2022-12-12 13:07:18+00:00 format: date-time type: string name: description: Disaster recovery config name type: string example: example-name paused: description: Whether the underlying xCluster config is paused type: boolean example: true pitrConfigs: description: 'WARNING: This is a preview API that could change. The list of PITR configs used for the underlying txn xCluster config' items: $ref: '#/components/schemas/PitrConfig' type: array example: - dbName: dbName updateTime: '2022-12-12T13:07:18+00:00' createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 pitrRetentionPeriodSec: description: 'WARNING: This is a preview API that could change. PITR Retention Period in seconds' format: int64 type: integer example: 1000 pitrSnapshotIntervalSec: description: 'WARNING: This is a preview API that could change. PITR Retention Period in seconds' format: int64 type: integer example: 1000 primaryUniverseActive: description: Whether the primary universe is active type: boolean example: true primaryUniverseState: description: 'WARNING: This is a preview API that could change. The replication status of the primary universe.' enum: - Unconfigured for DR - Ready to replicate - Waiting for DR - Replicating data - Preparing for switchover - Switching to DR replica - Universe marked as DR failed type: string example: Unconfigured for DR primaryUniverseUuid: description: Primary Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationGroupName: description: Replication group name in the dr replica universe cluster config type: string example: example-replicationGroupName state: description: The state of the DR config enum: - Initializing - Replicating - Switchover in Progress - Failover in Progress - Halted - Updating - Failed type: string example: Initializing status: description: Status enum: - Initialized - Running - Updating - DeletedUniverse - DeletionFailed - Failed type: string example: Initialized tableDetails: description: Details for each table in replication items: $ref: '#/components/schemas/XClusterTableConfig' type: array uniqueItems: true example: - restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: '2022-12-12T13:07:18+00:00' bootstrapCreateTime: '2022-12-12T13:07:18+00:00' indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated tableType: description: The type of tables that are being replicated enum: - UNKNOWN - YSQL - YCQL type: string example: UNKNOWN tables: description: List of table ids in replication items: type: string type: array uniqueItems: true example: - example-tables type: description: Whether the config is basic, txn, or db scoped xCluster enum: - Basic - Txn - Db type: string example: Basic uuid: description: DR config UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 webhooks: items: $ref: '#/components/schemas/GetWebhookResponse' type: array example: - uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 url: url xclusterConfigUuid: description: UUID of the underlying xCluster config that is managing the replication format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 xclusterConfigsUuid: description: YbaApi Internal. The list of xCluster configs' uuids that belong to this dr config items: format: uuid type: string type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - webhooks type: object XClusterConfigCreateFormData: description: xcluster create form example: targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' dryRun: true bootstrapParams: tables: '["000033df000030008000000000004006"]' allowBootstrap: true backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 name: Repl-config1 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 configType: Basic properties: bootstrapParams: $ref: '#/components/schemas/BootstrapParams' configType: description: configType enum: - Basic - Txn type: string example: Basic dryRun: description: Run the pre-checks without actually running the subtasks type: boolean example: true name: description: Name example: Repl-config1 type: string sourceUniverseUUID: description: Source Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tables: description: Source Universe table IDs example: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' items: type: string type: array uniqueItems: true targetUniverseUUID: description: Target Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - name - sourceUniverseUUID - tables - targetUniverseUUID type: object PitrConfig: description: PITR config created on the universe example: dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 properties: createTime: description: Create time of the PITR config example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string createdForDr: description: Created for DR readOnly: true type: boolean example: true customerUUID: description: Customer UUID of this config format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 dbName: description: DB Name type: string example: example-dbName disabled: description: Whether the PITR config is disabled readOnly: true type: boolean example: true intermittentMinRecoverTimeInMillis: description: Intermittent min recovery time in millis if retention period is increased format: int64 type: integer example: 1000 maxRecoverTimeInMillis: format: int64 type: integer example: 10 minRecoverTimeInMillis: format: int64 type: integer example: 1000 name: description: PITR config name type: string example: example-name retentionPeriod: description: Retention Period in seconds format: int64 type: integer example: 1000 scheduleInterval: description: Interval between snasphots in seconds format: int64 type: integer example: 1000 state: enum: - UNKNOWN - CREATING - COMPLETE - DELETING - DELETED - FAILED - CANCELLED - RESTORING - RESTORED type: string example: UNKNOWN tableType: description: Table Type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE updateTime: description: Update time of the PITR con example: 2022-12-12 13:07:18+00:00 format: date-time type: string usedForXCluster: readOnly: true type: boolean example: true uuid: description: PITR config UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - maxRecoverTimeInMillis - minRecoverTimeInMillis - state type: object XClusterConfigNeedBootstrapFormData: example: targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isDrConfig: true tables: '["000033df00003000800000000000400b"]' properties: isDrConfig: description: 'WARNING: This is a preview API that could change. Whether this check is being done as part of a DR configuration setup' type: boolean example: true tables: description: Source universe table IDs to check whether they need bootstrap example: '["000033df00003000800000000000400b"]' items: type: string type: array uniqueItems: true targetUniverseUUID: description: If specified and tables do not exist on the target universe, bootstrapping is required. format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - tables type: object DeleteBackupInfo: example: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: backupUUID: description: backup UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigUUID: description: storage config UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - backupUUID type: object DeleteBackupParams: example: deleteBackupInfos: - storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deleteForcefully: true properties: deleteBackupInfos: description: Backups to be deleted items: $ref: '#/components/schemas/DeleteBackupInfo' type: array example: - storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deleteForcefully: description: Delete Backups forcefully type: boolean example: true required: - deleteBackupInfos type: object DrConfigSafetimeResp: description: Get DR config safetime response example: safetimes: - namespaceId: namespaceId safetimeLagUs: 1 estimatedDataLossMs: 0.8008281904610115 safetimeEpochUs: 6 namespaceName: namespaceName safetimeSkewUs: 5 - namespaceId: namespaceId safetimeLagUs: 1 estimatedDataLossMs: 0.8008281904610115 safetimeEpochUs: 6 namespaceName: namespaceName safetimeSkewUs: 5 properties: safetimes: description: The list of current safetime for each database items: $ref: '#/components/schemas/NamespaceSafetime' type: array example: - namespaceId: namespaceId safetimeLagUs: 1 estimatedDataLossMs: 0.8008281904610115 safetimeEpochUs: 6 namespaceName: namespaceName safetimeSkewUs: 5 type: object BackupInfo: example: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE properties: backupType: enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE expiryTimeUnit: enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS fullBackup: type: boolean example: true keyspaceList: items: $ref: '#/components/schemas/KeyspaceTablesList' type: array example: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: format: int64 type: integer example: 1000 pointInTimeRestoreEnabled: type: boolean example: true storageConfigUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timeBeforeDelete: format: int64 type: integer example: 1000 universeUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: type: boolean example: true useTablespaces: type: boolean example: true required: - backupType - expiryTimeUnit - fullBackup - keyspaceList - parallelism - pointInTimeRestoreEnabled - storageConfigUUID - timeBeforeDelete - universeUUID - useRoles - useTablespaces type: object DrConfigCreateForm: description: drConfig create form example: targetUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 dryRun: true bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 dbs: '["0000412b000030008000000000000000", "0000412b000030008000000000000001"]' name: Dr-config1 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 pitrParams: snapshotIntervalSec: 1 retentionPeriodSec: 6 properties: bootstrapParams: $ref: '#/components/schemas/RestartBootstrapParams' dbs: description: Source Universe DB IDs example: '["0000412b000030008000000000000000", "0000412b000030008000000000000001"]' items: type: string type: array uniqueItems: true dryRun: description: Run the pre-checks without actually running the subtasks type: boolean example: true name: description: Name example: Dr-config1 type: string pitrParams: $ref: '#/components/schemas/PitrParams' sourceUniverseUUID: description: Source Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetUniverseUUID: description: Target Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - dbs - name - sourceUniverseUUID - targetUniverseUUID type: object RestoreBackupParams: example: backupStorageInfoList: - errorIfTablespacesExists: true selectiveTableRestore: true sse: true storageLocation: storageLocation newOwner: newOwner ignoreErrors: true errorIfRolesExists: true backupType: YQL_TABLE_TYPE keyspace: keyspace useRoles: true oldOwner: oldOwner tableNameList: - tableNameList - tableNameList useTablespaces: true - errorIfTablespacesExists: true selectiveTableRestore: true sse: true storageLocation: storageLocation newOwner: newOwner ignoreErrors: true errorIfRolesExists: true backupType: YQL_TABLE_TYPE keyspace: keyspace useRoles: true oldOwner: oldOwner tableNameList: - tableNameList - tableNameList useTablespaces: true expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser parallelism: 6 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK nodeIp: nodeIp prefixUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybcSoftwareVersion: ybcSoftwareVersion alterLoadBalancer: true creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true enableVerboseLogs: true platformVersion: platformVersion disableChecksum: true restoreTimeStamp: restoreTimeStamp sleepAfterTServerRestartMillis: 5 disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybPrevSoftwareVersion: ybPrevSoftwareVersion deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true actionType: RESTORE universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 installYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 restoreToPointInTimeMillis: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 category: YB_BACKUP_SCRIPT cmkArn: cmkArn sleepAfterMasterRestartMillis: 5 useTablespaces: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: actionType: description: Action type enum: - RESTORE - RESTORE_KEYS type: string example: RESTORE alterLoadBalancer: description: Alter load balancer state type: boolean example: true backupStorageInfoList: description: Backup's storage info to restore items: $ref: '#/components/schemas/BackupStorageInfo' type: array example: - errorIfTablespacesExists: true selectiveTableRestore: true sse: true storageLocation: storageLocation newOwner: newOwner ignoreErrors: true errorIfRolesExists: true backupType: YQL_TABLE_TYPE keyspace: keyspace useRoles: true oldOwner: oldOwner tableNameList: - tableNameList - tableNameList useTablespaces: true category: description: Category of the backup enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string example: YB_BACKUP_SCRIPT cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string example: example-cmkArn communicationPorts: $ref: '#/components/schemas/CommunicationPorts' creatingUser: $ref: '#/components/schemas/Users' customerUUID: description: Customer UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: $ref: '#/components/schemas/DeviceInfo' disableChecksum: description: Disable checksum type: boolean example: true disableMultipart: description: Disable multipart upload type: boolean example: true enableVerboseLogs: description: Is verbose logging enabled type: boolean example: true enableYbc: type: boolean example: true encryptionAtRestConfig: $ref: '#/components/schemas/EncryptionAtRestConfig' errorString: description: Error message type: string example: example-errorString expectedUniverseVersion: description: Expected universe version format: int32 type: integer example: 100 extraDependencies: $ref: '#/components/schemas/ExtraDependencies' installYbc: type: boolean example: true kmsConfigUUID: description: KMS configuration UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails' type: array uniqueItems: true example: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 nodeExporterUser: description: Node exporter user type: string example: '5433' nodeIp: description: Node IP type: string example: node-1 parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer example: 100 platformUrl: type: string example: https://example.com platformVersion: readOnly: true type: string example: 2.20.0.0 prefixUUID: description: Prefix UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 restoreTimeStamp: description: Restore TimeStamp type: string example: '2026-05-03T12:00:00Z' restoreToPointInTimeMillis: description: Restore timestamp in millis format: int64 type: integer example: 1000 runOnlyPrechecks: description: YbaApi Internal. Run only prechecks during task run type: boolean example: true sleepAfterMasterRestartMillis: format: int32 type: integer example: 100 sleepAfterTServerRestartMillis: format: int32 type: integer example: 100 sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigUUID: description: Storage config uuid format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: description: Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useTablespaces: description: Is tablespaces information included type: boolean example: true ybPrevSoftwareVersion: description: Previous software version type: string example: 2.20.0.0 ybcInstalled: type: boolean example: true ybcSoftwareVersion: type: string example: 2.20.0.0 required: - creatingUser - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis - universeUUID type: object BootstrapParams: description: Bootstrap parameters example: tables: '["000033df000030008000000000004006"]' allowBootstrap: true backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 properties: allowBootstrap: description: 'WARNING: This is a preview API that could change. Allow backup on whole database when only set of tables require bootstrap' type: boolean example: true backupRequestParams: $ref: '#/components/schemas/BootstrapBackupParams' tables: description: Source Universe table IDs that need bootstrapping; must be a subset of tables in the main body example: '["000033df000030008000000000004006"]' items: type: string type: array uniqueItems: true required: - backupRequestParams type: object Schedule: description: Backup schedule example: scheduleName: scheduleName ownerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nextScheduleTaskTime: 2022-12-12 13:07:18+00:00 kubernetesOperatorControlled: true incrementBacklogStatus: true frequency: 6 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS taskType: CloudBootstrap nextIncrementScheduleTaskTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true userEmail: userEmail backlogStatus: true failureCount: 0 status: Deleting properties: backlogStatus: description: Backlog status of schedule arose due to conflicts readOnly: true type: boolean example: true cronExpression: description: Cron expression for the schedule type: string example: example-cronExpression failureCount: description: Number of failed backup attempts format: int32 readOnly: true type: integer example: 10 frequency: description: Frequency of the schedule, in milli seconds format: int64 type: integer example: 1000 frequencyTimeUnit: description: Time unit of frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS incrementBacklogStatus: description: Backlog status of schedule of incremental backups arose due to conflicts readOnly: true type: boolean example: true kubernetesOperatorControlled: type: boolean example: true nextIncrementScheduleTaskTime: description: Time on which schedule is expected to run for incremental backups example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string nextScheduleTaskTime: description: Time on which schedule is expected to run example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string ownerUUID: description: Owner UUID for the schedule format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 runningState: description: Running state of the schedule type: boolean example: true scheduleName: description: Name of the schedule readOnly: true type: string example: example-scheduleName scheduleUUID: description: Schedule UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: description: Status of the task. Possible values are _Active_, _Paused_, or _Stopped_. enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing readOnly: true type: string example: Deleting taskType: description: Type of task to be scheduled. enum: - CloudBootstrap - CloudCleanup - CreateCassandraTable - CreateUniverse - ReadOnlyClusterCreate - ReadOnlyKubernetesClusterDelete - ReadOnlyClusterDelete - CreateKubernetesUniverse - ReadOnlyKubernetesClusterCreate - DestroyUniverse - PauseUniverse - ResumeUniverse - PauseKubernetesUniverse - ResumeKubernetesUniverse - DestroyKubernetesUniverse - DeleteTable - BackupUniverse - RestoreBackup - MultiTableBackup - CreateBackup - ConfigureDBApis - ConfigureDBApisKubernetes - CreatePitrConfig - UpdatePitrConfig - DeletePitrConfig - RestoreSnapshotSchedule - EditUniverse - EditKubernetesUniverse - ExternalScript - ImportIntoTable - RunApiTriggeredHooks - AddOnClusterCreate - AddOnClusterDelete - UpgradeUniverse - UpdateLoadBalancerConfig - RestartUniverse - RestartUniverseKubernetesUpgrade - SoftwareUpgrade - SoftwareKubernetesUpgrade - KubernetesOverridesUpgrade - GFlagsUpgrade - GFlagsKubernetesUpgrade - CertsRotate - CertsRotateKubernetesUpgrade - TlsToggle - VMImageUpgrade - SystemdUpgrade - RebootUniverse - UpgradeKubernetesUniverse - DeleteNodeFromUniverse - StopNodeInUniverse - StartNodeInUniverse - AddNodeToUniverse - RemoveNodeFromUniverse - RebootNodeInUniverse - ReleaseInstanceFromUniverse - RotateAccessKey - SetUniverseKey - CreateAndRotateAccessKey - CreateKMSConfig - EditKMSConfig - DeleteKMSConfig - UpdateDiskSize - UpdateKubernetesDiskSize - StartMasterOnNode - DeleteXClusterConfig - SyncXClusterConfig - CreateSupportBundle - CreateXClusterConfig - EditXClusterConfig - RestartXClusterConfig - RestartDrConfig - SyncDrConfig - SetDatabasesDrConfig - SetTablesDrConfig - CreateDrConfig - DeleteDrConfig - FailoverDrConfig - SwitchoverDrConfig - SwitchoverDrConfigRollback - EditDrConfig - EditDrConfigParams - PauseXClusterUniverses - ResumeXClusterUniverses - ReinstallNodeAgent - ProvisionUniverseNodes - DeleteCustomerConfig - DeleteCustomerStorageConfig - ResizeNode - CreateTableSpacesInUniverse - ThirdpartySoftwareUpgrade - ModifyAuditLoggingConfig - ModifyKubernetesAuditLoggingConfig - ModifyQueryLoggingConfig - ModifyMetricsExportConfig - InstallYbcSoftware - UpgradeUniverseYbc - UpgradeYbcGFlags - UpgradeKubernetesYbcGFlags - UpdateYbcThrottleFlags - UpdateK8sYbcThrottleFlags - DisableYbc - AddGFlagMetadata - CloudProviderDelete - CreateBackupSchedule - CreateBackupScheduleKubernetes - DeleteBackupSchedule - DeleteBackupScheduleKubernetes - EditBackupSchedule - EditBackupScheduleKubernetes - CloudProviderEdit - SoftwareUpgradeYB - SoftwareKubernetesUpgradeYB - FinalizeUpgrade - FinalizeKubernetesUpgrade - RollbackUpgrade - RollbackKubernetesUpgrade - LdapUniverseSync - ReprovisionNode - ReplaceNodeInUniverse - UpdateProxyConfig - RecommissionNodeInstance - DecommissionNodeInstance - MasterFailover - SyncMasterAddresses - CreateContinuousBackup - CreateYbaBackup - RestoreYbaBackup - RestoreContinuousBackup - EnableNodeAgentInUniverse - DecommissionNode - CloneNamespace - TlsToggleKubernetes - UpdateOOMServiceState - SendUserNotification - ImportUniverse - MigrateUniverse - KubernetesToggleImmutableYbc - OperatorImportUniverse - KubernetesCheckVolumeExpansion - KubernetesPostExpansionCheckVolume - NodeCertReloadTask - UpdateUniverseConfig - CreateRootVolumes - ReplaceRootVolume - ChangeInstanceType - PersistResizeNode - PersistSystemdUpgrade - PersistUseClockbound - UpdateNodeDetails - AddAuthorizedKey - AnsibleClusterServerCtl - AnsibleConfigureServers - AnsibleDestroyServer - PauseServer - ResumeServer - AnsibleSetupServer - AnsibleCreateServer - PrecheckNodeDetached - AnsibleUpdateNodeInfo - BulkImport - ChangeMasterConfig - ChangeAdminPassword - DropTable - CreateTable - DeleteNode - DeleteBackup - DeleteBackupYb - UpdateNodeProcess - DeleteTableFromUniverse - DeleteTablesFromUniverse - DeleteKeyspace - LoadBalancerStateChange - ModifyBlackList - CheckUnderReplicatedTablets - CheckFollowerLag - CheckNodeSafeToDelete - ManipulateDnsRecordTask - RemoveUniverseEntry - SetFlagInMemory - SetNodeState - SwamperTargetsFileUpdate - UniverseUpdateSucceeded - RegisterUniverseWithPaCollector - UnregisterUniverseFromPaCollector - UpdateAndPersistGFlags - UpdateAndPersistKubernetesOverrides - HandleKubernetesNamespacedServices - UpdatePlacementInfo - UpdateSoftwareVersion - UpdateUniverseYbcDetails - YBCBackupSucceeded - UpdateUniverseYbcGflagsDetails - SetYbcThrottleParamsInMemory - VerifyNodeSSHAccess - WaitForDataMove - WaitForLeaderBlacklistCompletion - WaitForFollowerLag - WaitForLoadBalance - WaitForMasterLeader - WaitForServer - WaitForYbcServer - WaitForTServerHeartBeats - DeleteClusterFromUniverse - InstanceActions - WaitForServerReady - WaitForClockSync - WaitForDuration - RunExternalScript - RemoveAuthorizedKey - UpdateUniverseAccessKey - ManageLoadBalancerGroup - BootstrapProducer - CheckBootstrapRequired - DeleteBootstrapIds - XClusterNetworkConnectivityCheck - DeleteReplication - DeleteXClusterConfigEntry - DeleteXClusterTableConfigEntry - DeleteDrConfigEntry - WaitForReplicationDrain - ResetXClusterConfigEntry - SetReplicationPaused - ChangeXClusterRole - SetDrStates - UpdateDrConfigParams - XClusterAddNamespaceToOutboundReplicationGroup - AddNamespaceToXClusterReplication - XClusterRemoveNamespaceFromTargetUniverse - XClusterRemoveNamespaceFromOutboundReplication - SetRestoreTime - XClusterConfigSetup - XClusterConfigSetStatus - XClusterConfigSetStatusForTables - XClusterConfigSetStatusForNamespaces - XClusterConfigModifyTables - XClusterConfigRename - XClusterConfigSync - XClusterConfigUpdateMasterAddresses - XClusterInfoPersist - ReplicateNamespaces - CheckXUniverseAutoFlags - PromoteSecondaryConfigToMainConfig - DeleteRemnantStreams - CreateOutboundReplicationGroup - XClusterDbReplicationSetup - DeleteReplicationOnSource - DeleteXClusterBackupRestoreEntries - AddExistingPitrToXClusterConfig - DrConfigWebhookCall - SetRestoreState - CloudAccessKeyCleanup - CloudAccessKeySetup - CloudInitializer - CloudProviderCleanup - CloudRegionCleanup - CloudRegionSetup - CloudSetup - BackupTable - BackupTableYb - BackupTableYbc - BackupUniverseKeys - RestoreBackupYb - RestoreBackupYbc - RestoreUniverseKeys - RestoreUniverseKeysYb - RestoreUniverseKeysYbc - SetBackupHiddenState - SetRestoreHiddenState - RestorePreflightValidate - BackupPreflightValidate - WaitForLeadersOnPreferredOnly - EnableEncryptionAtRest - DisableEncryptionAtRest - DestroyEncryptionAtRest - KubernetesCommandExecutor - KubernetesWaitForPod - KubernetesCheckNumPod - PodDisruptionBudgetPolicy - SetActiveUniverseKeys - WaitForEncryptionKeyInMemory - UnivSetCertificate - CreateAlertDefinitions - ManageAlertDefinitions - ManageCatalogUpgradeSuperUser - UpdatePitrConfigIntermittentMinRecoverTime - MarkSourceMetric - UniverseSetTlsParams - UniverseUpdateRootCert - ResetUniverseVersion - DeleteCertificate - SetNodeStatus - CheckMasterLeader - CheckMasters - CheckTServers - WaitForTServerHBs - CreatePrometheusSwamperConfig - PreflightNodeCheck - RunYsqlUpgrade - PromoteAutoFlags - UpdateSoftwareUpdatePrevConfig - RollbackAutoFlags - StoreAutoFlagConfigVersion - CheckUpgrade - CheckCertificateConfig - CheckMemory - CheckLocale - CheckShellConnectivity - CheckGlibc - CheckOpentelemetryOperator - PGUpgradeTServerCheck - CleanUpPGUpgradeDataDir - RunYsqlMajorVersionCatalogUpgrade - RollbackYsqlMajorVersionCatalogUpgrade - FinalizeYsqlMajorCatalogUpgrade - ValidateGFlags - CheckSoftwareVersion - UpdateMountedDisks - TransferXClusterCerts - CreateTableSpaces - ManageOtelCollector - UpdateAndPersistAuditLoggingConfig - UpdateAndPersistQueryLoggingConfig - UpdateAndPersistMetricsExportConfig - MarkUniverseForHealthScriptReUpload - RebootServer - HardRebootServer - RunHooks - UpdateUniverseTags - UpgradeYbc - InstallYbcSoftwareOnK8s - InstanceExistCheck - DeleteRootVolumes - InstallingThirdPartySoftware - InstallNodeAgent - WaitForNodeAgent - CloudImageBundleSetup - UpdateClusterUserIntent - UpdateClusterAPIDetails - UpdateUniverseState - UpdateUniverseCommunicationPorts - UpdateUniverseIntent - UpdateConsistencyCheck - FreezeUniverse - QueryLdapServer - DbLdapSync - CheckForClusterServers - CheckLeaderlessTablets - CheckNodesAreSafeToTakeDown - ValidateNodeDiskSize - CheckNodeReachable - CheckDbNodePortConnectivity - SupportBundleComponentDownload - WaitStartingFromTime - RemoveNodeAgent - UpdateUniverseFields - RunNodeCommand - MasterLeaderStepdown - SetupYNP - YNPProvisioning - ConfigureOOMServiceOnNode - CheckSshConnection - FetchServerConf - DoCapacityReservation - DeleteCapacityReservation - DisablePitrConfig - EnablePitrConfig - UpdateAndPersistKubernetesImmutableYbc - TablespaceValidationOnRemove - CheckServiceLiveness - CheckNodeCommandExecution - CheckNodeDataDirDiskSpace - OperatorImportResource - UpdateParentTaskParams type: string example: CloudBootstrap useLocalTimezone: description: Whether to use local timezone with cron expression for the schedule type: boolean example: true userEmail: description: User who created the schedule policy readOnly: true type: string example: admin@example.com required: - kubernetesOperatorControlled type: object BackupStorageInfo: description: Backup Storage Info for doing restore operation example: errorIfTablespacesExists: true selectiveTableRestore: true sse: true storageLocation: storageLocation newOwner: newOwner ignoreErrors: true errorIfRolesExists: true backupType: YQL_TABLE_TYPE keyspace: keyspace useRoles: true oldOwner: oldOwner tableNameList: - tableNameList - tableNameList useTablespaces: true properties: backupType: description: Backup type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE errorIfRolesExists: description: 'WARNING: This is a preview API that could change. Fail if roles exist with same names.Only applicable with new roles behavior.' type: boolean example: true errorIfTablespacesExists: description: 'WARNING: This is a preview API that could change. Fail if tablespaces exist with same names. Only applicable with new roles behavior.' type: boolean example: true ignoreErrors: description: 'WARNING: This is a preview API that could change. Ignore all restore errors' type: boolean example: true keyspace: description: Keyspace name type: string example: example-key newOwner: description: User name of the new tables owner type: string example: example-newOwner oldOwner: description: User name of the current tables owner type: string example: example-oldOwner selectiveTableRestore: description: Only restore selected tables instead of restoring all tables in backup type: boolean example: true sse: description: Is SSE type: boolean example: true storageLocation: description: Storage location type: string example: example-storageLocation tableNameList: description: Tables items: type: string type: array example: - example-tableNameList useRoles: description: Restore global ysql roles type: boolean example: true useTablespaces: description: Use tablespaces during restore type: boolean example: true type: object BackupScheduleEditParams: example: cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS incrementalBackupFrequencyTimeUnit: NANOSECONDS timeBeforeDelete: 1 schedulingFrequency: 6 incrementalBackupFrequency: 0 properties: cronExpression: description: Cron expression for scheduling type: string example: example-cronExpression frequencyTimeUnit: description: Time Unit for frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS incrementalBackupFrequency: description: Frequency of incremental backup schedule format: int64 type: integer example: 1000 incrementalBackupFrequencyTimeUnit: description: TimeUnit for incremental Backup Schedule frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS schedulingFrequency: description: Frequency of the schedule format: int64 type: integer example: 1000 timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer example: 1000 type: object KeyspaceTable: description: Keyspace and table info for backup example: keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: keyspace: description: keyspace type: string example: example-key tableNameList: description: Tables items: type: string type: array example: - example-tableNameList tableUUIDList: description: Table UUIDs items: format: uuid type: string type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object BackupScheduleToggleParams: example: runImmediateBackupOnResume: true status: Deleting properties: runImmediateBackupOnResume: description: Run a full or incremental backup if required when resuming a stopped schedule. When false (default), the full backup will instead run at its normally scheduled time. type: boolean example: true status: description: State of the schedule enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string example: Deleting required: - status type: object XClusterTableConfig: example: restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 streamId: a9d2470786694dc4b34e0e58e592da9e backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationStatusErrors: - Unknown error - Unknown error sourceTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId replicationSetupDone: true restoreTime: 2022-12-12 13:07:18+00:00 bootstrapCreateTime: 2022-12-12 13:07:18+00:00 indexTable: true tableId: 000033df000030008000000000004005 targetTableInfo: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId needBootstrap: true status: Validated properties: backupUuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 bootstrapCreateTime: description: Time of the bootstrap of the table example: 2022-12-12 13:07:18+00:00 format: date-time type: string indexTable: description: YbaApi Internal. Whether this table is an index table and its main table is in replication type: boolean example: true needBootstrap: description: YbaApi Internal. Whether this table needs bootstrap process for replication setup type: boolean example: true replicationSetupDone: description: YbaApi Internal. Whether replication is set up for this table type: boolean example: true replicationStatusErrors: description: Short human readable replication status error messages items: enum: - Unknown error - Missing op ID - Schema mismatch - Missing table - Uninitialized - Auto flag config mismatch - Source unreachable - System error type: string type: array uniqueItems: true example: - Unknown error restoreTime: description: Time of the last try to restore data to the target universe example: 2022-12-12 13:07:18+00:00 format: date-time type: string restoreUuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceTableInfo: $ref: '#/components/schemas/TableInfoResp' status: description: Status enum: - Validated - Running - Updating - Warning - Error - Bootstrapping - Failed - UnableToFetch type: string example: Validated streamId: description: Stream ID if replication is setup; bootstrap ID if the table is bootstrapped example: a9d2470786694dc4b34e0e58e592da9e type: string tableId: description: Table ID example: 000033df000030008000000000004005 type: string targetTableInfo: $ref: '#/components/schemas/TableInfoResp' required: - backupUuid - restoreUuid type: object BackupPagedApiResponse: example: entities: - scheduleName: scheduleName isFullBackup: true expiryTimeUnit: NANOSECONDS hasIncrementalBackups: true lastBackupState: InProgress commonBackupInfo: tableByTableBackup: true sse: true updateTime: 2022-12-12 13:07:18+00:00 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 responseList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation state: InProgress totalBackupSizeInBytes: 5 backupType: YQL_TABLE_TYPE isUniversePresent: true onDemand: true universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 lastIncrementalBackupTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryTime: 2022-12-12 13:07:18+00:00 fullChainSizeInBytes: 5 isStorageConfigPresent: true category: YB_BACKUP_SCRIPT useTablespaces: true storageConfigType: S3 universeName: universeName - scheduleName: scheduleName isFullBackup: true expiryTimeUnit: NANOSECONDS hasIncrementalBackups: true lastBackupState: InProgress commonBackupInfo: tableByTableBackup: true sse: true updateTime: 2022-12-12 13:07:18+00:00 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 responseList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation state: InProgress totalBackupSizeInBytes: 5 backupType: YQL_TABLE_TYPE isUniversePresent: true onDemand: true universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 lastIncrementalBackupTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryTime: 2022-12-12 13:07:18+00:00 fullChainSizeInBytes: 5 isStorageConfigPresent: true category: YB_BACKUP_SCRIPT useTablespaces: true storageConfigType: S3 universeName: universeName hasPrev: true hasNext: true totalCount: 2 properties: entities: items: $ref: '#/components/schemas/BackupResp' type: array example: - scheduleName: scheduleName isFullBackup: true expiryTimeUnit: NANOSECONDS hasIncrementalBackups: true lastBackupState: InProgress commonBackupInfo: tableByTableBackup: true sse: true updateTime: '2022-12-12T13:07:18+00:00' kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: '2022-12-12T13:07:18+00:00' storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' responseList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation state: InProgress totalBackupSizeInBytes: 5 backupType: YQL_TABLE_TYPE isUniversePresent: true onDemand: true universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 lastIncrementalBackupTime: '2022-12-12T13:07:18+00:00' scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryTime: '2022-12-12T13:07:18+00:00' fullChainSizeInBytes: 5 isStorageConfigPresent: true category: YB_BACKUP_SCRIPT useTablespaces: true storageConfigType: S3 universeName: universeName hasNext: type: boolean example: true hasPrev: type: boolean example: true totalCount: format: int32 type: integer example: 10 required: - entities - hasNext - hasPrev - totalCount type: object PerBackupLocationKeyspaceTables: example: originalKeyspace: originalKeyspace tableNameList: - tableNameList - tableNameList properties: originalKeyspace: description: Original keyspace name type: string example: example-key tableNameList: description: List of parent tables associated with the keyspace items: type: string type: array example: - example-tableNameList type: object ThrottleParamValue: example: presetValues: minValue: 5 defaultValue: 6 maxValue: 1 currentValue: 0 properties: currentValue: format: int64 type: integer example: 1000 presetValues: $ref: '#/components/schemas/PresetThrottleValues' required: - currentValue - presetValues type: object BackupPagedApiQuery: example: filter: showHidden: true dateRangeEnd: 2022-12-12 13:07:18+00:00 storageConfigUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspaceList: - keyspaceList - keyspaceList dateRangeStart: 2022-12-12 13:07:18+00:00 backupUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 scheduleUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeNameList: - universeNameList - universeNameList onlyShowDeletedConfigs: true universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 onlyShowDeletedUniverses: true states: - InProgress - InProgress offset: 6 needTotalCount: true limit: 0 sortBy: createTime direction: ASC properties: direction: enum: - ASC - DESC type: string example: ASC filter: $ref: '#/components/schemas/BackupApiFilter' limit: format: int32 type: integer example: 10 needTotalCount: type: boolean example: true offset: format: int32 type: integer example: 100 sortBy: enum: - createTime type: string example: createTime required: - direction - filter - limit - needTotalCount - offset - sortBy type: object ScheduleApiFilter: example: taskTypes: - CloudBootstrap - CloudBootstrap universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: - Deleting - Deleting properties: status: items: enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string type: array uniqueItems: true example: - Deleting taskTypes: items: enum: - CloudBootstrap - CloudCleanup - CreateCassandraTable - CreateUniverse - ReadOnlyClusterCreate - ReadOnlyKubernetesClusterDelete - ReadOnlyClusterDelete - CreateKubernetesUniverse - ReadOnlyKubernetesClusterCreate - DestroyUniverse - PauseUniverse - ResumeUniverse - PauseKubernetesUniverse - ResumeKubernetesUniverse - DestroyKubernetesUniverse - DeleteTable - BackupUniverse - RestoreBackup - MultiTableBackup - CreateBackup - ConfigureDBApis - ConfigureDBApisKubernetes - CreatePitrConfig - UpdatePitrConfig - DeletePitrConfig - RestoreSnapshotSchedule - EditUniverse - EditKubernetesUniverse - ExternalScript - ImportIntoTable - RunApiTriggeredHooks - AddOnClusterCreate - AddOnClusterDelete - UpgradeUniverse - UpdateLoadBalancerConfig - RestartUniverse - RestartUniverseKubernetesUpgrade - SoftwareUpgrade - SoftwareKubernetesUpgrade - KubernetesOverridesUpgrade - GFlagsUpgrade - GFlagsKubernetesUpgrade - CertsRotate - CertsRotateKubernetesUpgrade - TlsToggle - VMImageUpgrade - SystemdUpgrade - RebootUniverse - UpgradeKubernetesUniverse - DeleteNodeFromUniverse - StopNodeInUniverse - StartNodeInUniverse - AddNodeToUniverse - RemoveNodeFromUniverse - RebootNodeInUniverse - ReleaseInstanceFromUniverse - RotateAccessKey - SetUniverseKey - CreateAndRotateAccessKey - CreateKMSConfig - EditKMSConfig - DeleteKMSConfig - UpdateDiskSize - UpdateKubernetesDiskSize - StartMasterOnNode - DeleteXClusterConfig - SyncXClusterConfig - CreateSupportBundle - CreateXClusterConfig - EditXClusterConfig - RestartXClusterConfig - RestartDrConfig - SyncDrConfig - SetDatabasesDrConfig - SetTablesDrConfig - CreateDrConfig - DeleteDrConfig - FailoverDrConfig - SwitchoverDrConfig - SwitchoverDrConfigRollback - EditDrConfig - EditDrConfigParams - PauseXClusterUniverses - ResumeXClusterUniverses - ReinstallNodeAgent - ProvisionUniverseNodes - DeleteCustomerConfig - DeleteCustomerStorageConfig - ResizeNode - CreateTableSpacesInUniverse - ThirdpartySoftwareUpgrade - ModifyAuditLoggingConfig - ModifyKubernetesAuditLoggingConfig - ModifyQueryLoggingConfig - ModifyMetricsExportConfig - InstallYbcSoftware - UpgradeUniverseYbc - UpgradeYbcGFlags - UpgradeKubernetesYbcGFlags - UpdateYbcThrottleFlags - UpdateK8sYbcThrottleFlags - DisableYbc - AddGFlagMetadata - CloudProviderDelete - CreateBackupSchedule - CreateBackupScheduleKubernetes - DeleteBackupSchedule - DeleteBackupScheduleKubernetes - EditBackupSchedule - EditBackupScheduleKubernetes - CloudProviderEdit - SoftwareUpgradeYB - SoftwareKubernetesUpgradeYB - FinalizeUpgrade - FinalizeKubernetesUpgrade - RollbackUpgrade - RollbackKubernetesUpgrade - LdapUniverseSync - ReprovisionNode - ReplaceNodeInUniverse - UpdateProxyConfig - RecommissionNodeInstance - DecommissionNodeInstance - MasterFailover - SyncMasterAddresses - CreateContinuousBackup - CreateYbaBackup - RestoreYbaBackup - RestoreContinuousBackup - EnableNodeAgentInUniverse - DecommissionNode - CloneNamespace - TlsToggleKubernetes - UpdateOOMServiceState - SendUserNotification - ImportUniverse - MigrateUniverse - KubernetesToggleImmutableYbc - OperatorImportUniverse - KubernetesCheckVolumeExpansion - KubernetesPostExpansionCheckVolume - NodeCertReloadTask - UpdateUniverseConfig - CreateRootVolumes - ReplaceRootVolume - ChangeInstanceType - PersistResizeNode - PersistSystemdUpgrade - PersistUseClockbound - UpdateNodeDetails - AddAuthorizedKey - AnsibleClusterServerCtl - AnsibleConfigureServers - AnsibleDestroyServer - PauseServer - ResumeServer - AnsibleSetupServer - AnsibleCreateServer - PrecheckNodeDetached - AnsibleUpdateNodeInfo - BulkImport - ChangeMasterConfig - ChangeAdminPassword - DropTable - CreateTable - DeleteNode - DeleteBackup - DeleteBackupYb - UpdateNodeProcess - DeleteTableFromUniverse - DeleteTablesFromUniverse - DeleteKeyspace - LoadBalancerStateChange - ModifyBlackList - CheckUnderReplicatedTablets - CheckFollowerLag - CheckNodeSafeToDelete - ManipulateDnsRecordTask - RemoveUniverseEntry - SetFlagInMemory - SetNodeState - SwamperTargetsFileUpdate - UniverseUpdateSucceeded - RegisterUniverseWithPaCollector - UnregisterUniverseFromPaCollector - UpdateAndPersistGFlags - UpdateAndPersistKubernetesOverrides - HandleKubernetesNamespacedServices - UpdatePlacementInfo - UpdateSoftwareVersion - UpdateUniverseYbcDetails - YBCBackupSucceeded - UpdateUniverseYbcGflagsDetails - SetYbcThrottleParamsInMemory - VerifyNodeSSHAccess - WaitForDataMove - WaitForLeaderBlacklistCompletion - WaitForFollowerLag - WaitForLoadBalance - WaitForMasterLeader - WaitForServer - WaitForYbcServer - WaitForTServerHeartBeats - DeleteClusterFromUniverse - InstanceActions - WaitForServerReady - WaitForClockSync - WaitForDuration - RunExternalScript - RemoveAuthorizedKey - UpdateUniverseAccessKey - ManageLoadBalancerGroup - BootstrapProducer - CheckBootstrapRequired - DeleteBootstrapIds - XClusterNetworkConnectivityCheck - DeleteReplication - DeleteXClusterConfigEntry - DeleteXClusterTableConfigEntry - DeleteDrConfigEntry - WaitForReplicationDrain - ResetXClusterConfigEntry - SetReplicationPaused - ChangeXClusterRole - SetDrStates - UpdateDrConfigParams - XClusterAddNamespaceToOutboundReplicationGroup - AddNamespaceToXClusterReplication - XClusterRemoveNamespaceFromTargetUniverse - XClusterRemoveNamespaceFromOutboundReplication - SetRestoreTime - XClusterConfigSetup - XClusterConfigSetStatus - XClusterConfigSetStatusForTables - XClusterConfigSetStatusForNamespaces - XClusterConfigModifyTables - XClusterConfigRename - XClusterConfigSync - XClusterConfigUpdateMasterAddresses - XClusterInfoPersist - ReplicateNamespaces - CheckXUniverseAutoFlags - PromoteSecondaryConfigToMainConfig - DeleteRemnantStreams - CreateOutboundReplicationGroup - XClusterDbReplicationSetup - DeleteReplicationOnSource - DeleteXClusterBackupRestoreEntries - AddExistingPitrToXClusterConfig - DrConfigWebhookCall - SetRestoreState - CloudAccessKeyCleanup - CloudAccessKeySetup - CloudInitializer - CloudProviderCleanup - CloudRegionCleanup - CloudRegionSetup - CloudSetup - BackupTable - BackupTableYb - BackupTableYbc - BackupUniverseKeys - RestoreBackupYb - RestoreBackupYbc - RestoreUniverseKeys - RestoreUniverseKeysYb - RestoreUniverseKeysYbc - SetBackupHiddenState - SetRestoreHiddenState - RestorePreflightValidate - BackupPreflightValidate - WaitForLeadersOnPreferredOnly - EnableEncryptionAtRest - DisableEncryptionAtRest - DestroyEncryptionAtRest - KubernetesCommandExecutor - KubernetesWaitForPod - KubernetesCheckNumPod - PodDisruptionBudgetPolicy - SetActiveUniverseKeys - WaitForEncryptionKeyInMemory - UnivSetCertificate - CreateAlertDefinitions - ManageAlertDefinitions - ManageCatalogUpgradeSuperUser - UpdatePitrConfigIntermittentMinRecoverTime - MarkSourceMetric - UniverseSetTlsParams - UniverseUpdateRootCert - ResetUniverseVersion - DeleteCertificate - SetNodeStatus - CheckMasterLeader - CheckMasters - CheckTServers - WaitForTServerHBs - CreatePrometheusSwamperConfig - PreflightNodeCheck - RunYsqlUpgrade - PromoteAutoFlags - UpdateSoftwareUpdatePrevConfig - RollbackAutoFlags - StoreAutoFlagConfigVersion - CheckUpgrade - CheckCertificateConfig - CheckMemory - CheckLocale - CheckShellConnectivity - CheckGlibc - CheckOpentelemetryOperator - PGUpgradeTServerCheck - CleanUpPGUpgradeDataDir - RunYsqlMajorVersionCatalogUpgrade - RollbackYsqlMajorVersionCatalogUpgrade - FinalizeYsqlMajorCatalogUpgrade - ValidateGFlags - CheckSoftwareVersion - UpdateMountedDisks - TransferXClusterCerts - CreateTableSpaces - ManageOtelCollector - UpdateAndPersistAuditLoggingConfig - UpdateAndPersistQueryLoggingConfig - UpdateAndPersistMetricsExportConfig - MarkUniverseForHealthScriptReUpload - RebootServer - HardRebootServer - RunHooks - UpdateUniverseTags - UpgradeYbc - InstallYbcSoftwareOnK8s - InstanceExistCheck - DeleteRootVolumes - InstallingThirdPartySoftware - InstallNodeAgent - WaitForNodeAgent - CloudImageBundleSetup - UpdateClusterUserIntent - UpdateClusterAPIDetails - UpdateUniverseState - UpdateUniverseCommunicationPorts - UpdateUniverseIntent - UpdateConsistencyCheck - FreezeUniverse - QueryLdapServer - DbLdapSync - CheckForClusterServers - CheckLeaderlessTablets - CheckNodesAreSafeToTakeDown - ValidateNodeDiskSize - CheckNodeReachable - CheckDbNodePortConnectivity - SupportBundleComponentDownload - WaitStartingFromTime - RemoveNodeAgent - UpdateUniverseFields - RunNodeCommand - MasterLeaderStepdown - SetupYNP - YNPProvisioning - ConfigureOOMServiceOnNode - CheckSshConnection - FetchServerConf - DoCapacityReservation - DeleteCapacityReservation - DisablePitrConfig - EnablePitrConfig - UpdateAndPersistKubernetesImmutableYbc - TablespaceValidationOnRemove - CheckServiceLiveness - CheckNodeCommandExecution - CheckNodeDataDirDiskSpace - OperatorImportResource - UpdateParentTaskParams type: string type: array uniqueItems: true example: - CloudBootstrap universeUUIDList: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - status - taskTypes - universeUUIDList type: object YBPError: description: Generic error response from the YugabyteDB Anywhere API example: success: false requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create error: There was a problem creating the universe httpMethod: POST errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }' properties: error: description: User-visible unstructured error message example: There was a problem creating the universe type: string errorJson: description: User visible structured error message as json object example: '{ "foo" : "bar", "baz" : [1, 2, 3] }' properties: {} type: object httpMethod: description: Method for HTTP call that resulted in this error example: POST type: string requestJson: description: User request JSON object example: '{ "foo" : "bar", "baz" : [1, 2, 3] }' properties: {} type: object requestUri: description: URI for HTTP request that resulted in this error example: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create type: string success: description: Always set to false to indicate failure example: false type: boolean type: object PresetThrottleValues: example: minValue: 5 defaultValue: 6 maxValue: 1 properties: defaultValue: format: int64 type: integer example: 1000 maxValue: format: int64 type: integer example: 10 minValue: format: int64 type: integer example: 1000 required: - defaultValue - maxValue - minValue type: object DrConfigRestartForm: description: dr config restart form example: bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 dbs: '["0000412b000030008000000000000000", "0000412b000030008000000000000001"]' properties: bootstrapParams: $ref: '#/components/schemas/RestartBootstrapParams' dbs: description: Primary Universe DB IDs example: '["0000412b000030008000000000000000", "0000412b000030008000000000000001"]' items: type: string type: array uniqueItems: true required: - dbs type: object XClusterNamespaceConfig: example: restoreUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: sourceNamespaceId backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: 2022-12-12 13:07:18+00:00 sourceNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 targetNamespaceInfo: tableType: YQL_TABLE_TYPE name: name namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: Validated properties: backupUuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 replicationSetupTime: description: Time of replication setup, ie, table added to the replication group on the target universe example: 2022-12-12 13:07:18+00:00 format: date-time type: string restoreUuid: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceId: type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceNamespaceInfo: $ref: '#/components/schemas/NamespaceInfoResp' status: description: Status enum: - Validated - Running - Updating - Warning - Error - Bootstrapping - Failed type: string example: Validated targetNamespaceInfo: $ref: '#/components/schemas/NamespaceInfoResp' required: - backupUuid - restoreUuid - sourceNamespaceId type: object BackupApiFilter: example: showHidden: true dateRangeEnd: 2022-12-12 13:07:18+00:00 storageConfigUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspaceList: - keyspaceList - keyspaceList dateRangeStart: 2022-12-12 13:07:18+00:00 backupUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 scheduleUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeNameList: - universeNameList - universeNameList onlyShowDeletedConfigs: true universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 onlyShowDeletedUniverses: true states: - InProgress - InProgress properties: backupUUIDList: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 dateRangeEnd: description: The end date for backup filter. example: 2022-12-12 13:07:18+00:00 format: date-time type: string dateRangeStart: description: The start date for backup filter. example: 2022-12-12 13:07:18+00:00 format: date-time type: string keyspaceList: items: type: string type: array uniqueItems: true example: - example-key onlyShowDeletedConfigs: type: boolean example: true onlyShowDeletedUniverses: type: boolean example: true scheduleUUIDList: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 showHidden: type: boolean example: true states: items: enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopping - Stopped - QueuedForDeletion - QueuedForForcedDeletion - DeleteInProgress type: string type: array uniqueItems: true example: - InProgress storageConfigUUIDList: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeNameList: items: type: string type: array uniqueItems: true example: - example-universeNameList universeUUIDList: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - backupUUIDList - keyspaceList - onlyShowDeletedConfigs - onlyShowDeletedUniverses - scheduleUUIDList - showHidden - states - storageConfigUUIDList - universeNameList - universeUUIDList type: object SchedulePagedApiQuery: example: filter: taskTypes: - CloudBootstrap - CloudBootstrap universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: - Deleting - Deleting offset: 6 needTotalCount: true limit: 0 sortBy: taskType direction: ASC properties: direction: enum: - ASC - DESC type: string example: ASC filter: $ref: '#/components/schemas/ScheduleApiFilter' limit: format: int32 type: integer example: 10 needTotalCount: type: boolean example: true offset: format: int32 type: integer example: 100 sortBy: enum: - taskType - scheduleUUID - scheduleName type: string example: taskType required: - direction - filter - limit - needTotalCount - offset - sortBy type: object UniverseBackupRequestFormData: description: Universe Backup Form Data example: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString timeBeforeDelete: 0 platformVersion: platformVersion previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: errorString: description: Error message type: string example: example-errorString platformVersion: readOnly: true type: string example: 2.20.0.0 previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigUUID: description: 'WARNING: This is a preview API that could change.Storage configuration UUID' format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timeBeforeDelete: description: 'WARNING: This is a preview API that could change.Time before deleting the backup from storage, in milliseconds' format: int64 type: integer example: 1000 required: - storageConfigUUID type: object DrConfigFailoverForm: description: drConfig failover form example: namespaceIdSafetimeEpochUsMap: key: 0 drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: drReplicaUniverseUuid: description: New dr replica universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 namespaceIdSafetimeEpochUsMap: additionalProperties: format: int64 type: integer description: A map from database ID to its safetime since epoch in micro-seconds to use during unplanned failover type: object example: {} primaryUniverseUuid: description: New primary universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object XClusterConfigRestartFormData: description: xcluster restart form example: tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' dryRun: true bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 properties: bootstrapParams: $ref: '#/components/schemas/RestartBootstrapParams' dryRun: description: Run the pre-checks without actually running the subtasks type: boolean example: true tables: description: Source Universe table IDs; if empty, the whole config will restart example: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' items: type: string type: array uniqueItems: true required: - tables type: object RestartBootstrapParams: description: Bootstrap parameters for restarting example: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 properties: backupRequestParams: $ref: '#/components/schemas/BootstrapBackupParams' required: - backupRequestParams type: object BackupTableParams: description: Backup table parameters example: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 properties: actionType: description: Action type enum: - CREATE - RESTORE - RESTORE_KEYS - DELETE type: string example: CREATE allTables: description: Backup all tables in Keyspace type: boolean example: true alterLoadBalancer: description: Alter load balancer state type: boolean example: true backupList: description: Backups items: $ref: '#/components/schemas/BackupTableParams' type: array example: - backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 backupPointInTimeRestoreWindow: $ref: '#/components/schemas/BackupPointInTimeRestoreWindow' backupSizeInBytes: description: Backup size in bytes format: int64 type: integer example: 10 backupType: description: Backup type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE backupUuid: description: Backup UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: description: Base backup UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string example: example-cmkArn communicationPorts: $ref: '#/components/schemas/CommunicationPorts' creatingUser: $ref: '#/components/schemas/Users' cronExpression: description: Cron expression for a recurring backup type: string example: example-cronExpression customerUuid: description: Customer UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: $ref: '#/components/schemas/DeviceInfo' disableChecksum: description: Disable checksum type: boolean example: true disableMultipart: description: Disable multipart upload type: boolean example: true disableParallelism: description: Don't add -m flag during gsutil upload dir command type: boolean example: true enableVerboseLogs: description: Is verbose logging enabled type: boolean example: true enableYbc: type: boolean example: true encryptionAtRestConfig: $ref: '#/components/schemas/EncryptionAtRestConfig' errorString: description: Error message type: string example: example-errorString expectedUniverseVersion: description: Expected universe version format: int32 type: integer example: 100 expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS extraDependencies: $ref: '#/components/schemas/ExtraDependencies' fullBackup: type: boolean example: true fullChainSizeInBytes: description: Incremental backups chain size format: int64 type: integer example: 10 ignoreErrors: description: Should table backup errors be ignored type: boolean example: true installYbc: type: boolean example: true isFullBackup: description: Full Table type backup type: boolean example: true keyspace: description: Key space type: string example: example-key kmsConfigUUID: description: KMS configuration UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minNumBackupsToRetain: description: Minimum number of backups to retain for a particular backup schedule format: int32 type: integer example: 10 newOwner: description: User name of the new tables owner type: string example: example-newOwner nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails' type: array uniqueItems: true example: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 nodeExporterUser: description: Node exporter user type: string example: '5433' oldOwner: description: User name of the current tables owner type: string example: example-oldOwner parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer example: 100 platformUrl: type: string example: https://example.com platformVersion: readOnly: true type: string example: 2.20.0.0 pointInTimeRestoreEnabled: description: Point in time restore available type: boolean example: true previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: description: Per region locations items: $ref: '#/components/schemas/RegionLocations' type: array example: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION restoreTimeStamp: description: Restore TimeStamp type: string example: '2026-05-03T12:00:00Z' runOnlyPrechecks: description: YbaApi Internal. Run only prechecks during task run type: boolean example: true scheduleName: description: Schedule Name type: string example: example-scheduleName scheduleUUID: description: Schedule UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 schedulingFrequency: description: Frequency to run the backup, in milliseconds format: int64 type: integer example: 1000 sleepAfterMasterRestartMillis: format: int32 type: integer example: 100 sleepAfterTServerRestartMillis: format: int32 type: integer example: 100 sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: description: Is SSE type: boolean example: true storageConfigType: description: Type of backup storage config enum: - S3 - NFS - AZ - GCS - FILE type: string example: S3 storageConfigUUID: description: Storage configuration UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageLocation: description: Storage location type: string example: example-storageLocation tableByTableBackup: description: Table by table backup type: boolean example: true tableName: description: Table name type: string example: example-tableName tableNameList: description: Tables items: type: string type: array example: - example-tableNameList tableUUID: description: Table UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableUUIDList: description: Table UUIDs items: format: uuid type: string type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablespacesList: description: Tablespaces info items: $ref: '#/components/schemas/Tablespace' type: array example: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer example: 1000 timeTakenPartial: format: int64 type: integer example: 1000 transactionalBackup: description: Is backup transactional across tables type: boolean example: true universeUUID: description: Associated universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: description: Backup global ysql roles type: boolean example: true useTablespaces: description: Is tablespaces information included type: boolean example: true ybPrevSoftwareVersion: description: Previous software version type: string example: 2.20.0.0 ybcInstalled: type: boolean example: true ybcSoftwareVersion: type: string example: 2.20.0.0 required: - creatingUser - fullBackup - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis - storageConfigUUID - timeTakenPartial type: object YbcThrottleParameters: description: YB-Controller throttle parameters example: diskWriteBytesPerSecond: 6 maxConcurrentDownloads: 1 maxConcurrentUploads: 5 perDownloadNumObjects: 5 diskReadBytesPerSecond: 0 perUploadNumObjects: 2 resetDefaults: true properties: diskReadBytesPerSecond: description: 'WARNING: This is a preview API that could change. Disk read bytes per second to throttle disk usage during backups' format: int64 type: integer example: 1000 diskWriteBytesPerSecond: description: 'WARNING: This is a preview API that could change. Disk write bytes per second to throttle disk usage during restore' format: int64 type: integer example: 1000 maxConcurrentDownloads: description: Max concurrent downloads per node format: int64 type: integer example: 10 maxConcurrentUploads: description: Max concurrent uploads per node format: int64 type: integer example: 10 perDownloadNumObjects: description: Max objects per download per node format: int64 type: integer example: 10 perUploadNumObjects: description: Max objects per upload per node format: int64 type: integer example: 10 resetDefaults: description: Unset Throttle parameters in YB-Controller type: boolean example: true type: object PlacementBlock: example: cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region properties: cloud: description: Cloud maxLength: 2147483647 minLength: 1 type: string example: example-cloud leader_preference: description: Leader preference format: int32 minimum: 1 type: integer example: 100 min_num_replicas: description: Minimum replicas format: int32 minimum: 1 type: integer example: 10 region: description: Region maxLength: 2147483647 minLength: 1 type: string example: us-east-1 zone: description: Zone maxLength: 2147483647 minLength: 1 type: string example: us-east-1a required: - cloud - region - zone type: object KeyspaceTablesList: example: backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation properties: allTables: type: boolean example: true backupPointInTimeRestoreWindow: $ref: '#/components/schemas/BackupPointInTimeRestoreWindow' backupSizeInBytes: format: int64 type: integer example: 10 defaultLocation: type: string example: example-defaultLocation keyspace: type: string example: example-key perRegionLocations: items: $ref: '#/components/schemas/RegionLocations' type: array example: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION tableUUIDList: items: format: uuid type: string type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: items: type: string type: array example: - example-tablesList required: - allTables - backupPointInTimeRestoreWindow - backupSizeInBytes - defaultLocation - keyspace - perRegionLocations - tableUUIDList - tablesList type: object CustomerConfigUI: description: Customer configuration with additional information. Includes storage, alerts, password policy, and call-home level. example: configName: backup20-01-2021 configUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' universeDetails: '{"name": "jd-aws-21-6-21-test4"}' inUse: true kubernetesOperatorControlled: true name: S3 state: Active type: STORAGE properties: configName: description: Config name example: backup20-01-2021 maxLength: 100 minLength: 1 type: string configUUID: description: Config UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: description: Configuration data example: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' properties: {} type: object inUse: description: True if there is an in use reference to the object readOnly: true type: boolean example: true kubernetesOperatorControlled: type: boolean example: true name: description: Name example: S3 maxLength: 50 minLength: 1 type: string state: description: state of the customerConfig. Possible values are Active, QueuedForDeletion. enum: - Active - QueuedForDeletion readOnly: true type: string example: Active type: description: Config type enum: - STORAGE - ALERTS - CALLHOME - PASSWORD_POLICY example: STORAGE type: string universeDetails: description: Universe details example: '{"name": "jd-aws-21-6-21-test4"}' items: $ref: '#/components/schemas/UniverseDetailSubset' type: array required: - configName - customerUUID - data - kubernetesOperatorControlled - name - type type: object SchedulePagedApiResponse: example: entities: - scheduleName: scheduleName tableByTableBackup: true nextExpectedTask: 2022-12-12 13:07:18+00:00 incrementBacklogStatus: true frequency: 5 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS prevCompletedTask: 2022-12-12 13:07:18+00:00 taskType: CloudBootstrap customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 incrementalBackupFrequencyTimeUnit: NANOSECONDS scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true incrementalBackupFrequency: 5 backlogStatus: true backupInfo: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE failureCount: 1 status: Deleting - scheduleName: scheduleName tableByTableBackup: true nextExpectedTask: 2022-12-12 13:07:18+00:00 incrementBacklogStatus: true frequency: 5 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS prevCompletedTask: 2022-12-12 13:07:18+00:00 taskType: CloudBootstrap customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 incrementalBackupFrequencyTimeUnit: NANOSECONDS scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true incrementalBackupFrequency: 5 backlogStatus: true backupInfo: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE failureCount: 1 status: Deleting hasPrev: true hasNext: true totalCount: 2 properties: entities: items: $ref: '#/components/schemas/ScheduleResp' type: array example: - scheduleName: scheduleName tableByTableBackup: true nextExpectedTask: '2022-12-12T13:07:18+00:00' incrementBacklogStatus: true frequency: 5 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS prevCompletedTask: '2022-12-12T13:07:18+00:00' taskType: CloudBootstrap customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 incrementalBackupFrequencyTimeUnit: NANOSECONDS scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true incrementalBackupFrequency: 5 backlogStatus: true backupInfo: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE failureCount: 1 status: Deleting hasNext: type: boolean example: true hasPrev: type: boolean example: true totalCount: format: int32 type: integer example: 10 required: - entities - hasNext - hasPrev - totalCount type: object ReplicaPlacement: example: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region properties: numReplicas: format: int32 minimum: 1 type: integer example: 10 placementBlocks: items: $ref: '#/components/schemas/PlacementBlock' maxItems: 2147483647 minItems: 1 type: array example: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region required: - numReplicas - placementBlocks type: object BootstrapBackupParams: description: Backup parameters for bootstrapping example: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 properties: parallelism: description: Number of concurrent commands used by yb_backup (not ybc) to run on nodes over SSH format: int32 type: integer example: 100 storageConfigUUID: description: Storage configuration UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - storageConfigUUID type: object BackupResp: example: scheduleName: scheduleName isFullBackup: true expiryTimeUnit: NANOSECONDS hasIncrementalBackups: true lastBackupState: InProgress commonBackupInfo: tableByTableBackup: true sse: true updateTime: 2022-12-12 13:07:18+00:00 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 responseList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation state: InProgress totalBackupSizeInBytes: 5 backupType: YQL_TABLE_TYPE isUniversePresent: true onDemand: true universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 lastIncrementalBackupTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryTime: 2022-12-12 13:07:18+00:00 fullChainSizeInBytes: 5 isStorageConfigPresent: true category: YB_BACKUP_SCRIPT useTablespaces: true storageConfigType: S3 universeName: universeName properties: backupType: enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE category: enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string example: YB_BACKUP_SCRIPT commonBackupInfo: $ref: '#/components/schemas/CommonBackupInfo' customerUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiryTime: description: The expiry time for backup. example: 2022-12-12 13:07:18+00:00 format: date-time type: string expiryTimeUnit: enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS fullChainSizeInBytes: format: int64 type: integer example: 10 hasIncrementalBackups: type: boolean example: true isFullBackup: type: boolean example: true isStorageConfigPresent: type: boolean example: true isUniversePresent: type: boolean example: true lastBackupState: enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopping - Stopped - QueuedForDeletion - QueuedForForcedDeletion - DeleteInProgress type: string example: InProgress lastIncrementalBackupTime: description: Time for last incremenatal backup. example: 2022-12-12 13:07:18+00:00 format: date-time type: string onDemand: type: boolean example: true scheduleName: type: string example: example-scheduleName scheduleUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: enum: - S3 - NFS - AZ - GCS - FILE type: string example: S3 universeName: type: string example: example-universeName universeUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: description: 'WARNING: This is a preview API that could change. Indicates if role objects were backed up' type: boolean example: true useTablespaces: type: boolean example: true required: - backupType - category - commonBackupInfo - customerUUID - expiryTimeUnit - fullChainSizeInBytes - hasIncrementalBackups - isFullBackup - isStorageConfigPresent - isUniversePresent - lastBackupState - onDemand - scheduleName - scheduleUUID - storageConfigType - universeName - universeUUID - useTablespaces type: object RestoreApiFilter: example: showHidden: true dateRangeEnd: 2022-12-12 13:07:18+00:00 storageConfigUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 dateRangeStart: 2022-12-12 13:07:18+00:00 onlyShowDeletedSourceUniverses: true universeNameList: - universeNameList - universeNameList sourceUniverseNameList: - sourceUniverseNameList - sourceUniverseNameList universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 restoreUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 states: - Created - Created properties: dateRangeEnd: description: The end date to filter paged query. example: 2022-12-12 13:07:18+00:00 format: date-time type: string dateRangeStart: description: The start date to filter paged query. example: 2022-12-12 13:07:18+00:00 format: date-time type: string onlyShowDeletedSourceUniverses: type: boolean example: true restoreUUIDList: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 showHidden: type: boolean example: true sourceUniverseNameList: items: type: string type: array uniqueItems: true example: - example-sourceUniverseNameList states: items: enum: - Created - InProgress - Completed - Failed - Aborted type: string type: array uniqueItems: true example: - Created storageConfigUUIDList: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeNameList: items: type: string type: array uniqueItems: true example: - example-universeNameList universeUUIDList: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - onlyShowDeletedSourceUniverses - restoreUUIDList - showHidden - sourceUniverseNameList - states - storageConfigUUIDList - universeNameList - universeUUIDList type: object RestorePreflightResponse: example: perLocationBackupInfoMap: key: backupLocation: backupLocation perBackupLocationKeyspaceTables: originalKeyspace: originalKeyspace tableNameList: - tableNameList - tableNameList pointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tablespaceResponse: conflictingTablespaces: - conflictingTablespaces - conflictingTablespaces unsupportedTablespaces: - unsupportedTablespaces - unsupportedTablespaces containsTablespaces: true isYSQLBackup: true isSelectiveRestoreSupported: true backupCategory: YB_BACKUP_SCRIPT hasKMSHistory: true properties: backupCategory: description: Backup Category enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string example: YB_BACKUP_SCRIPT hasKMSHistory: description: Whether backup was KMS encrypted type: boolean example: true perLocationBackupInfoMap: additionalProperties: $ref: '#/components/schemas/PerLocationBackupInfo' description: Map of backup location and backup-info object type: object example: {} type: object Users: description: A user associated with a customer example: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true properties: authTokenIssueDate: description: UI session token creation date example: 2021-06-17 15:00:05+00:00 format: date-time readOnly: true type: string creationDate: description: User creation date example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: description: User email address example: username1@example.com type: string groupMemberships: items: format: uuid type: string type: array uniqueItems: true example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ldapSpecifiedRole: description: LDAP Specified Role type: boolean example: true oidcJwtAuthToken: readOnly: true type: string example: REDACTED primary: type: boolean example: true role: description: Deprecated since YBA version 2.19.3.0. Use getRoleBindings instead. enum: - ConnectOnly - ReadOnly - BackupAdmin - Admin - SuperAdmin example: Admin type: string timezone: description: User timezone type: string example: us-east-1a userType: description: User Type enum: - local - ldap - oidc type: string example: local uuid: description: User UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - email - groupMemberships - primary type: object YbcThrottleParametersResponse: description: YB-Controller throttle parameters response example: throttleParamsMap: key: presetValues: minValue: 5 defaultValue: 6 maxValue: 1 currentValue: 0 properties: throttleParamsMap: additionalProperties: $ref: '#/components/schemas/ThrottleParamValue' description: Map of YBC throttle parameters type: object example: {} type: object YBPTask: example: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: resourceUUID: description: UUID of the resource being modified by the task format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: description: Task UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object RestorePagedApiQuery: example: filter: showHidden: true dateRangeEnd: 2022-12-12 13:07:18+00:00 storageConfigUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 dateRangeStart: 2022-12-12 13:07:18+00:00 onlyShowDeletedSourceUniverses: true universeNameList: - universeNameList - universeNameList sourceUniverseNameList: - sourceUniverseNameList - sourceUniverseNameList universeUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 restoreUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 states: - Created - Created offset: 6 needTotalCount: true limit: 0 sortBy: createTime direction: ASC properties: direction: enum: - ASC - DESC type: string example: ASC filter: $ref: '#/components/schemas/RestoreApiFilter' limit: format: int32 type: integer example: 10 needTotalCount: type: boolean example: true offset: format: int32 type: integer example: 100 sortBy: enum: - createTime type: string example: createTime required: - direction - filter - limit - needTotalCount - offset - sortBy type: object CommonBackupInfo: example: tableByTableBackup: true sse: true updateTime: 2022-12-12 13:07:18+00:00 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 responseList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation state: InProgress totalBackupSizeInBytes: 5 properties: backupUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: description: Backup completion time. example: 2022-12-12 13:07:18+00:00 format: date-time type: string createTime: description: Backup create time. example: 2022-12-12 13:07:18+00:00 format: date-time type: string kmsConfigUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 responseList: items: $ref: '#/components/schemas/KeyspaceTablesList' type: array uniqueItems: true example: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation sse: type: boolean example: true state: enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopping - Stopped - QueuedForDeletion - QueuedForForcedDeletion - DeleteInProgress type: string example: InProgress storageConfigUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableByTableBackup: type: boolean example: true taskUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 totalBackupSizeInBytes: format: int64 type: integer example: 10 updateTime: description: Backup update time. example: 2022-12-12 13:07:18+00:00 format: date-time type: string required: - backupUUID - baseBackupUUID - kmsConfigUUID - responseList - sse - state - storageConfigUUID - tableByTableBackup - taskUUID - totalBackupSizeInBytes type: object DeviceInfo: description: Device information example: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 properties: cloudVolumeEncryption: $ref: '#/components/schemas/CloudVolumeEncryption' diskIops: description: Desired IOPS for the volumes mounted on this instance format: int32 type: integer example: 100 mountPoints: description: Comma-separated list of mount points for the devices in each instance type: string example: example-mountPoints numVolumes: description: Number of volumes to be mounted on this instance at the default path format: int32 type: integer example: 10 storageClass: description: Name of the storage class type: string example: example-storageClass storageType: description: Storage type used for this instance enum: - IO1 - IO2 - GP2 - GP3 - Scratch - Persistent - Hyperdisk_Balanced - Hyperdisk_Extreme - StandardSSD_LRS - Premium_LRS - PremiumV2_LRS - UltraSSD_LRS - Local type: string example: IO1 throughput: description: Desired throughput for the volumes mounted on this instance format: int32 type: integer example: 100 volumeSize: description: The size of each volume in each instance. Could be modified in payload for /resize_node API call format: int32 type: integer example: 10 type: object XClusterConfigEditFormData: description: xcluster edit form example: tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' dryRun: true bootstrapParams: tables: '["000033df000030008000000000004006"]' allowBootstrap: true backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 dbs: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' autoIncludeIndexTables: true targetRole: ACTIVE name: Repl-config1 sourceRole: ACTIVE status: Running properties: autoIncludeIndexTables: description: Whether or not YBA should also include all index tables from any provided main tables. type: boolean example: true bootstrapParams: $ref: '#/components/schemas/BootstrapParams' dbs: description: 'WARNING: This is a preview API that could change. Source universe database IDs' example: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' items: type: string type: array uniqueItems: true dryRun: description: Run the pre-checks without actually running the subtasks type: boolean example: true name: description: Name example: Repl-config1 type: string sourceRole: description: The role that the source universe should have in the xCluster config enum: - ACTIVE - STANDBY - UNRECOGNIZED type: string example: ACTIVE status: description: Status enum: - Running - Paused type: string example: Running tables: description: Source universe table IDs example: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' items: type: string type: array uniqueItems: true targetRole: description: The role that the target universe should have in the xCluster config enum: - ACTIVE - STANDBY - UNRECOGNIZED type: string example: ACTIVE type: object RestorePagedApiResponse: example: entities: - restoreSizeInBytes: 6 backupCreatedOnDate: 2022-12-12 13:07:18+00:00 restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateTime: 2022-12-12 13:07:18+00:00 targetUniverseName: targetUniverseName backupType: YQL_TABLE_TYPE universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseName: sourceUniverseName createTime: 2022-12-12 13:07:18+00:00 restoreKeyspaceList: - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isSourceUniversePresent: true state: Created - restoreSizeInBytes: 6 backupCreatedOnDate: 2022-12-12 13:07:18+00:00 restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateTime: 2022-12-12 13:07:18+00:00 targetUniverseName: targetUniverseName backupType: YQL_TABLE_TYPE universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseName: sourceUniverseName createTime: 2022-12-12 13:07:18+00:00 restoreKeyspaceList: - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isSourceUniversePresent: true state: Created hasPrev: true hasNext: true totalCount: 1 properties: entities: items: $ref: '#/components/schemas/RestoreResp' type: array example: - restoreSizeInBytes: 6 backupCreatedOnDate: '2022-12-12T13:07:18+00:00' restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateTime: '2022-12-12T13:07:18+00:00' targetUniverseName: targetUniverseName backupType: YQL_TABLE_TYPE universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseName: sourceUniverseName createTime: '2022-12-12T13:07:18+00:00' restoreKeyspaceList: - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' tableNameList: - tableNameList - tableNameList completeTime: '2022-12-12T13:07:18+00:00' storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' tableNameList: - tableNameList - tableNameList completeTime: '2022-12-12T13:07:18+00:00' storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isSourceUniversePresent: true state: Created hasNext: type: boolean example: true hasPrev: type: boolean example: true totalCount: format: int32 type: integer example: 10 required: - entities - hasNext - hasPrev - totalCount type: object NodeDetails: description: Details of a cloud node example: nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 properties: autoSyncMasterAddrs: description: 'WARNING: This is a preview API that could change. Used by auto master failover' readOnly: true type: boolean example: true azUuid: description: The availability zone's UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cloudInfo: $ref: '#/components/schemas/CloudSpecificInfo' cronsActive: description: True if cron jobs were properly configured for this node type: boolean example: true dedicatedTo: description: Used for configurations where each node can have only one process enum: - MASTER - TSERVER - CONTROLLER - YQLSERVER - YSQLSERVER - REDISSERVER - EITHER type: string example: MASTER disksAreMountedByUUID: description: Disks are mounted by uuid type: boolean example: true internalYsqlServerRpcPort: description: Internal YSQL RPC port format: int32 type: integer example: 5433 isMaster: description: True if this node is a master type: boolean example: true isRedisServer: description: True if this node is a REDIS server type: boolean example: true isTserver: description: True if this node is a Tablet server type: boolean example: true isYqlServer: description: True if this node is a YCQL server type: boolean example: true isYsqlServer: description: True if this node is a YSQL server type: boolean example: true lastVolumeUpdateTime: description: Store last volume update time example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string machineImage: description: Machine image name type: string example: example-machineImage masterHttpPort: description: Master HTTP port format: int32 type: integer example: 5433 masterRpcPort: description: Master RPC port format: int32 type: integer example: 5433 masterState: description: Master state enum: - None - ToStart - Configured - ToStop example: ToStart type: string nodeExporterPort: description: Node exporter port format: int32 type: integer example: 5433 nodeIdx: description: Node ID format: int32 type: integer example: 100 nodeName: description: Node name type: string example: example-nodeName nodeUuid: description: Node UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 otelCollectorMetricsPort: description: Otel collector metrics port format: int32 type: integer example: 5433 placementUuid: description: UUID of the cluster to which this node belongs format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 redisServerHttpPort: description: REDIS HTTP port format: int32 type: integer example: 5433 redisServerRpcPort: description: REDIS RPC port format: int32 type: integer example: 5433 sshPortOverride: description: SSH port override for the AMI format: int32 type: integer example: 5433 sshUserOverride: description: SSH user override for the AMI type: string example: example-sshUserOverride state: description: Node state enum: - ToBeAdded - InstanceCreated - ServerSetup - ToJoinCluster - Reprovisioning - Provisioned - SoftwareInstalled - UpgradeMasterSoftware - UpgradeSoftware - RollbackUpgrade - FinalizeUpgrade - UpdateGFlags - Live - Stopping - Starting - Stopped - Unreachable - MetricsUnavailable - ToBeRemoved - Removing - Removed - Adding - BeingDecommissioned - Decommissioned - UpdateCert - ToggleTls - ConfigureDBApis - Resizing - SystemdUpgrade - Terminating - Terminated - Rebooting - HardRebooting - VMImageUpgrade - InstanceStopping - InstanceStopped example: Provisioned type: string tserverHttpPort: description: Tablet server HTTP port format: int32 type: integer example: 5433 tserverRpcPort: description: Tablet server RPC port format: int32 type: integer example: 5433 ybControllerHttpPort: description: Yb controller HTTP port format: int32 type: integer example: 5433 ybControllerRpcPort: description: Yb controller RPC port format: int32 type: integer example: 5433 ybPrebuiltAmi: description: True if this a custom YB AMI type: boolean example: true yqlServerHttpPort: description: YCQL HTTP port format: int32 type: integer example: 5433 yqlServerRpcPort: description: YCQL RPC port format: int32 type: integer example: 5433 ysqlServerHttpPort: description: YSQL HTTP port format: int32 type: integer example: 5433 ysqlServerRpcPort: description: YSQL RPC port format: int32 type: integer example: 5433 type: object RestoreKeyspace: description: Keyspace level restores example: backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: backupSizeFromStorageLocation: format: int64 type: integer example: 10 completeTime: description: RestoreKeyspace task completion time example: 2022-12-12 13:07:18+00:00 format: date-time type: string createTime: description: RestoreKeyspace task creation time example: 2022-12-12 13:07:18+00:00 format: date-time type: string restoreUUID: description: Universe-level Restore UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceKeyspace: description: Source keyspace name readOnly: true type: string example: example-key state: description: State of the keyspace restore enum: - Created - InProgress - Completed - Failed - Aborted readOnly: true type: string example: Created storageLocation: description: Storage location name readOnly: true type: string example: example-storageLocation tableNameList: description: Restored Table name List items: type: string readOnly: true type: array example: - example-tableNameList targetKeyspace: description: Target keyspace name readOnly: true type: string example: example-key taskUUID: description: Restore Keyspace task UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: description: Restore keyspace UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - backupSizeFromStorageLocation type: object EditBackupScheduleParams: description: Info to edit the schedule params for backups example: cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS incrementalBackupFrequencyTimeUnit: NANOSECONDS timeBeforeDelete: 1 incrementalBackupFrequency: 6 runImmediateBackupOnResume: true frequency: 0 status: Deleting properties: cronExpression: description: Cron expression for scheduling type: string example: example-cronExpression frequency: description: Frequency of the schedule format: int64 type: integer example: 1000 frequencyTimeUnit: description: Time Unit for frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS incrementalBackupFrequency: description: Frequency of incremental backup schedule format: int64 type: integer example: 1000 incrementalBackupFrequencyTimeUnit: description: TimeUnit for incremental Backup Schedule frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS runImmediateBackupOnResume: description: Run a full or incremental backup if the schedule is expired when resuming a stopped schedule type: boolean example: true status: description: State of the schedule enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string example: Deleting timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer example: 1000 type: object BackupRequestParams: description: Backup table parameters example: expectedUniverseVersion: 5 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser useRoles: true alterLoadBalancer: true baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true keyspaceTableList: - keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sleepAfterTServerRestartMillis: 3 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 enablePointInTimeRestore: true ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 9 expiryTimeUnit: NANOSECONDS parallelism: 4 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK backupType: PGSQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybcSoftwareVersion: ybcSoftwareVersion incrementalBackupFrequencyTimeUnit: NANOSECONDS backupCategory: YB_BACKUP_SCRIPT creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion useLocalTimezone: true disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 3 backupStats: true parallelDBBackups: 0 ybPrevSoftwareVersion: ybPrevSoftwareVersion dumpRoleChecks: true cronExpression: cronExpression universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString frequencyTimeUnit: NANOSECONDS installYbc: true schedulingFrequency: 8 incrementalBackupFrequency: 9 cmkArn: cmkArn previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: alterLoadBalancer: description: Alter load balancer state type: boolean example: true backupCategory: description: Overrides whether you want to use YBC based or script based backup. enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string example: YB_BACKUP_SCRIPT backupStats: description: 'WARNING: This is a preview API that could change. Backup stats with YSQL dump.' type: boolean example: true backupType: description: Backup type enum: - PGSQL_TABLE_TYPE - YQL_TABLE_TYPE - REDIS_TABLE_TYPE type: string example: PGSQL_TABLE_TYPE backupUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: description: UUID of the parent backup format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string example: example-cmkArn communicationPorts: $ref: '#/components/schemas/CommunicationPorts' creatingUser: $ref: '#/components/schemas/Users' cronExpression: description: Cron expression for a recurring backup type: string example: example-cronExpression customerUUID: description: Customer UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: $ref: '#/components/schemas/DeviceInfo' disableChecksum: description: Disable checksum type: boolean example: true disableMultipart: description: Disable multipart upload type: boolean example: true disableParallelism: description: Don't add -m flag during gsutil upload dir command type: boolean example: true dumpRoleChecks: description: 'WARNING: This is a preview API that could change. Add role exists checks for roles metadata. All GRANT/REVOKE and ALTER sql commands will first check if the role exists' type: boolean example: true enablePointInTimeRestore: description: Enable Point-In-Time-Restore capability on backup schedules with a limited restore window. Only applicable for YB-Controller enabled universes type: boolean example: true enableVerboseLogs: description: Is verbose logging enabled type: boolean example: true enableYbc: type: boolean example: true encryptionAtRestConfig: $ref: '#/components/schemas/EncryptionAtRestConfig' errorString: description: Error message type: string example: example-errorString expectedUniverseVersion: description: Expected universe version format: int32 type: integer example: 100 expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS extraDependencies: $ref: '#/components/schemas/ExtraDependencies' frequencyTimeUnit: description: Time unit for user input schedule frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS ignoreErrors: description: Should table backup errors be ignored type: boolean example: true incrementalBackupFrequency: description: Frequency of incremental backups format: int64 type: integer example: 1000 incrementalBackupFrequencyTimeUnit: description: Time unit for user input incremental backup schedule frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS installYbc: type: boolean example: true keyspaceTableList: description: Backup info items: $ref: '#/components/schemas/KeyspaceTable' type: array example: - keyspace: keyspace tableNameList: - tableNameList - tableNameList tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: description: KMS configuration UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minNumBackupsToRetain: description: Minimum number of backups to retain for a particular backup schedule format: int32 type: integer example: 10 nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails' type: array uniqueItems: true example: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 nodeExporterUser: description: Node exporter user type: string example: '5433' parallelDBBackups: description: Parallel DB backups format: int32 type: integer example: 100 parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer example: 100 platformUrl: type: string example: https://example.com platformVersion: readOnly: true type: string example: 2.20.0.0 previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 runOnlyPrechecks: description: YbaApi Internal. Run only prechecks during task run type: boolean example: true scheduleName: description: Schedule Name type: string example: example-scheduleName scheduleUUID: description: Schedule UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 schedulingFrequency: description: Frequency to run the backup, in milliseconds format: int64 type: integer example: 1000 sleepAfterMasterRestartMillis: format: int32 type: integer example: 100 sleepAfterTServerRestartMillis: format: int32 type: integer example: 100 sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: description: Is SSE type: boolean example: true storageConfigUUID: description: Storage configuration UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableByTableBackup: description: Take table by table backups type: boolean example: true targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer example: 1000 universeUUID: description: Universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: description: Use local timezone for Cron Expression, otherwise use UTC type: boolean example: true useRoles: description: Backup global ysql roles type: boolean example: true useTablespaces: description: Is tablespaces information included type: boolean example: true ybPrevSoftwareVersion: description: Previous software version type: string example: 2.20.0.0 ybcInstalled: type: boolean example: true ybcSoftwareVersion: type: string example: 2.20.0.0 required: - backupUUID - creatingUser - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis - storageConfigUUID - universeUUID type: object CustomerConfig: description: Customer configuration. Includes storage, alerts, password policy, and call-home level. example: configName: backup20-01-2021 configUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' kubernetesOperatorControlled: true name: S3 state: Active type: STORAGE properties: configName: description: Config name example: backup20-01-2021 maxLength: 100 minLength: 1 type: string configUUID: description: Config UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: description: Customer UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 data: description: Configuration data example: '{"AWS_ACCESS_KEY_ID": "AK****************ZD"}' properties: {} type: object kubernetesOperatorControlled: type: boolean example: true name: description: Name example: S3 maxLength: 50 minLength: 1 type: string state: description: state of the customerConfig. Possible values are Active, QueuedForDeletion. enum: - Active - QueuedForDeletion readOnly: true type: string example: Active type: description: Config type enum: - STORAGE - ALERTS - CALLHOME - PASSWORD_POLICY example: STORAGE type: string required: - configName - customerUUID - data - kubernetesOperatorControlled - name - type type: object DrConfigSetDatabasesForm: description: dr config set databases form example: dbs: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' properties: dbs: description: 'WARNING: This is a preview API that could change. Source universe database IDs' example: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' items: type: string type: array uniqueItems: true type: object RestoreResp: example: restoreSizeInBytes: 6 backupCreatedOnDate: 2022-12-12 13:07:18+00:00 restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateTime: 2022-12-12 13:07:18+00:00 targetUniverseName: targetUniverseName backupType: YQL_TABLE_TYPE universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseName: sourceUniverseName createTime: 2022-12-12 13:07:18+00:00 restoreKeyspaceList: - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 tableNameList: - tableNameList - tableNameList completeTime: 2022-12-12 13:07:18+00:00 storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isSourceUniversePresent: true state: Created properties: backupCreatedOnDate: description: Backup details. example: 2022-12-12 13:07:18+00:00 format: date-time type: string backupType: enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE createTime: description: Restore creation time. example: 2022-12-12 13:07:18+00:00 format: date-time type: string customerUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isSourceUniversePresent: type: boolean example: true restoreKeyspaceList: items: $ref: '#/components/schemas/RestoreKeyspace' type: array example: - backupSizeFromStorageLocation: 0 sourceKeyspace: sourceKeyspace restoreUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: '2022-12-12T13:07:18+00:00' tableNameList: - tableNameList - tableNameList completeTime: '2022-12-12T13:07:18+00:00' storageLocation: storageLocation targetKeyspace: targetKeyspace state: Created taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 restoreSizeInBytes: format: int64 type: integer example: 10 restoreUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sourceUniverseName: type: string example: example-sourceUniverseName sourceUniverseUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 state: enum: - Created - InProgress - Completed - Failed - Aborted type: string example: Created targetUniverseName: type: string example: example-targetUniverseName universeUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 updateTime: description: Restore update time. example: 2022-12-12 13:07:18+00:00 format: date-time type: string required: - customerUUID - isSourceUniversePresent - restoreKeyspaceList - restoreSizeInBytes - restoreUUID - sourceUniverseName - sourceUniverseUUID - state - targetUniverseName - universeUUID type: object ScheduleResp: example: scheduleName: scheduleName tableByTableBackup: true nextExpectedTask: 2022-12-12 13:07:18+00:00 incrementBacklogStatus: true frequency: 5 cronExpression: cronExpression frequencyTimeUnit: NANOSECONDS prevCompletedTask: 2022-12-12 13:07:18+00:00 taskType: CloudBootstrap customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 incrementalBackupFrequencyTimeUnit: NANOSECONDS scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useLocalTimezone: true runningState: true incrementalBackupFrequency: 5 backlogStatus: true backupInfo: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: true expiryTimeUnit: NANOSECONDS timeBeforeDelete: 6 keyspaceList: - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation - backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 backupSizeInBytes: 1 keyspace: keyspace tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablesList: - tablesList - tablesList perRegionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION allTables: true defaultLocation: defaultLocation parallelism: 0 pointInTimeRestoreEnabled: true useTablespaces: true fullBackup: true backupType: YQL_TABLE_TYPE failureCount: 1 status: Deleting properties: backlogStatus: type: boolean example: true backupInfo: $ref: '#/components/schemas/BackupInfo' cronExpression: type: string example: example-cronExpression customerUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 failureCount: format: int32 type: integer example: 10 frequency: format: int64 type: integer example: 1000 frequencyTimeUnit: enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS incrementBacklogStatus: type: boolean example: true incrementalBackupFrequency: format: int64 type: integer example: 1000 incrementalBackupFrequencyTimeUnit: enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS nextExpectedTask: description: Next expected task time example: 2022-12-12 13:07:18+00:00 format: date-time type: string prevCompletedTask: description: Previous completed task time example: 2022-12-12 13:07:18+00:00 format: date-time type: string runningState: type: boolean example: true scheduleName: type: string example: example-scheduleName scheduleUUID: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 status: enum: - Deleting - Error - Active - Creating - Paused - Stopped - Editing type: string example: Deleting tableByTableBackup: type: boolean example: true taskType: enum: - CloudBootstrap - CloudCleanup - CreateCassandraTable - CreateUniverse - ReadOnlyClusterCreate - ReadOnlyKubernetesClusterDelete - ReadOnlyClusterDelete - CreateKubernetesUniverse - ReadOnlyKubernetesClusterCreate - DestroyUniverse - PauseUniverse - ResumeUniverse - PauseKubernetesUniverse - ResumeKubernetesUniverse - DestroyKubernetesUniverse - DeleteTable - BackupUniverse - RestoreBackup - MultiTableBackup - CreateBackup - ConfigureDBApis - ConfigureDBApisKubernetes - CreatePitrConfig - UpdatePitrConfig - DeletePitrConfig - RestoreSnapshotSchedule - EditUniverse - EditKubernetesUniverse - ExternalScript - ImportIntoTable - RunApiTriggeredHooks - AddOnClusterCreate - AddOnClusterDelete - UpgradeUniverse - UpdateLoadBalancerConfig - RestartUniverse - RestartUniverseKubernetesUpgrade - SoftwareUpgrade - SoftwareKubernetesUpgrade - KubernetesOverridesUpgrade - GFlagsUpgrade - GFlagsKubernetesUpgrade - CertsRotate - CertsRotateKubernetesUpgrade - TlsToggle - VMImageUpgrade - SystemdUpgrade - RebootUniverse - UpgradeKubernetesUniverse - DeleteNodeFromUniverse - StopNodeInUniverse - StartNodeInUniverse - AddNodeToUniverse - RemoveNodeFromUniverse - RebootNodeInUniverse - ReleaseInstanceFromUniverse - RotateAccessKey - SetUniverseKey - CreateAndRotateAccessKey - CreateKMSConfig - EditKMSConfig - DeleteKMSConfig - UpdateDiskSize - UpdateKubernetesDiskSize - StartMasterOnNode - DeleteXClusterConfig - SyncXClusterConfig - CreateSupportBundle - CreateXClusterConfig - EditXClusterConfig - RestartXClusterConfig - RestartDrConfig - SyncDrConfig - SetDatabasesDrConfig - SetTablesDrConfig - CreateDrConfig - DeleteDrConfig - FailoverDrConfig - SwitchoverDrConfig - SwitchoverDrConfigRollback - EditDrConfig - EditDrConfigParams - PauseXClusterUniverses - ResumeXClusterUniverses - ReinstallNodeAgent - ProvisionUniverseNodes - DeleteCustomerConfig - DeleteCustomerStorageConfig - ResizeNode - CreateTableSpacesInUniverse - ThirdpartySoftwareUpgrade - ModifyAuditLoggingConfig - ModifyKubernetesAuditLoggingConfig - ModifyQueryLoggingConfig - ModifyMetricsExportConfig - InstallYbcSoftware - UpgradeUniverseYbc - UpgradeYbcGFlags - UpgradeKubernetesYbcGFlags - UpdateYbcThrottleFlags - UpdateK8sYbcThrottleFlags - DisableYbc - AddGFlagMetadata - CloudProviderDelete - CreateBackupSchedule - CreateBackupScheduleKubernetes - DeleteBackupSchedule - DeleteBackupScheduleKubernetes - EditBackupSchedule - EditBackupScheduleKubernetes - CloudProviderEdit - SoftwareUpgradeYB - SoftwareKubernetesUpgradeYB - FinalizeUpgrade - FinalizeKubernetesUpgrade - RollbackUpgrade - RollbackKubernetesUpgrade - LdapUniverseSync - ReprovisionNode - ReplaceNodeInUniverse - UpdateProxyConfig - RecommissionNodeInstance - DecommissionNodeInstance - MasterFailover - SyncMasterAddresses - CreateContinuousBackup - CreateYbaBackup - RestoreYbaBackup - RestoreContinuousBackup - EnableNodeAgentInUniverse - DecommissionNode - CloneNamespace - TlsToggleKubernetes - UpdateOOMServiceState - SendUserNotification - ImportUniverse - MigrateUniverse - KubernetesToggleImmutableYbc - OperatorImportUniverse - KubernetesCheckVolumeExpansion - KubernetesPostExpansionCheckVolume - NodeCertReloadTask - UpdateUniverseConfig - CreateRootVolumes - ReplaceRootVolume - ChangeInstanceType - PersistResizeNode - PersistSystemdUpgrade - PersistUseClockbound - UpdateNodeDetails - AddAuthorizedKey - AnsibleClusterServerCtl - AnsibleConfigureServers - AnsibleDestroyServer - PauseServer - ResumeServer - AnsibleSetupServer - AnsibleCreateServer - PrecheckNodeDetached - AnsibleUpdateNodeInfo - BulkImport - ChangeMasterConfig - ChangeAdminPassword - DropTable - CreateTable - DeleteNode - DeleteBackup - DeleteBackupYb - UpdateNodeProcess - DeleteTableFromUniverse - DeleteTablesFromUniverse - DeleteKeyspace - LoadBalancerStateChange - ModifyBlackList - CheckUnderReplicatedTablets - CheckFollowerLag - CheckNodeSafeToDelete - ManipulateDnsRecordTask - RemoveUniverseEntry - SetFlagInMemory - SetNodeState - SwamperTargetsFileUpdate - UniverseUpdateSucceeded - RegisterUniverseWithPaCollector - UnregisterUniverseFromPaCollector - UpdateAndPersistGFlags - UpdateAndPersistKubernetesOverrides - HandleKubernetesNamespacedServices - UpdatePlacementInfo - UpdateSoftwareVersion - UpdateUniverseYbcDetails - YBCBackupSucceeded - UpdateUniverseYbcGflagsDetails - SetYbcThrottleParamsInMemory - VerifyNodeSSHAccess - WaitForDataMove - WaitForLeaderBlacklistCompletion - WaitForFollowerLag - WaitForLoadBalance - WaitForMasterLeader - WaitForServer - WaitForYbcServer - WaitForTServerHeartBeats - DeleteClusterFromUniverse - InstanceActions - WaitForServerReady - WaitForClockSync - WaitForDuration - RunExternalScript - RemoveAuthorizedKey - UpdateUniverseAccessKey - ManageLoadBalancerGroup - BootstrapProducer - CheckBootstrapRequired - DeleteBootstrapIds - XClusterNetworkConnectivityCheck - DeleteReplication - DeleteXClusterConfigEntry - DeleteXClusterTableConfigEntry - DeleteDrConfigEntry - WaitForReplicationDrain - ResetXClusterConfigEntry - SetReplicationPaused - ChangeXClusterRole - SetDrStates - UpdateDrConfigParams - XClusterAddNamespaceToOutboundReplicationGroup - AddNamespaceToXClusterReplication - XClusterRemoveNamespaceFromTargetUniverse - XClusterRemoveNamespaceFromOutboundReplication - SetRestoreTime - XClusterConfigSetup - XClusterConfigSetStatus - XClusterConfigSetStatusForTables - XClusterConfigSetStatusForNamespaces - XClusterConfigModifyTables - XClusterConfigRename - XClusterConfigSync - XClusterConfigUpdateMasterAddresses - XClusterInfoPersist - ReplicateNamespaces - CheckXUniverseAutoFlags - PromoteSecondaryConfigToMainConfig - DeleteRemnantStreams - CreateOutboundReplicationGroup - XClusterDbReplicationSetup - DeleteReplicationOnSource - DeleteXClusterBackupRestoreEntries - AddExistingPitrToXClusterConfig - DrConfigWebhookCall - SetRestoreState - CloudAccessKeyCleanup - CloudAccessKeySetup - CloudInitializer - CloudProviderCleanup - CloudRegionCleanup - CloudRegionSetup - CloudSetup - BackupTable - BackupTableYb - BackupTableYbc - BackupUniverseKeys - RestoreBackupYb - RestoreBackupYbc - RestoreUniverseKeys - RestoreUniverseKeysYb - RestoreUniverseKeysYbc - SetBackupHiddenState - SetRestoreHiddenState - RestorePreflightValidate - BackupPreflightValidate - WaitForLeadersOnPreferredOnly - EnableEncryptionAtRest - DisableEncryptionAtRest - DestroyEncryptionAtRest - KubernetesCommandExecutor - KubernetesWaitForPod - KubernetesCheckNumPod - PodDisruptionBudgetPolicy - SetActiveUniverseKeys - WaitForEncryptionKeyInMemory - UnivSetCertificate - CreateAlertDefinitions - ManageAlertDefinitions - ManageCatalogUpgradeSuperUser - UpdatePitrConfigIntermittentMinRecoverTime - MarkSourceMetric - UniverseSetTlsParams - UniverseUpdateRootCert - ResetUniverseVersion - DeleteCertificate - SetNodeStatus - CheckMasterLeader - CheckMasters - CheckTServers - WaitForTServerHBs - CreatePrometheusSwamperConfig - PreflightNodeCheck - RunYsqlUpgrade - PromoteAutoFlags - UpdateSoftwareUpdatePrevConfig - RollbackAutoFlags - StoreAutoFlagConfigVersion - CheckUpgrade - CheckCertificateConfig - CheckMemory - CheckLocale - CheckShellConnectivity - CheckGlibc - CheckOpentelemetryOperator - PGUpgradeTServerCheck - CleanUpPGUpgradeDataDir - RunYsqlMajorVersionCatalogUpgrade - RollbackYsqlMajorVersionCatalogUpgrade - FinalizeYsqlMajorCatalogUpgrade - ValidateGFlags - CheckSoftwareVersion - UpdateMountedDisks - TransferXClusterCerts - CreateTableSpaces - ManageOtelCollector - UpdateAndPersistAuditLoggingConfig - UpdateAndPersistQueryLoggingConfig - UpdateAndPersistMetricsExportConfig - MarkUniverseForHealthScriptReUpload - RebootServer - HardRebootServer - RunHooks - UpdateUniverseTags - UpgradeYbc - InstallYbcSoftwareOnK8s - InstanceExistCheck - DeleteRootVolumes - InstallingThirdPartySoftware - InstallNodeAgent - WaitForNodeAgent - CloudImageBundleSetup - UpdateClusterUserIntent - UpdateClusterAPIDetails - UpdateUniverseState - UpdateUniverseCommunicationPorts - UpdateUniverseIntent - UpdateConsistencyCheck - FreezeUniverse - QueryLdapServer - DbLdapSync - CheckForClusterServers - CheckLeaderlessTablets - CheckNodesAreSafeToTakeDown - ValidateNodeDiskSize - CheckNodeReachable - CheckDbNodePortConnectivity - SupportBundleComponentDownload - WaitStartingFromTime - RemoveNodeAgent - UpdateUniverseFields - RunNodeCommand - MasterLeaderStepdown - SetupYNP - YNPProvisioning - ConfigureOOMServiceOnNode - CheckSshConnection - FetchServerConf - DoCapacityReservation - DeleteCapacityReservation - DisablePitrConfig - EnablePitrConfig - UpdateAndPersistKubernetesImmutableYbc - TablespaceValidationOnRemove - CheckServiceLiveness - CheckNodeCommandExecution - CheckNodeDataDirDiskSpace - OperatorImportResource - UpdateParentTaskParams type: string example: CloudBootstrap useLocalTimezone: type: boolean example: true required: - backlogStatus - backupInfo - cronExpression - customerUUID - failureCount - frequency - frequencyTimeUnit - incrementBacklogStatus - incrementalBackupFrequency - incrementalBackupFrequencyTimeUnit - runningState - scheduleName - scheduleUUID - status - tableByTableBackup - taskType - useLocalTimezone type: object DrConfigSwitchoverForm: description: drConfig failover form example: drReplicaUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 primaryUniverseUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: drReplicaUniverseUuid: description: New dr replica universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 primaryUniverseUuid: description: New primary universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: object MultiTableBackupRequestParams: description: Multi-table backup parameters example: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 2 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 - backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 3 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 properties: actionType: description: Action type enum: - CREATE - RESTORE - RESTORE_KEYS - DELETE type: string example: CREATE allTables: description: Backup all tables in Keyspace type: boolean example: true alterLoadBalancer: description: Alter load balancer state type: boolean example: true backupList: description: Backups items: $ref: '#/components/schemas/BackupTableParams' type: array example: - backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: '2021-06-17T15:00:05+00:00' timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: '2022-12-12T13:07:18+00:00' uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 backupPointInTimeRestoreWindow: $ref: '#/components/schemas/BackupPointInTimeRestoreWindow' backupSizeInBytes: description: Backup size in bytes format: int64 type: integer example: 10 backupType: description: Backup type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE backupUuid: description: Backup UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: description: Base backup UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string example: example-cmkArn communicationPorts: $ref: '#/components/schemas/CommunicationPorts' creatingUser: $ref: '#/components/schemas/Users' cronExpression: description: Cron expression for a recurring backup type: string example: example-cronExpression customerUuid: description: Customer UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: $ref: '#/components/schemas/DeviceInfo' disableChecksum: description: Disable checksum type: boolean example: true disableMultipart: description: Disable multipart upload type: boolean example: true disableParallelism: description: Don't add -m flag during gsutil upload dir command type: boolean example: true enableVerboseLogs: description: Is verbose logging enabled type: boolean example: true enableYbc: type: boolean example: true encryptionAtRestConfig: $ref: '#/components/schemas/EncryptionAtRestConfig' errorString: description: Error message type: string example: example-errorString expectedUniverseVersion: description: Expected universe version format: int32 type: integer example: 100 expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS extraDependencies: $ref: '#/components/schemas/ExtraDependencies' fullBackup: type: boolean example: true fullChainSizeInBytes: description: Incremental backups chain size format: int64 type: integer example: 10 ignoreErrors: description: Should table backup errors be ignored type: boolean example: true installYbc: type: boolean example: true isFullBackup: description: Full Table type backup type: boolean example: true keyspace: description: Key space type: string example: example-key kmsConfigUUID: description: KMS configuration UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minNumBackupsToRetain: description: Minimum number of backups to retain for a particular backup schedule format: int32 type: integer example: 10 newOwner: description: User name of the new tables owner type: string example: example-newOwner nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails' type: array uniqueItems: true example: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: '2022-12-12T13:07:18+00:00' tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 nodeExporterUser: description: Node exporter user type: string example: '5433' oldOwner: description: User name of the current tables owner type: string example: example-oldOwner parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer example: 100 platformUrl: type: string example: https://example.com platformVersion: readOnly: true type: string example: 2.20.0.0 pointInTimeRestoreEnabled: description: Point in time restore available type: boolean example: true previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: description: Per region locations items: $ref: '#/components/schemas/RegionLocations' type: array example: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION restoreTimeStamp: description: Restore TimeStamp type: string example: '2026-05-03T12:00:00Z' runOnlyPrechecks: description: YbaApi Internal. Run only prechecks during task run type: boolean example: true scheduleName: description: Schedule Name type: string example: example-scheduleName scheduleUUID: description: Schedule UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 schedulingFrequency: description: Frequency to run the backup, in milliseconds format: int64 type: integer example: 1000 sleepAfterMasterRestartMillis: format: int32 type: integer example: 100 sleepAfterTServerRestartMillis: format: int32 type: integer example: 100 sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: description: Is SSE type: boolean example: true storageConfigType: description: Type of backup storage config enum: - S3 - NFS - AZ - GCS - FILE type: string example: S3 storageConfigUUID: description: Storage configuration UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageLocation: description: Storage location type: string example: example-storageLocation tableByTableBackup: description: Table by table backup type: boolean example: true tableName: description: Table name type: string example: example-tableName tableNameList: description: Tables items: type: string type: array example: - example-tableNameList tableUUID: description: Table UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableUUIDList: description: Table UUIDs items: format: uuid type: string type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tablespacesList: description: Tablespaces info items: $ref: '#/components/schemas/Tablespace' type: array example: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer example: 1000 timeTakenPartial: format: int64 type: integer example: 1000 transactionalBackup: description: Is backup transactional across tables type: boolean example: true universeUUID: description: Associated universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 useRoles: description: Backup global ysql roles type: boolean example: true useTablespaces: description: Is tablespaces information included type: boolean example: true ybPrevSoftwareVersion: description: Previous software version type: string example: 2.20.0.0 ybcInstalled: type: boolean example: true ybcSoftwareVersion: type: string example: 2.20.0.0 required: - creatingUser - fullBackup - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis - storageConfigUUID - timeTakenPartial type: object KeyspaceTables: example: keyspace: keyspace tableNames: - tableNames - tableNames properties: keyspace: description: Keyspace type: string example: example-key tableNames: description: Tables items: type: string type: array uniqueItems: true example: - example-tableNames type: object DrConfigSetTablesForm: description: dr config set tables form example: tables: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 autoIncludeIndexTables: true properties: autoIncludeIndexTables: description: Whether or not YBA should also include all index tables from any provided main tables. type: boolean example: true bootstrapParams: $ref: '#/components/schemas/RestartBootstrapParams' tables: description: Source universe table IDs example: '["000033df000030008000000000004006", "000033df00003000800000000000400b"]' items: type: string type: array uniqueItems: true type: object Tablespace: example: replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName properties: replicaPlacement: $ref: '#/components/schemas/ReplicaPlacement' tablespaceName: maxLength: 2147483647 minLength: 1 type: string example: example-tablespaceName required: - replicaPlacement - tablespaceName type: object Backup: description: A single backup. Includes the backup's status, expiration time, and configuration. example: scheduleName: scheduleName parentBackup: true expiryTimeUnit: NANOSECONDS retryCount: 1 hasKMSHistory: true kubernetesOperatorControlled: true updateTime: 2022-12-12 13:07:18+00:00 incrementalBackup: true taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 version: V1 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 completionTime: 2022-12-12 13:07:18+00:00 storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiry: 2022-12-12 13:07:18+00:00 state: DELETED category: YB_BACKUP_SCRIPT firstSnapshotTime: 1 backupInfo: backupSizeInBytes: 0 expectedUniverseVersion: 6 scheduleName: scheduleName tableByTableBackup: true sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 sse: true nodeExporterUser: nodeExporterUser storageLocation: storageLocation allTables: true tableName: tableName useRoles: true alterLoadBalancer: true customerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 enableVerboseLogs: true scheduleUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 disableChecksum: true sleepAfterTServerRestartMillis: 9 backupPointInTimeRestoreWindow: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 tableUUIDList: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ignoreErrors: true pointInTimeRestoreEnabled: true targetXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 deviceInfo: cloudVolumeEncryption: enableVolumeEncryption: true kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 diskIops: 6 storageClass: storageClass numVolumes: 7 mountPoints: mountPoints storageType: IO1 throughput: 1 volumeSize: 4 enableYbc: true nodeDetailsSet: - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 - nodeName: nodeName nodeExporterPort: 3 placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 ybControllerHttpPort: 3 dedicatedTo: MASTER machineImage: machineImage redisServerHttpPort: 2 masterState: ToStart tserverRpcPort: 6 ysqlServerHttpPort: 7 yqlServerRpcPort: 0 otelCollectorMetricsPort: 1 isMaster: true sshUserOverride: sshUserOverride cloudInfo: mount_roots: mount_roots kubernetesNamespace: kubernetesNamespace public_ip: public_ip secondary_subnet_id: secondary_subnet_id private_dns: private_dns useTimeSync: true kubernetesPodName: kubernetesPodName root_volume: root_volume secondary_private_ip: secondary_private_ip private_ip: private_ip cloud: cloud lun_indexes: - 6 - 6 assignPublicIP: true az: az subnet_id: subnet_id public_dns: public_dns region: region instance_type: instance_type sshPortOverride: 6 cronsActive: true state: Provisioned nodeIdx: 6 masterRpcPort: 6 redisServerRpcPort: 6 lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00 tserverHttpPort: 5 disksAreMountedByUUID: true isRedisServer: true ybPrebuiltAmi: true internalYsqlServerRpcPort: 8 isTserver: true nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 isYsqlServer: true ybControllerRpcPort: 3 isYqlServer: true azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 masterHttpPort: 9 ysqlServerRpcPort: 6 autoSyncMasterAddrs: true yqlServerHttpPort: 7 transactionalBackup: true oldOwner: oldOwner timeTakenPartial: 1 ybcInstalled: true communicationPorts: nodeExporterPort: 5 tserverHttpPort: 9 internalYsqlServerRpcPort: 0 ybControllerHttpPort: 2 redisServerHttpPort: 2 ybControllerrRpcPort: 4 tserverRpcPort: 3 ysqlServerHttpPort: 1 yqlServerRpcPort: 1 masterHttpPort: 6 otelCollectorMetricsPort: 5 ysqlServerRpcPort: 1 yqlServerHttpPort: 7 masterRpcPort: 1 redisServerRpcPort: 7 sleepAfterMasterRestartMillis: 7 useTablespaces: true minNumBackupsToRetain: 5 isFullBackup: true expiryTimeUnit: NANOSECONDS parallelism: 5 backupUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK newOwner: newOwner backupList: - - backupType: YQL_TABLE_TYPE disableParallelism: true storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 regionLocations: - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION - LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION ybcSoftwareVersion: ybcSoftwareVersion creatingUser: ldapSpecifiedRole: true customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 role: Admin authTokenIssueDate: 2021-06-17 15:00:05+00:00 timezone: timezone oidcJwtAuthToken: oidcJwtAuthToken groupMemberships: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 userType: local creationDate: 2022-12-12 13:07:18+00:00 uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 email: username1@example.com primary: true extraDependencies: installNodeExporter: true platformVersion: platformVersion fullChainSizeInBytes: 1 tablespacesList: - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName - replicaPlacement: numReplicas: 1 placementBlocks: - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region - cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region tablespaceName: tablespaceName restoreTimeStamp: restoreTimeStamp disableMultipart: true runOnlyPrechecks: true platformUrl: platformUrl timeBeforeDelete: 7 ybPrevSoftwareVersion: ybPrevSoftwareVersion cronExpression: cronExpression tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 actionType: CREATE keyspace: keyspace universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString installYbc: true tableNameList: - tableNameList - tableNameList schedulingFrequency: 2 cmkArn: cmkArn fullBackup: true previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 storageConfigType: S3 universeName: universeName properties: backupInfo: $ref: '#/components/schemas/BackupTableParams' backupUUID: description: Backup UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 baseBackupUUID: description: Base backup UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 category: description: Category of the backup enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string example: YB_BACKUP_SCRIPT completionTime: description: Backup completion time example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string createTime: description: Backup creation time example: 2022-12-12 13:07:18+00:00 format: date-time type: string customerUUID: description: Customer UUID that owns this backup format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 expiry: description: Expiry time (unix timestamp) of the backup example: 2022-12-12 13:07:18+00:00 format: date-time type: string expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string example: NANOSECONDS firstSnapshotTime: description: First snapshot time in this backup format: int64 readOnly: true type: integer example: 1000 hasKMSHistory: description: Whether the backup has KMS history metadata readOnly: true type: boolean example: true incrementalBackup: type: boolean example: true kubernetesOperatorControlled: type: boolean example: true parentBackup: type: boolean example: true retryCount: description: Retry count for backup deletion format: int32 type: integer example: 10 scheduleName: description: Schedule Policy Name, if this backup is part of a schedule type: string example: example-scheduleName scheduleUUID: description: Schedule UUID, if this backup is part of a schedule format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 state: description: State of the backup enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopping - Stopped - QueuedForDeletion - QueuedForForcedDeletion - DeleteInProgress example: DELETED readOnly: true type: string storageConfigUUID: description: Storage Config UUID that created this backup format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 taskUUID: description: Backup UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeName: description: Universe name that created this backup type: string example: example-universeName updateTime: description: Backup update time example: 2022-12-12 13:07:18+00:00 format: date-time type: string version: description: Version of the backup in a category enum: - V1 - V2 type: string example: V1 required: - incrementalBackup - kubernetesOperatorControlled - parentBackup type: object TablespaceResponse: example: conflictingTablespaces: - conflictingTablespaces - conflictingTablespaces unsupportedTablespaces: - unsupportedTablespaces - unsupportedTablespaces containsTablespaces: true properties: conflictingTablespaces: items: type: string type: array example: - example-conflictingTablespaces containsTablespaces: type: boolean example: true unsupportedTablespaces: items: type: string type: array example: - '5433' required: - conflictingTablespaces - containsTablespaces - unsupportedTablespaces type: object DrConfigEditForm: description: drConfig edit form example: bootstrapParams: backupRequestParams: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parallelism: 0 webhookUrls: - webhookUrls - webhookUrls pitrParams: snapshotIntervalSec: 1 retentionPeriodSec: 6 properties: bootstrapParams: $ref: '#/components/schemas/RestartBootstrapParams' pitrParams: $ref: '#/components/schemas/PitrParams' webhookUrls: description: List of urls for webhook items: type: string type: array example: - https://example.com type: object YBPSuccess: example: success: true message: message properties: message: description: API response message. readOnly: true type: string example: Example message success: description: API operation status. A value of true indicates the operation was successful. readOnly: true type: boolean example: true type: object TableInfoResp: description: Table information response example: relationType: SYSTEM_TABLE_RELATION colocated: true walSizeBytes: 3.616076749251911 indexTableIDs: - indexTableIDs - indexTableIDs pgSchemaName: public sizeBytes: 9.301444243932576 tableName: tableName tableSpace: tableSpace tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableType: YQL_TABLE_TYPE keySpace: keySpace tableID: tableID nameSpace: nameSpace colocationParentId: colocationParentId properties: colocated: description: Flag, indicating colocated table type: boolean example: true colocationParentId: description: Colocation parent id type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 indexTableIDs: description: Index Table IDs of main table items: type: string type: array example: - example-indexTableIDs keySpace: description: Keyspace type: string example: example-key mainTableUUID: description: Main Table UUID of index tables format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nameSpace: description: Namespace or Schema type: string example: example-nameSpace parentTableUUID: description: Parent Table UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 pgSchemaName: description: Postgres schema name of the table example: public type: string relationType: description: Relation type enum: - SYSTEM_TABLE_RELATION - USER_TABLE_RELATION - INDEX_TABLE_RELATION - MATVIEW_TABLE_RELATION - COLOCATED_PARENT_TABLE_RELATION type: string example: SYSTEM_TABLE_RELATION sizeBytes: description: SST size in bytes format: double readOnly: true type: number example: 1.5 tableID: description: Table ID readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 tableName: description: Table name type: string example: example-tableName tableSpace: description: Table space type: string example: example-tableSpace tableType: description: Table type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE tableUUID: description: Table UUID format: uuid readOnly: true type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 walSizeBytes: description: WAL size in bytes format: double readOnly: true type: number example: 1.5 type: object