openapi: 3.1.0 info: title: YugabyteDB Aeon REST Access Keys Backups API description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page. version: v1 contact: name: Yugabyte Support url: https://support.yugabyte.com termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/ x-generated-from: documentation x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/ x-last-validated: '2026-05-03' servers: - url: https://cloud.yugabyte.com/api/public/v1 description: YugabyteDB Aeon Production Server security: - bearerAuth: [] tags: - name: Backups description: Manage backup schedules and trigger on-demand backups for YugabyteDB Aeon clusters. Backups are stored in the same region as the cluster. paths: /accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/backups: get: operationId: listBackups summary: YugabyteDB Aeon List Backups description: Returns all backups for the specified cluster, including both scheduled and on-demand backups. Each entry includes backup state, creation time, expiry time, and size information. tags: - Backups parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/projectId' - $ref: '#/components/parameters/clusterId' responses: '200': description: List of backups returned successfully content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Backup' examples: ListBackups200Example: summary: Default listBackups 200 response x-microcks-default: true value: data: - id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cluster_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 state: SUCCEEDED backup_type: SCHEDULED retention_period_in_days: 100 created_at: '2026-05-03T12:00:00Z' expiry_time: '2026-05-03T12:00:00Z' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createBackup summary: YugabyteDB Aeon Create On-demand Backup description: Triggers an immediate on-demand backup of the specified cluster. The backup is a full cluster snapshot stored in the same region as the cluster. Retention period can be specified in days. tags: - Backups parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/projectId' - $ref: '#/components/parameters/clusterId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BackupSpec' examples: CreateBackupRequestExample: summary: Default createBackup request x-microcks-default: true value: retention_period_in_days: 100 responses: '200': description: Backup initiated successfully content: application/json: schema: $ref: '#/components/schemas/Backup' examples: CreateBackup200Example: summary: Default createBackup 200 response x-microcks-default: true value: id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cluster_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 state: SUCCEEDED backup_type: SCHEDULED retention_period_in_days: 100 created_at: '2026-05-03T12:00:00Z' expiry_time: '2026-05-03T12:00:00Z' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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_2' 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: - null - null 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_2' 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: - null - null 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}/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}/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}/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_2' 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: - null - null 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: - null - null 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_2' 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: - null - null 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: - null - null 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: - null - null 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}/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: - null - null 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/{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 /api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state: put: description: Available since YBA version 2.2.0.0. operationId: setUniverseBackupFlag 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: markActive schema: type: boolean example: true - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPSuccess' examples: SetUniverseBackupFlag200Example: summary: Default setUniverseBackupFlag 200 response x-microcks-default: true value: success: true message: message description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Set a Universe's Backup Flag tags: - Backups x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: 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 Parameters for Restore preflight checks: properties: backupUUID: description: UUID of the backup being restored format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspaceTables: description: List of keyspace(s) and tables to be restored items: $ref: '#/components/schemas/KeyspaceTables' type: array example: - keyspace: keyspace tableNames: - tableNames - tableNames restoreToPointInTimeMillis: description: Point in restore timestamp in millis format: int64 type: integer example: 1000 universeUUID: description: Target universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - backupUUID - universeUUID 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 Parameters for validating Restorable keyspace and tables in backup: properties: backupUUID: description: UUID of the backup being restored format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 keyspaceTables: description: List of keyspace(s) and tables to be restored items: $ref: '#/components/schemas/KeyspaceTables' type: array example: - keyspace: keyspace tableNames: - tableNames - tableNames restoreToPointInTimeMillis: description: Point in restore timestamp in millis format: int64 type: integer example: 1000 required: - backupUUID 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 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 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: - null - null 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: - null - null 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 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 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 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 YBPTasks: 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 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: - null - null 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: - null - null 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: - null - null 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 BackupSpec: type: object description: Specification for creating an on-demand cluster backup. properties: retention_period_in_days: type: integer description: Number of days to retain this backup. Defaults to 8 if not specified. minimum: 1 maximum: 365 example: 100 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 Backup: type: object description: A backup snapshot of a YugabyteDB Aeon cluster. properties: id: type: string format: uuid description: Unique identifier for the backup. example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 cluster_id: type: string format: uuid description: The cluster this backup belongs to. example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 state: type: string description: Current state of the backup operation. enum: - SUCCEEDED - IN_PROGRESS - FAILED - DELETED example: SUCCEEDED backup_type: type: string description: Whether this backup was scheduled or on-demand. enum: - SCHEDULED - ON_DEMAND example: SCHEDULED retention_period_in_days: type: integer description: Number of days this backup is retained before automatic deletion. example: 100 created_at: type: string format: date-time description: Timestamp when the backup was created. example: '2026-05-03T12:00:00Z' expiry_time: type: string format: date-time description: Timestamp when the backup will be automatically deleted. example: '2026-05-03T12:00:00Z' 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 Parameters for Advanced Restore preflight checks: properties: backupLocations: description: List of backup locations to restore from items: type: string type: array uniqueItems: true example: - example-backupLocations restoreToPointInTimeMillis: description: Point in restore timestamp in millis format: int64 type: integer example: 1000 storageConfigUUID: description: Storage config UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 universeUUID: description: Target universe UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - backupLocations - storageConfigUUID - universeUUID 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 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 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 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 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 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 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 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 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 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 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 Backup_2: 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: - null - null 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 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 ExtraDependencies: description: Extra dependencies example: installNodeExporter: true properties: installNodeExporter: description: Install node exporter on nodes type: boolean example: true 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 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 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 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 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 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 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 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 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 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 ErrorResponse: type: object description: Standard error response returned by the API on failure. properties: error: type: object properties: code: type: string description: Machine-readable error code. example: OK message: type: string description: Human-readable description of the error. example: Example message status: type: integer description: HTTP status code. example: 100 example: code: OK message: Example message status: 100 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 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 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 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 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 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 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 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 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 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 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 ReplicaPlacement_2: 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 placementBlocks: items: $ref: '#/components/schemas/PlacementBlock_2' maxItems: 2147483647 minItems: 1 type: array required: - numReplicas - placementBlocks type: object Parameters for Restore preflight checks_2: properties: backupUUID: description: UUID of the backup being restored format: uuid type: string keyspaceTables: description: List of keyspace(s) and tables to be restored items: $ref: '#/components/schemas/KeyspaceTables_2' type: array restoreToPointInTimeMillis: description: Point in restore timestamp in millis format: int64 type: integer universeUUID: description: Target universe UUID format: uuid type: string required: - backupUUID - universeUUID type: object NodeDetails_2: 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 azUuid: description: The availability zone's UUID format: uuid type: string cloudInfo: $ref: '#/components/schemas/CloudSpecificInfo_2' cronsActive: description: True if cron jobs were properly configured for this node type: boolean dedicatedTo: description: Used for configurations where each node can have only one process enum: - MASTER - TSERVER - CONTROLLER - YQLSERVER - YSQLSERVER - REDISSERVER - EITHER type: string disksAreMountedByUUID: description: Disks are mounted by uuid type: boolean internalYsqlServerRpcPort: description: Internal YSQL RPC port format: int32 type: integer isMaster: description: True if this node is a master type: boolean isRedisServer: description: True if this node is a REDIS server type: boolean isTserver: description: True if this node is a Tablet server type: boolean isYqlServer: description: True if this node is a YCQL server type: boolean isYsqlServer: description: True if this node is a YSQL server type: boolean 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 masterHttpPort: description: Master HTTP port format: int32 type: integer masterRpcPort: description: Master RPC port format: int32 type: integer masterState: description: Master state enum: - None - ToStart - Configured - ToStop example: ToStart type: string nodeExporterPort: description: Node exporter port format: int32 type: integer nodeIdx: description: Node ID format: int32 type: integer nodeName: description: Node name type: string nodeUuid: description: Node UUID format: uuid type: string otelCollectorMetricsPort: description: Otel collector metrics port format: int32 type: integer placementUuid: description: UUID of the cluster to which this node belongs format: uuid type: string redisServerHttpPort: description: REDIS HTTP port format: int32 type: integer redisServerRpcPort: description: REDIS RPC port format: int32 type: integer sshPortOverride: description: SSH port override for the AMI format: int32 type: integer sshUserOverride: description: SSH user override for the AMI type: string 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 tserverRpcPort: description: Tablet server RPC port format: int32 type: integer ybControllerHttpPort: description: Yb controller HTTP port format: int32 type: integer ybControllerRpcPort: description: Yb controller RPC port format: int32 type: integer ybPrebuiltAmi: description: True if this a custom YB AMI type: boolean yqlServerHttpPort: description: YCQL HTTP port format: int32 type: integer yqlServerRpcPort: description: YCQL RPC port format: int32 type: integer ysqlServerHttpPort: description: YSQL HTTP port format: int32 type: integer ysqlServerRpcPort: description: YSQL RPC port format: int32 type: integer type: object Parameters for validating Restorable keyspace and tables in backup_2: properties: backupUUID: description: UUID of the backup being restored format: uuid type: string keyspaceTables: description: List of keyspace(s) and tables to be restored items: $ref: '#/components/schemas/KeyspaceTables_2' type: array restoreToPointInTimeMillis: description: Point in restore timestamp in millis format: int64 type: integer required: - backupUUID type: object BackupResp_2: 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 category: enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string commonBackupInfo: $ref: '#/components/schemas/CommonBackupInfo_2' customerUUID: format: uuid type: string 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 fullChainSizeInBytes: format: int64 type: integer hasIncrementalBackups: type: boolean isFullBackup: type: boolean isStorageConfigPresent: type: boolean isUniversePresent: type: boolean lastBackupState: enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopping - Stopped - QueuedForDeletion - QueuedForForcedDeletion - DeleteInProgress type: string lastIncrementalBackupTime: description: Time for last incremenatal backup. example: 2022-12-12 13:07:18+00:00 format: date-time type: string onDemand: type: boolean scheduleName: type: string scheduleUUID: format: uuid type: string storageConfigType: enum: - S3 - NFS - AZ - GCS - FILE type: string universeName: type: string universeUUID: format: uuid type: string useRoles: description: 'WARNING: This is a preview API that could change. Indicates if role objects were backed up' type: boolean useTablespaces: type: boolean required: - backupType - category - commonBackupInfo - customerUUID - expiryTimeUnit - fullChainSizeInBytes - hasIncrementalBackups - isFullBackup - isStorageConfigPresent - isUniversePresent - lastBackupState - onDemand - scheduleName - scheduleUUID - storageConfigType - universeName - universeUUID - useTablespaces type: object BackupTableParams_2: 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: - null - null 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 allTables: description: Backup all tables in Keyspace type: boolean alterLoadBalancer: description: Alter load balancer state type: boolean backupList: description: Backups items: $ref: '#/components/schemas/BackupTableParams_2' type: array backupPointInTimeRestoreWindow: $ref: '#/components/schemas/BackupPointInTimeRestoreWindow_2' backupSizeInBytes: description: Backup size in bytes format: int64 type: integer backupType: description: Backup type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string backupUuid: description: Backup UUID format: uuid type: string baseBackupUUID: description: Base backup UUID format: uuid type: string cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/components/schemas/CommunicationPorts_2' creatingUser: $ref: '#/components/schemas/Users_2' cronExpression: description: Cron expression for a recurring backup type: string customerUuid: description: Customer UUID format: uuid type: string deviceInfo: $ref: '#/components/schemas/DeviceInfo_2' disableChecksum: description: Disable checksum type: boolean disableMultipart: description: Disable multipart upload type: boolean disableParallelism: description: Don't add -m flag during gsutil upload dir command type: boolean enableVerboseLogs: description: Is verbose logging enabled type: boolean enableYbc: type: boolean encryptionAtRestConfig: $ref: '#/components/schemas/EncryptionAtRestConfig_2' errorString: description: Error message type: string expectedUniverseVersion: description: Expected universe version format: int32 type: integer expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string extraDependencies: $ref: '#/components/schemas/ExtraDependencies_2' fullBackup: type: boolean fullChainSizeInBytes: description: Incremental backups chain size format: int64 type: integer ignoreErrors: description: Should table backup errors be ignored type: boolean installYbc: type: boolean isFullBackup: description: Full Table type backup type: boolean keyspace: description: Key space type: string kmsConfigUUID: description: KMS configuration UUID format: uuid type: string minNumBackupsToRetain: description: Minimum number of backups to retain for a particular backup schedule format: int32 type: integer newOwner: description: User name of the new tables owner type: string nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails_2' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string oldOwner: description: User name of the current tables owner type: string parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer platformUrl: type: string platformVersion: readOnly: true type: string pointInTimeRestoreEnabled: description: Point in time restore available type: boolean previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string regionLocations: description: Per region locations items: $ref: '#/components/schemas/RegionLocations_2' type: array restoreTimeStamp: description: Restore TimeStamp type: string runOnlyPrechecks: description: YbaApi Internal. Run only prechecks during task run type: boolean scheduleName: description: Schedule Name type: string scheduleUUID: description: Schedule UUID format: uuid type: string schedulingFrequency: description: Frequency to run the backup, in milliseconds format: int64 type: integer sleepAfterMasterRestartMillis: format: int32 type: integer sleepAfterTServerRestartMillis: format: int32 type: integer sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array sse: description: Is SSE type: boolean storageConfigType: description: Type of backup storage config enum: - S3 - NFS - AZ - GCS - FILE type: string storageConfigUUID: description: Storage configuration UUID format: uuid type: string storageLocation: description: Storage location type: string tableByTableBackup: description: Table by table backup type: boolean tableName: description: Table name type: string tableNameList: description: Tables items: type: string type: array tableUUID: description: Table UUID format: uuid type: string tableUUIDList: description: Table UUIDs items: format: uuid type: string type: array tablespacesList: description: Tablespaces info items: $ref: '#/components/schemas/Tablespace_2' type: array targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer timeTakenPartial: format: int64 type: integer transactionalBackup: description: Is backup transactional across tables type: boolean universeUUID: description: Associated universe UUID format: uuid type: string useRoles: description: Backup global ysql roles type: boolean useTablespaces: description: Is tablespaces information included type: boolean ybPrevSoftwareVersion: description: Previous software version type: string ybcInstalled: type: boolean ybcSoftwareVersion: type: string required: - creatingUser - fullBackup - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis - storageConfigUUID - timeTakenPartial type: object RestoreKeyspace_2: 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 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 sourceKeyspace: description: Source keyspace name readOnly: true type: string state: description: State of the keyspace restore enum: - Created - InProgress - Completed - Failed - Aborted readOnly: true type: string storageLocation: description: Storage location name readOnly: true type: string tableNameList: description: Restored Table name List items: type: string readOnly: true type: array targetKeyspace: description: Target keyspace name readOnly: true type: string taskUUID: description: Restore Keyspace task UUID format: uuid readOnly: true type: string uuid: description: Restore keyspace UUID format: uuid readOnly: true type: string required: - backupSizeFromStorageLocation type: object YbcThrottleParametersResponse_2: 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_2' description: Map of YBC throttle parameters type: object type: object YBPTask_2: 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 taskUUID: description: Task UUID format: uuid readOnly: true type: string type: object EncryptionAtRestConfig_2: 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 kmsConfigUUID: description: KMS configuration UUID format: uuid type: string opType: description: 'Operation type: enable, disable, or rotate the universe key/encryption at rest' enum: - ENABLE - DISABLE - UNDEFINED type: string type: description: Whether to generate a data key or just retrieve the CMK ARN enum: - CMK - DATA_KEY type: string type: object PerLocationBackupInfo_2: 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 isSelectiveRestoreSupported: description: Whether selective table restore is supported for this backup type: boolean isYSQLBackup: description: Whether backup type is YSQL type: boolean perBackupLocationKeyspaceTables: $ref: '#/components/schemas/PerBackupLocationKeyspaceTables_2' pointInTimeRestoreWindow: $ref: '#/components/schemas/BackupPointInTimeRestoreWindow_2' tablespaceResponse: $ref: '#/components/schemas/TablespaceResponse_2' type: object MultiTableBackupRequestParams_2: 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: - null - null 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: - null - null 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 allTables: description: Backup all tables in Keyspace type: boolean alterLoadBalancer: description: Alter load balancer state type: boolean backupList: description: Backups items: $ref: '#/components/schemas/BackupTableParams_2' type: array backupPointInTimeRestoreWindow: $ref: '#/components/schemas/BackupPointInTimeRestoreWindow_2' backupSizeInBytes: description: Backup size in bytes format: int64 type: integer backupType: description: Backup type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string backupUuid: description: Backup UUID format: uuid type: string baseBackupUUID: description: Base backup UUID format: uuid type: string cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/components/schemas/CommunicationPorts_2' creatingUser: $ref: '#/components/schemas/Users_2' cronExpression: description: Cron expression for a recurring backup type: string customerUuid: description: Customer UUID format: uuid type: string deviceInfo: $ref: '#/components/schemas/DeviceInfo_2' disableChecksum: description: Disable checksum type: boolean disableMultipart: description: Disable multipart upload type: boolean disableParallelism: description: Don't add -m flag during gsutil upload dir command type: boolean enableVerboseLogs: description: Is verbose logging enabled type: boolean enableYbc: type: boolean encryptionAtRestConfig: $ref: '#/components/schemas/EncryptionAtRestConfig_2' errorString: description: Error message type: string expectedUniverseVersion: description: Expected universe version format: int32 type: integer expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string extraDependencies: $ref: '#/components/schemas/ExtraDependencies_2' fullBackup: type: boolean fullChainSizeInBytes: description: Incremental backups chain size format: int64 type: integer ignoreErrors: description: Should table backup errors be ignored type: boolean installYbc: type: boolean isFullBackup: description: Full Table type backup type: boolean keyspace: description: Key space type: string kmsConfigUUID: description: KMS configuration UUID format: uuid type: string minNumBackupsToRetain: description: Minimum number of backups to retain for a particular backup schedule format: int32 type: integer newOwner: description: User name of the new tables owner type: string nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails_2' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string oldOwner: description: User name of the current tables owner type: string parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer platformUrl: type: string platformVersion: readOnly: true type: string pointInTimeRestoreEnabled: description: Point in time restore available type: boolean previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string regionLocations: description: Per region locations items: $ref: '#/components/schemas/RegionLocations_2' type: array restoreTimeStamp: description: Restore TimeStamp type: string runOnlyPrechecks: description: YbaApi Internal. Run only prechecks during task run type: boolean scheduleName: description: Schedule Name type: string scheduleUUID: description: Schedule UUID format: uuid type: string schedulingFrequency: description: Frequency to run the backup, in milliseconds format: int64 type: integer sleepAfterMasterRestartMillis: format: int32 type: integer sleepAfterTServerRestartMillis: format: int32 type: integer sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array sse: description: Is SSE type: boolean storageConfigType: description: Type of backup storage config enum: - S3 - NFS - AZ - GCS - FILE type: string storageConfigUUID: description: Storage configuration UUID format: uuid type: string storageLocation: description: Storage location type: string tableByTableBackup: description: Table by table backup type: boolean tableName: description: Table name type: string tableNameList: description: Tables items: type: string type: array tableUUID: description: Table UUID format: uuid type: string tableUUIDList: description: Table UUIDs items: format: uuid type: string type: array tablespacesList: description: Tablespaces info items: $ref: '#/components/schemas/Tablespace_2' type: array targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer timeTakenPartial: format: int64 type: integer transactionalBackup: description: Is backup transactional across tables type: boolean universeUUID: description: Associated universe UUID format: uuid type: string useRoles: description: Backup global ysql roles type: boolean useTablespaces: description: Is tablespaces information included type: boolean ybPrevSoftwareVersion: description: Previous software version type: string ybcInstalled: type: boolean ybcSoftwareVersion: type: string required: - creatingUser - fullBackup - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis - storageConfigUUID - timeTakenPartial type: object Backup_3: 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: - null - null 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_2' backupUUID: description: Backup UUID format: uuid readOnly: true type: string baseBackupUUID: description: Base backup UUID format: uuid readOnly: true type: string category: description: Category of the backup enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string 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 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 firstSnapshotTime: description: First snapshot time in this backup format: int64 readOnly: true type: integer hasKMSHistory: description: Whether the backup has KMS history metadata readOnly: true type: boolean incrementalBackup: type: boolean kubernetesOperatorControlled: type: boolean parentBackup: type: boolean retryCount: description: Retry count for backup deletion format: int32 type: integer scheduleName: description: Schedule Policy Name, if this backup is part of a schedule type: string scheduleUUID: description: Schedule UUID, if this backup is part of a schedule format: uuid type: string 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 taskUUID: description: Backup UUID format: uuid readOnly: true type: string universeName: description: Universe name that created this backup type: string 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 required: - incrementalBackup - kubernetesOperatorControlled - parentBackup type: object EditBackupParams_2: 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 storageConfigUUID: description: New backup Storage config format: uuid type: string timeBeforeDeleteFromPresentInMillis: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer type: object BackupStorageInfo_2: 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 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 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 ignoreErrors: description: 'WARNING: This is a preview API that could change. Ignore all restore errors' type: boolean keyspace: description: Keyspace name type: string newOwner: description: User name of the new tables owner type: string oldOwner: description: User name of the current tables owner type: string selectiveTableRestore: description: Only restore selected tables instead of restoring all tables in backup type: boolean sse: description: Is SSE type: boolean storageLocation: description: Storage location type: string tableNameList: description: Tables items: type: string type: array useRoles: description: Restore global ysql roles type: boolean useTablespaces: description: Use tablespaces during restore type: boolean type: object Parameters for Advanced Restore preflight checks_2: properties: backupLocations: description: List of backup locations to restore from items: type: string type: array uniqueItems: true restoreToPointInTimeMillis: description: Point in restore timestamp in millis format: int64 type: integer storageConfigUUID: description: Storage config UUID format: uuid type: string universeUUID: description: Target universe UUID format: uuid type: string required: - backupLocations - storageConfigUUID - universeUUID type: object TablespaceResponse_2: example: conflictingTablespaces: - conflictingTablespaces - conflictingTablespaces unsupportedTablespaces: - unsupportedTablespaces - unsupportedTablespaces containsTablespaces: true properties: conflictingTablespaces: items: type: string type: array containsTablespaces: type: boolean unsupportedTablespaces: items: type: string type: array required: - conflictingTablespaces - containsTablespaces - unsupportedTablespaces type: object KeyspaceTable_2: 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 tableNameList: description: Tables items: type: string type: array tableUUIDList: description: Table UUIDs items: format: uuid type: string type: array type: object PerBackupLocationKeyspaceTables_2: example: originalKeyspace: originalKeyspace tableNameList: - tableNameList - tableNameList properties: originalKeyspace: description: Original keyspace name type: string tableNameList: description: List of parent tables associated with the keyspace items: type: string type: array type: object CloudSpecificInfo_2: 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 az: description: The node's availability zone type: string cloud: description: The node's cloud provider type: string instance_type: description: The node's instance type type: string kubernetesNamespace: description: Kubernetes namespace type: string kubernetesPodName: description: Pod name in Kubernetes type: string lun_indexes: description: Mounted disks LUN indexes items: format: int32 type: integer type: array mount_roots: description: Mount roots type: string private_dns: description: The node's private DNS type: string private_ip: description: The node's private IP address type: string public_dns: description: The node's public DNS name type: string public_ip: description: The node's public IP address type: string region: description: The node's region type: string root_volume: description: Root volume ID or name type: string secondary_private_ip: description: Secondary Private IP type: string secondary_subnet_id: description: Secondary Subnet IP type: string subnet_id: description: ID of the subnet on which this node is deployed type: string useTimeSync: description: True if `use time sync` is enabled type: boolean type: object YbcThrottleParameters_2: 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 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 maxConcurrentDownloads: description: Max concurrent downloads per node format: int64 type: integer maxConcurrentUploads: description: Max concurrent uploads per node format: int64 type: integer perDownloadNumObjects: description: Max objects per download per node format: int64 type: integer perUploadNumObjects: description: Max objects per upload per node format: int64 type: integer resetDefaults: description: Unset Throttle parameters in YB-Controller type: boolean type: object YBPSuccess_2: example: success: true message: message properties: message: description: API response message. readOnly: true type: string success: description: API operation status. A value of true indicates the operation was successful. readOnly: true type: boolean type: object RestorePagedApiQuery_2: 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 filter: $ref: '#/components/schemas/RestoreApiFilter_2' limit: format: int32 type: integer needTotalCount: type: boolean offset: format: int32 type: integer sortBy: enum: - createTime type: string required: - direction - filter - limit - needTotalCount - offset - sortBy type: object UniverseBackupRequestFormData_2: 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 platformVersion: readOnly: true type: string previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string storageConfigUUID: description: 'WARNING: This is a preview API that could change.Storage configuration UUID' format: uuid type: string timeBeforeDelete: description: 'WARNING: This is a preview API that could change.Time before deleting the backup from storage, in milliseconds' format: int64 type: integer required: - storageConfigUUID type: object RestorePagedApiResponse_2: 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_2' type: array hasNext: type: boolean hasPrev: type: boolean totalCount: format: int32 type: integer required: - entities - hasNext - hasPrev - totalCount type: object KeyspaceTablesList_2: 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 backupPointInTimeRestoreWindow: $ref: '#/components/schemas/BackupPointInTimeRestoreWindow_2' backupSizeInBytes: format: int64 type: integer defaultLocation: type: string keyspace: type: string perRegionLocations: items: $ref: '#/components/schemas/RegionLocations_2' type: array tableUUIDList: items: format: uuid type: string type: array tablesList: items: type: string type: array required: - allTables - backupPointInTimeRestoreWindow - backupSizeInBytes - defaultLocation - keyspace - perRegionLocations - tableUUIDList - tablesList type: object RegionLocations_2: example: LOCATION: LOCATION HOST_BASE: HOST_BASE REGION: REGION properties: HOST_BASE: type: string LOCATION: type: string REGION: type: string required: - HOST_BASE - LOCATION - REGION type: object RestoreApiFilter_2: 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 restoreUUIDList: items: format: uuid type: string type: array uniqueItems: true showHidden: type: boolean sourceUniverseNameList: items: type: string type: array uniqueItems: true states: items: enum: - Created - InProgress - Completed - Failed - Aborted type: string type: array uniqueItems: true storageConfigUUIDList: items: format: uuid type: string type: array uniqueItems: true universeNameList: items: type: string type: array uniqueItems: true universeUUIDList: items: format: uuid type: string type: array uniqueItems: true required: - onlyShowDeletedSourceUniverses - restoreUUIDList - showHidden - sourceUniverseNameList - states - storageConfigUUIDList - universeNameList - universeUUIDList type: object ExtraDependencies_2: description: Extra dependencies example: installNodeExporter: true properties: installNodeExporter: description: Install node exporter on nodes type: boolean type: object BackupPointInTimeRestoreWindow_2: example: timestampRetentionWindowEndMillis: 0 timestampRetentionWindowStartMillis: 6 properties: timestampRetentionWindowEndMillis: format: int64 type: integer timestampRetentionWindowStartMillis: format: int64 type: integer required: - timestampRetentionWindowEndMillis - timestampRetentionWindowStartMillis type: object PlacementBlock_2: example: cloud: cloud leader_preference: 1 zone: zone min_num_replicas: 1 region: region properties: cloud: description: Cloud maxLength: 2147483647 minLength: 1 type: string leader_preference: description: Leader preference format: int32 minimum: 1 type: integer min_num_replicas: description: Minimum replicas format: int32 minimum: 1 type: integer region: description: Region maxLength: 2147483647 minLength: 1 type: string zone: description: Zone maxLength: 2147483647 minLength: 1 type: string required: - cloud - region - zone type: object BackupPagedApiResponse_2: 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_2' type: array hasNext: type: boolean hasPrev: type: boolean totalCount: format: int32 type: integer required: - entities - hasNext - hasPrev - totalCount type: object RestorePreflightResponse_2: 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 hasKMSHistory: description: Whether backup was KMS encrypted type: boolean perLocationBackupInfoMap: additionalProperties: $ref: '#/components/schemas/PerLocationBackupInfo_2' description: Map of backup location and backup-info object type: object type: object BackupApiFilter_2: 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 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 onlyShowDeletedConfigs: type: boolean onlyShowDeletedUniverses: type: boolean scheduleUUIDList: items: format: uuid type: string type: array uniqueItems: true showHidden: type: boolean states: items: enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopping - Stopped - QueuedForDeletion - QueuedForForcedDeletion - DeleteInProgress type: string type: array uniqueItems: true storageConfigUUIDList: items: format: uuid type: string type: array uniqueItems: true universeNameList: items: type: string type: array uniqueItems: true universeUUIDList: items: format: uuid type: string type: array uniqueItems: true required: - backupUUIDList - keyspaceList - onlyShowDeletedConfigs - onlyShowDeletedUniverses - scheduleUUIDList - showHidden - states - storageConfigUUIDList - universeNameList - universeUUIDList type: object BackupRequestParams_2: 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 backupCategory: description: Overrides whether you want to use YBC based or script based backup. enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string backupStats: description: 'WARNING: This is a preview API that could change. Backup stats with YSQL dump.' type: boolean backupType: description: Backup type enum: - PGSQL_TABLE_TYPE - YQL_TABLE_TYPE - REDIS_TABLE_TYPE type: string backupUUID: format: uuid type: string baseBackupUUID: description: UUID of the parent backup format: uuid type: string cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/components/schemas/CommunicationPorts_2' creatingUser: $ref: '#/components/schemas/Users_2' cronExpression: description: Cron expression for a recurring backup type: string customerUUID: description: Customer UUID format: uuid type: string deviceInfo: $ref: '#/components/schemas/DeviceInfo_2' disableChecksum: description: Disable checksum type: boolean disableMultipart: description: Disable multipart upload type: boolean disableParallelism: description: Don't add -m flag during gsutil upload dir command type: boolean 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 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 enableVerboseLogs: description: Is verbose logging enabled type: boolean enableYbc: type: boolean encryptionAtRestConfig: $ref: '#/components/schemas/EncryptionAtRestConfig_2' errorString: description: Error message type: string expectedUniverseVersion: description: Expected universe version format: int32 type: integer expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string extraDependencies: $ref: '#/components/schemas/ExtraDependencies_2' frequencyTimeUnit: description: Time unit for user input schedule frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string ignoreErrors: description: Should table backup errors be ignored type: boolean incrementalBackupFrequency: description: Frequency of incremental backups format: int64 type: integer incrementalBackupFrequencyTimeUnit: description: Time unit for user input incremental backup schedule frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string installYbc: type: boolean keyspaceTableList: description: Backup info items: $ref: '#/components/schemas/KeyspaceTable_2' type: array kmsConfigUUID: description: KMS configuration UUID format: uuid type: string minNumBackupsToRetain: description: Minimum number of backups to retain for a particular backup schedule format: int32 type: integer nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails_2' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string parallelDBBackups: description: Parallel DB backups format: int32 type: integer parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer platformUrl: type: string platformVersion: readOnly: true type: string previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string runOnlyPrechecks: description: YbaApi Internal. Run only prechecks during task run type: boolean scheduleName: description: Schedule Name type: string scheduleUUID: description: Schedule UUID format: uuid type: string schedulingFrequency: description: Frequency to run the backup, in milliseconds format: int64 type: integer sleepAfterMasterRestartMillis: format: int32 type: integer sleepAfterTServerRestartMillis: format: int32 type: integer sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array sse: description: Is SSE type: boolean storageConfigUUID: description: Storage configuration UUID format: uuid type: string tableByTableBackup: description: Take table by table backups type: boolean targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer universeUUID: description: Universe UUID format: uuid type: string useLocalTimezone: description: Use local timezone for Cron Expression, otherwise use UTC type: boolean useRoles: description: Backup global ysql roles type: boolean useTablespaces: description: Is tablespaces information included type: boolean ybPrevSoftwareVersion: description: Previous software version type: string ybcInstalled: type: boolean ybcSoftwareVersion: type: string required: - backupUUID - creatingUser - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis - storageConfigUUID - universeUUID type: object BackupPagedApiQuery_2: 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 filter: $ref: '#/components/schemas/BackupApiFilter_2' limit: format: int32 type: integer needTotalCount: type: boolean offset: format: int32 type: integer sortBy: enum: - createTime type: string required: - direction - filter - limit - needTotalCount - offset - sortBy type: object Users_2: 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 email: description: User email address example: username1@example.com type: string groupMemberships: items: format: uuid type: string type: array uniqueItems: true ldapSpecifiedRole: description: LDAP Specified Role type: boolean oidcJwtAuthToken: readOnly: true type: string primary: type: boolean 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 userType: description: User Type enum: - local - ldap - oidc type: string uuid: description: User UUID format: uuid readOnly: true type: string required: - email - groupMemberships - primary type: object DeviceInfo_2: 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_2' diskIops: description: Desired IOPS for the volumes mounted on this instance format: int32 type: integer mountPoints: description: Comma-separated list of mount points for the devices in each instance type: string numVolumes: description: Number of volumes to be mounted on this instance at the default path format: int32 type: integer storageClass: description: Name of the storage class type: string 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 throughput: description: Desired throughput for the volumes mounted on this instance format: int32 type: integer volumeSize: description: The size of each volume in each instance. Could be modified in payload for /resize_node API call format: int32 type: integer type: object Tablespace_2: 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_2' tablespaceName: maxLength: 2147483647 minLength: 1 type: string required: - replicaPlacement - tablespaceName type: object DeleteBackupParams_2: 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_2' type: array deleteForcefully: description: Delete Backups forcefully type: boolean required: - deleteBackupInfos type: object RestoreResp_2: 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 createTime: description: Restore creation time. example: 2022-12-12 13:07:18+00:00 format: date-time type: string customerUUID: format: uuid type: string isSourceUniversePresent: type: boolean restoreKeyspaceList: items: $ref: '#/components/schemas/RestoreKeyspace_2' type: array restoreSizeInBytes: format: int64 type: integer restoreUUID: format: uuid type: string sourceUniverseName: type: string sourceUniverseUUID: format: uuid type: string state: enum: - Created - InProgress - Completed - Failed - Aborted type: string targetUniverseName: type: string universeUUID: format: uuid type: string 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 CloudVolumeEncryption_2: 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 kmsConfigUUID: description: KMS config UUID to be used for volume encryption format: uuid type: string type: object PresetThrottleValues_2: example: minValue: 5 defaultValue: 6 maxValue: 1 properties: defaultValue: format: int64 type: integer maxValue: format: int64 type: integer minValue: format: int64 type: integer required: - defaultValue - maxValue - minValue type: object CommunicationPorts_2: 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 masterHttpPort: description: Master table HTTP port format: int32 type: integer masterRpcPort: description: Master table RCP port format: int32 type: integer nodeExporterPort: description: Node exporter port format: int32 type: integer otelCollectorMetricsPort: description: Otel Collector metrics port format: int32 type: integer redisServerHttpPort: description: Redis HTTP port format: int32 type: integer redisServerRpcPort: description: Redis RPC port format: int32 type: integer tserverHttpPort: description: Tablet server HTTP port format: int32 type: integer tserverRpcPort: description: Tablet server RPC port format: int32 type: integer ybControllerHttpPort: description: Yb controller HTTP port format: int32 type: integer ybControllerrRpcPort: description: Yb controller RPC port format: int32 type: integer yqlServerHttpPort: description: YQL HTTP port format: int32 type: integer yqlServerRpcPort: description: YQL RPC port format: int32 type: integer ysqlServerHttpPort: description: YSQL HTTP port format: int32 type: integer ysqlServerRpcPort: description: YSQL RPC port format: int32 type: integer type: object RestoreBackupParams_2: 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 alterLoadBalancer: description: Alter load balancer state type: boolean backupStorageInfoList: description: Backup's storage info to restore items: $ref: '#/components/schemas/BackupStorageInfo_2' type: array category: description: Category of the backup enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/components/schemas/CommunicationPorts_2' creatingUser: $ref: '#/components/schemas/Users_2' customerUUID: description: Customer UUID format: uuid type: string deviceInfo: $ref: '#/components/schemas/DeviceInfo_2' disableChecksum: description: Disable checksum type: boolean disableMultipart: description: Disable multipart upload type: boolean enableVerboseLogs: description: Is verbose logging enabled type: boolean enableYbc: type: boolean encryptionAtRestConfig: $ref: '#/components/schemas/EncryptionAtRestConfig_2' errorString: description: Error message type: string expectedUniverseVersion: description: Expected universe version format: int32 type: integer extraDependencies: $ref: '#/components/schemas/ExtraDependencies_2' installYbc: type: boolean kmsConfigUUID: description: KMS configuration UUID format: uuid type: string nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails_2' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string nodeIp: description: Node IP type: string parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer platformUrl: type: string platformVersion: readOnly: true type: string prefixUUID: description: Prefix UUID format: uuid type: string previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string restoreTimeStamp: description: Restore TimeStamp type: string restoreToPointInTimeMillis: description: Restore timestamp in millis format: int64 type: integer runOnlyPrechecks: description: YbaApi Internal. Run only prechecks during task run type: boolean sleepAfterMasterRestartMillis: format: int32 type: integer sleepAfterTServerRestartMillis: format: int32 type: integer sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array storageConfigUUID: description: Storage config uuid format: uuid type: string targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array universeUUID: description: Universe UUID format: uuid type: string useTablespaces: description: Is tablespaces information included type: boolean ybPrevSoftwareVersion: description: Previous software version type: string ybcInstalled: type: boolean ybcSoftwareVersion: type: string required: - creatingUser - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis - universeUUID type: object KeyspaceTables_2: example: keyspace: keyspace tableNames: - tableNames - tableNames properties: keyspace: description: Keyspace type: string tableNames: description: Tables items: type: string type: array uniqueItems: true type: object CommonBackupInfo_2: 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 baseBackupUUID: format: uuid type: string 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 responseList: items: $ref: '#/components/schemas/KeyspaceTablesList_2' type: array uniqueItems: true sse: type: boolean state: enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopping - Stopped - QueuedForDeletion - QueuedForForcedDeletion - DeleteInProgress type: string storageConfigUUID: format: uuid type: string tableByTableBackup: type: boolean taskUUID: format: uuid type: string totalBackupSizeInBytes: format: int64 type: integer 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 ThrottleParamValue_2: example: presetValues: minValue: 5 defaultValue: 6 maxValue: 1 currentValue: 0 properties: currentValue: format: int64 type: integer presetValues: $ref: '#/components/schemas/PresetThrottleValues_2' required: - currentValue - presetValues type: object DeleteBackupInfo_2: example: storageConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 backupUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: backupUUID: description: backup UUID format: uuid type: string storageConfigUUID: description: storage config UUID format: uuid type: string required: - backupUUID type: object Schedule_2: 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 cronExpression: description: Cron expression for the schedule type: string failureCount: description: Number of failed backup attempts format: int32 readOnly: true type: integer frequency: description: Frequency of the schedule, in milli seconds format: int64 type: integer frequencyTimeUnit: description: Time unit of frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string incrementBacklogStatus: description: Backlog status of schedule of incremental backups arose due to conflicts readOnly: true type: boolean kubernetesOperatorControlled: type: boolean 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 runningState: description: Running state of the schedule type: boolean scheduleName: description: Name of the schedule readOnly: true type: string scheduleUUID: description: Schedule UUID format: uuid readOnly: true type: string 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 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 useLocalTimezone: description: Whether to use local timezone with cron expression for the schedule type: boolean userEmail: description: User who created the schedule policy readOnly: true type: string required: - kubernetesOperatorControlled type: object responses: BadRequest: description: The request was malformed or contained invalid parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: BadRequestExample: summary: Default BadRequest response x-microcks-default: true value: error: code: OK message: Example message status: 100 NotFound: description: The requested resource was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: NotFoundExample: summary: Default NotFound response x-microcks-default: true value: error: code: OK message: Example message status: 100 Unauthorized: description: The API key is missing, invalid, or expired. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: UnauthorizedExample: summary: Default Unauthorized response x-microcks-default: true value: error: code: OK message: Example message status: 100 parameters: projectId: name: projectId in: path required: true description: The unique identifier of the project within the account. schema: type: string format: uuid example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 clusterId: name: clusterId in: path required: true description: The unique identifier of the cluster. schema: type: string format: uuid example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 accountId: name: accountId in: path required: true description: The unique identifier of the YugabyteDB Aeon account. schema: type: string format: uuid example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 securitySchemes: bearerAuth: type: http scheme: bearer description: API key obtained from the YugabyteDB Aeon UI under User Profile > API Keys. Pass the key as a Bearer token in the Authorization header. definitions: NodeDetails: description: Details of a cloud node properties: azUuid: description: The availability zone's UUID format: uuid type: string cloudInfo: $ref: '#/definitions/CloudSpecificInfo' description: Node information, as reported by the cloud provider cronsActive: description: True if cron jobs were properly configured for this node type: boolean disksAreMountedByUUID: description: Disks are mounted by uuid type: boolean isMaster: description: True if this node is a master type: boolean isRedisServer: description: True if this node is a REDIS server type: boolean isTserver: description: True if this node is a Tablet server type: boolean isYqlServer: description: True if this node is a YCQL server type: boolean isYsqlServer: description: True if this node is a YSQL server type: boolean machineImage: description: Machine image name type: string masterHttpPort: description: Master HTTP port format: int32 type: integer masterRpcPort: description: Master RCP port format: int32 type: integer masterState: description: Master state enum: - None - ToStart - Configured - ToStop example: ToStart type: string nodeExporterPort: description: Node exporter port format: int32 type: integer nodeIdx: description: Node ID format: int32 type: integer nodeName: description: Node name type: string nodeUuid: description: Node UUID format: uuid type: string placementUuid: description: UUID of the cluster to which this node belongs format: uuid type: string redisServerHttpPort: description: REDIS HTTP port format: int32 type: integer redisServerRpcPort: description: REDIS RPC port format: int32 type: integer state: description: Node state enum: - ToBeAdded - InstanceCreated - ServerSetup - ToJoinCluster - Reprovisioning - Provisioned - SoftwareInstalled - UpgradeSoftware - UpdateGFlags - Live - Stopping - Starting - Stopped - Unreachable - ToBeRemoved - Removing - Removed - Adding - BeingDecommissioned - Decommissioned - UpdateCert - ToggleTls - Resizing - SystemdUpgrade - Terminating - Terminated example: Provisioned type: string tserverHttpPort: description: Tablet server HTTP port format: int32 type: integer tserverRpcPort: description: Tablet server RPC port format: int32 type: integer ybPrebuiltAmi: description: True if this a custom YB AMI type: boolean yqlServerHttpPort: description: YCQL HTTP port format: int32 type: integer yqlServerRpcPort: description: YCQL RPC port format: int32 type: integer ysqlServerHttpPort: description: YSQL HTTP port format: int32 type: integer ysqlServerRpcPort: description: YSQL RPC port format: int32 type: integer type: object EditBackupParams: description: Edit backup parameters properties: expiryTimeUnit: description: Time unit for backup expiry enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string storageConfigUUID: description: New backup Storage config format: uuid type: string timeBeforeDeleteFromPresentInMillis: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer type: object KeyspaceTablesList: properties: backupSizeInBytes: format: int64 type: integer defaultLocation: type: string keyspace: type: string perRegionLocations: items: $ref: '#/definitions/RegionLocations' type: array tableUUIDList: items: format: uuid type: string type: array uniqueItems: true tablesList: items: type: string type: array uniqueItems: true required: - backupSizeInBytes - defaultLocation - keyspace - perRegionLocations - tableUUIDList - tablesList type: object BackupApiFilter: properties: dateRangeEnd: format: date-time type: string dateRangeStart: format: date-time type: string keyspaceList: items: type: string type: array uniqueItems: true onlyShowDeletedConfigs: type: boolean onlyShowDeletedUniverses: type: boolean scheduleUUIDList: items: format: uuid type: string type: array uniqueItems: true states: items: enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopped - DeleteInProgress - QueuedForDeletion type: string type: array uniqueItems: true storageConfigUUIDList: items: format: uuid type: string type: array uniqueItems: true universeNameList: items: type: string type: array uniqueItems: true universeUUIDList: items: format: uuid type: string type: array uniqueItems: true required: - dateRangeEnd - dateRangeStart - keyspaceList - onlyShowDeletedConfigs - onlyShowDeletedUniverses - scheduleUUIDList - states - storageConfigUUIDList - universeNameList - universeUUIDList type: object BackupTableParams: description: Backup table parameters properties: actionType: description: Action type enum: - CREATE - RESTORE - RESTORE_KEYS - DELETE type: string alterLoadBalancer: description: Alter load balancer state type: boolean backupList: description: Backups items: $ref: '#/definitions/BackupTableParams' type: array backupSizeInBytes: description: Backup size in bytes format: int64 type: integer backupType: description: Backup type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string backupUuid: description: Backup UUID format: uuid type: string cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/definitions/CommunicationPorts' description: Communication ports cronExpression: description: Cron expression for a recurring backup type: string customerUuid: description: Customer UUID format: uuid type: string deviceInfo: $ref: '#/definitions/DeviceInfo' description: Device information disableChecksum: description: Disable checksum type: boolean enableVerboseLogs: description: Is verbose logging enabled type: boolean encryptionAtRestConfig: $ref: '#/definitions/EncryptionAtRestConfig' description: Encryption at rest configation errorString: description: Error message type: string expectedUniverseVersion: description: Expected universe version format: int32 type: integer expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string extraDependencies: $ref: '#/definitions/ExtraDependencies' description: Extra dependencies firstTry: description: Whether this task has been tried before type: boolean ignoreErrors: description: Should table backup errors be ignored type: boolean isFullBackup: description: Full Table type backup type: boolean keyspace: description: Key space type: string kmsConfigUUID: description: KMS configuration UUID format: uuid type: string minNumBackupsToRetain: description: Minimum number of backups to retain for a particular backup schedule format: int32 type: integer newOwner: description: User name of the new tables owner type: string nodeDetailsSet: description: Node details items: $ref: '#/definitions/NodeDetails' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string oldOwner: description: User name of the current tables owner type: string parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer previousTaskUUID: description: Previous task UUID only if this task is a retry format: uuid type: string regionLocations: description: Per region locations items: $ref: '#/definitions/RegionLocations' type: array restoreTimeStamp: description: Restore TimeStamp type: string scheduleUUID: description: Schedule UUID format: uuid type: string schedulingFrequency: description: Frequency to run the backup, in milliseconds format: int64 type: integer sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array sse: description: Is SSE type: boolean storageConfigType: description: Type of backup storage config enum: - S3 - NFS - AZ - GCS - FILE type: string storageConfigUUID: description: Storage configuration UUID format: uuid type: string storageLocation: description: Storage location type: string tableName: description: Table name type: string tableNameList: description: Tables items: type: string type: array tableUUID: description: Table UUID format: uuid type: string tableUUIDList: description: Table UUIDs items: format: uuid type: string type: array targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer transactionalBackup: description: Is backup transactional across tables type: boolean universeUUID: description: Associated universe UUID format: uuid type: string useTablespaces: description: Is tablespaces information included type: boolean ybPrevSoftwareVersion: description: Previous software version type: string required: - storageConfigUUID type: object CloudSpecificInfo: description: Node information reported by the cloud provider properties: assignPublicIP: description: True if the node has a public IP address assigned type: boolean az: description: The node's availability zone type: string cloud: description: The node's cloud provider type: string instance_type: description: The node's instance type type: string mount_roots: description: Mount roots type: string private_dns: description: The node's private DNS type: string private_ip: description: The node's private IP address type: string public_dns: description: The node's public DNS name type: string public_ip: description: The node's public IP address type: string region: description: The node's region type: string secondary_private_ip: description: Secondary Private IP type: string secondary_subnet_id: description: Secondary Subnet IP type: string subnet_id: description: ID of the subnet on which this node is deployed type: string useTimeSync: description: True if `use time sync` is enabled type: boolean type: object Backup: description: 'A single backup. Includes the backup''s status, expiration time, and configuration. Changes from upstream: PLAT-2132: time data types are changed from string to integer' properties: backupInfo: $ref: '#/definitions/BackupTableParams' description: Details of the backup backupUUID: description: Backup UUID format: uuid readOnly: true type: string category: description: Category of the backup enum: - YB_BACKUP_SCRIPT - YB_CONTROLLER type: string completionTime: description: 'Backup completion time. Changes from upstream: Format of a date-time field needs to match https://www.rfc-editor.org/rfc/rfc3339#section-5.6, so unix timestamps don''t conform' format: int64 type: integer createTime: description: 'Changes from upstream: Format of a date-time field needs to match https://www.rfc-editor.org/rfc/rfc3339#section-5.6, so unix timestamps don''t conform' format: int64 type: integer customerUUID: description: Customer UUID that owns this backup format: uuid type: string expiry: description: 'Expiry time (unix timestamp) of the backup. Changes from upstream: Format of a date-time field needs to match https://www.rfc-editor.org/rfc/rfc3339#section-5.6, so unix timestamps don''t conform' format: int64 type: integer expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string scheduleUUID: description: Schedule UUID, if this backup is part of a schedule format: uuid type: string state: description: State of the backup enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopped - DeleteInProgress - QueuedForDeletion example: DELETED readOnly: true type: string storageConfigUUID: description: Storage Config UUID that created this backup format: uuid type: string taskUUID: description: Backup UUID format: uuid readOnly: true type: string universeName: description: Universe name that created this backup type: string universeUUID: description: Universe UUID that created this backup format: uuid type: string updateTime: description: 'Changes from upstream: Format of a date-time field needs to match https://www.rfc-editor.org/rfc/rfc3339#section-5.6, so unix timestamps don''t conform' format: int64 type: integer version: description: Version of the backup in a category enum: - V1 - V2 type: string required: - createTime - updateTime type: object DeviceInfo: description: Device information properties: diskIops: description: Desired IOPS for the volumes mounted on this instance format: int32 type: integer mountPoints: description: Comma-separated list of mount points for the devices in each instance type: string numVolumes: description: Number of volumes to be mounted on this instance at the default path format: int32 type: integer storageClass: description: Name of the storage class type: string storageType: description: Storage type used for this instance enum: - IO1 - GP2 - GP3 - Scratch - Persistent - StandardSSD_LRS - Premium_LRS - UltraSSD_LRS type: string throughput: description: Desired throughput for the volumes mounted on this instance format: int32 type: integer volumeSize: description: The size of each volume in each instance format: int32 type: integer type: object RegionLocations: properties: LOCATION: type: string REGION: type: string required: - LOCATION - REGION type: object BackupStorageInfo: description: Backup Storage Info for doing restore operation properties: backupType: description: Backup type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string keyspace: description: Keyspace name type: string sse: description: Is SSE type: boolean storageLocation: description: Storage location type: string tableNameList: description: Tables items: type: string type: array type: object BackupResp: properties: backupType: enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string backupUUID: format: uuid type: string completionTime: format: date-time type: string createTime: format: date-time type: string customerUUID: format: uuid type: string expiryTime: format: date-time type: string isFullBackup: type: boolean isStorageConfigPresent: type: boolean isUniversePresent: type: boolean kmsConfigUUID: format: uuid type: string onDemand: type: boolean responseList: items: $ref: '#/definitions/KeyspaceTablesList' type: array uniqueItems: true scheduleUUID: format: uuid type: string sse: type: boolean state: enum: - InProgress - Completed - Failed - Deleted - Skipped - FailedToDelete - Stopped - DeleteInProgress - QueuedForDeletion type: string storageConfigType: enum: - S3 - NFS - AZ - GCS - FILE type: string storageConfigUUID: format: uuid type: string taskUUID: format: uuid type: string totalBackupSizeInBytes: format: int64 type: integer universeName: type: string universeUUID: format: uuid type: string updateTime: format: date-time type: string required: - backupType - backupUUID - completionTime - createTime - customerUUID - expiryTime - isFullBackup - isStorageConfigPresent - isUniversePresent - kmsConfigUUID - onDemand - responseList - scheduleUUID - sse - state - storageConfigType - storageConfigUUID - taskUUID - totalBackupSizeInBytes - universeName - universeUUID - updateTime type: object Schedule: description: Backup schedule properties: cronExpression: description: Cron expression for the schedule type: string customerUUID: description: Customer UUID format: uuid readOnly: true type: string failureCount: description: Number of failed backup attempts format: int32 readOnly: true type: integer frequency: description: Frequency of the schedule, in milli seconds format: int64 type: integer frequencyTimeUnit: description: Time unit of frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string runningState: description: Running state of the schedule type: boolean scheduleName: description: Name of the schedule readOnly: true type: string scheduleUUID: description: Schedule UUID format: uuid readOnly: true type: string status: description: Status of the task. Possible values are _Active_, _Paused_, or _Stopped_. enum: - Active - Paused - Stopped readOnly: true type: string taskType: description: Type of task to be scheduled. enum: - CloudBootstrap - CloudCleanup - CreateCassandraTable - CreateUniverse - ReadOnlyClusterCreate - ReadOnlyClusterDelete - CreateKubernetesUniverse - DestroyUniverse - PauseUniverse - ResumeUniverse - DestroyKubernetesUniverse - DeleteTable - BackupUniverse - RestoreBackup - MultiTableBackup - CreateBackup - EditUniverse - EditKubernetesUniverse - ExternalScript - KubernetesProvision - ImportIntoTable - UpgradeUniverse - RestartUniverse - SoftwareUpgrade - SoftwareKubernetesUpgrade - GFlagsUpgrade - GFlagsKubernetesUpgrade - CertsRotate - CertsRotateKubernetesUpgrade - TlsToggle - VMImageUpgrade - SystemdUpgrade - CreateRootVolumes - ReplaceRootVolume - ChangeInstanceType - PersistResizeNode - PersistSystemdUpgrade - UpdateNodeDetails - UpgradeKubernetesUniverse - DeleteNodeFromUniverse - StopNodeInUniverse - StartNodeInUniverse - AddNodeToUniverse - RemoveNodeFromUniverse - ReleaseInstanceFromUniverse - SetUniverseKey - SetKubernetesUniverseKey - CreateKMSConfig - EditKMSConfig - DeleteKMSConfig - UpdateDiskSize - StartMasterOnNode - CreateXClusterConfig - EditXClusterConfig - DeleteXClusterConfig - SyncXClusterConfig - CreateSupportBundle - AnsibleClusterServerCtl - AnsibleConfigureServers - AnsibleDestroyServer - PauseServer - ResumeServer - AnsibleSetupServer - AnsibleCreateServer - PrecheckNode - PrecheckNodeDetached - AnsibleUpdateNodeInfo - BulkImport - ChangeMasterConfig - ChangeAdminPassword - CreateTable - DeleteNode - DeleteBackup - DeleteBackupYb - DeleteCustomerConfig - DeleteCustomerStorageConfig - UpdateNodeProcess - DeleteTableFromUniverse - LoadBalancerStateChange - ModifyBlackList - ManipulateDnsRecordTask - RemoveUniverseEntry - SetFlagInMemory - SetNodeState - SwamperTargetsFileUpdate - UniverseUpdateSucceeded - UpdateAndPersistGFlags - UpdatePlacementInfo - UpdateSoftwareVersion - WaitForDataMove - WaitForLeaderBlacklistCompletion - WaitForFollowerLag - WaitForLoadBalance - WaitForMasterLeader - WaitForServer - WaitForTServerHeartBeats - DeleteClusterFromUniverse - InstanceActions - WaitForServerReady - RunExternalScript - XClusterConfigSetup - XClusterConfigSetStatus - XClusterConfigModifyTables - XClusterConfigRename - XClusterConfigDelete - XClusterConfigSync - XClusterConfigUpdateMasterAddresses - CloudAccessKeyCleanup - CloudAccessKeySetup - CloudInitializer - CloudProviderCleanup - CloudRegionCleanup - CloudRegionSetup - CloudSetup - BackupTable - BackupTableYb - BackupUniverseKeys - RestoreBackupYb - RestoreUniverseKeys - RestoreUniverseKeysYb - WaitForLeadersOnPreferredOnly - EnableEncryptionAtRest - DisableEncryptionAtRest - DestroyEncryptionAtRest - KubernetesCommandExecutor - KubernetesWaitForPod - KubernetesCheckNumPod - SetActiveUniverseKeys - CopyEncryptionKeyFile - WaitForEncryptionKeyInMemory - UnivSetCertificate - CreateAlertDefinitions - ManageAlertDefinitions - UniverseSetTlsParams - UniverseUpdateRootCert - ResetUniverseVersion - DeleteCertificate - SetNodeStatus - CheckMasterLeader - CheckMasters - CheckTServers - WaitForTServerHBs - CreatePrometheusSwamperConfig - PreflightNodeCheck - RunYsqlUpgrade - ResizeNode - CheckMemory - UpdateMountedDisks - TransferXClusterCerts - CreateTableSpacesInUniverse - CreateTableSpaces - ThirdpartySoftwareUpgrade - MarkUniverseForHealthScriptReUpload - UpdateUniverseTags type: string type: object CommunicationPorts: description: Communication ports properties: masterHttpPort: description: Master table HTTP port format: int32 type: integer masterRpcPort: description: Master table RCP port format: int32 type: integer nodeExporterPort: description: Node exporter port format: int32 type: integer redisServerHttpPort: description: Redis HTTP port format: int32 type: integer redisServerRpcPort: description: Redis RPC port format: int32 type: integer tserverHttpPort: description: Tablet server HTTP port format: int32 type: integer tserverRpcPort: description: Tablet server RPC port format: int32 type: integer yqlServerHttpPort: description: YQL HTTP port format: int32 type: integer yqlServerRpcPort: description: YQL RPC port format: int32 type: integer ysqlServerHttpPort: description: YSQL HTTP port format: int32 type: integer ysqlServerRpcPort: description: YSQL RPC port format: int32 type: integer type: object KeyspaceTable: description: Keyspace and table info for backup properties: keyspace: description: keyspace type: string tableNameList: description: Tables items: type: string type: array tableUUIDList: description: Table UUIDs items: format: uuid type: string type: array type: object YBPError: description: Generic error response from the YugabyteDB Anywhere API properties: error: description: User-visible unstructured error message example: There was a problem creating the universe type: string errorJson: description: User visible error message as json object example: '{ "foo" : "bar", "baz" : [1, 2, 3] }' type: object success: description: Always set to false to indicate failure example: false type: boolean type: object MultiTableBackupRequestParams: description: Multi-table backup parameters properties: actionType: description: Action type enum: - CREATE - RESTORE - RESTORE_KEYS - DELETE type: string alterLoadBalancer: description: Alter load balancer state type: boolean backupList: description: Backups items: $ref: '#/definitions/BackupTableParams' type: array backupSizeInBytes: description: Backup size in bytes format: int64 type: integer backupType: description: Backup type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string backupUuid: description: Backup UUID format: uuid type: string cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/definitions/CommunicationPorts' description: Communication ports cronExpression: description: Cron expression for a recurring backup type: string customerUUID: description: 'Customer UUID. Changes From Upstream: Removes duplicate customerUUID field' format: uuid type: string deviceInfo: $ref: '#/definitions/DeviceInfo' description: Device information disableChecksum: description: Disable checksum type: boolean enableVerboseLogs: description: Is verbose logging enabled type: boolean encryptionAtRestConfig: $ref: '#/definitions/EncryptionAtRestConfig' description: Encryption at rest configation errorString: description: Error message type: string expectedUniverseVersion: description: Expected universe version format: int32 type: integer expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string extraDependencies: $ref: '#/definitions/ExtraDependencies' description: Extra dependencies firstTry: description: Whether this task has been tried before type: boolean ignoreErrors: description: Should table backup errors be ignored type: boolean isFullBackup: description: Full Table type backup type: boolean keyspace: description: Key space type: string kmsConfigUUID: description: KMS configuration UUID format: uuid type: string minNumBackupsToRetain: description: Minimum number of backups to retain for a particular backup schedule format: int32 type: integer newOwner: description: User name of the new tables owner type: string nodeDetailsSet: description: Node details items: $ref: '#/definitions/NodeDetails' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string oldOwner: description: User name of the current tables owner type: string parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer previousTaskUUID: description: Previous task UUID only if this task is a retry format: uuid type: string regionLocations: description: Per region locations items: $ref: '#/definitions/RegionLocations' type: array restoreTimeStamp: description: Restore TimeStamp type: string scheduleUUID: description: Schedule UUID format: uuid type: string schedulingFrequency: description: Frequency to run the backup, in milliseconds format: int64 type: integer sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array sse: description: Is SSE type: boolean storageConfigType: description: Type of backup storage config enum: - S3 - NFS - AZ - GCS - FILE type: string storageConfigUUID: description: Storage configuration UUID format: uuid type: string storageLocation: description: Storage location type: string tableName: description: Table name type: string tableNameList: description: Tables items: type: string type: array tableUUID: description: Table UUID format: uuid type: string tableUUIDList: description: Table UUIDs items: format: uuid type: string type: array targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer transactionalBackup: description: Is backup transactional across tables type: boolean universeUUID: description: Associated universe UUID format: uuid type: string useTablespaces: description: Is tablespaces information included type: boolean ybPrevSoftwareVersion: description: Previous software version type: string required: - storageConfigUUID type: object YBPTask: properties: resourceUUID: description: UUID of the resource being modified by the task format: uuid readOnly: true type: string taskUUID: description: Task UUID format: uuid readOnly: true type: string type: object EncryptionAtRestConfig: description: Encryption at rest configuration properties: encryptionAtRestEnabled: description: Whether a universe is currently encrypted at rest type: boolean kmsConfigUUID: description: KMS configuration UUID format: uuid type: string opType: description: 'Operation type: enable, disable, or rotate the universe key/encryption at rest' enum: - ENABLE - DISABLE - UNDEFINED type: string type: description: Whether to generate a data key or just retrieve the CMK ARN enum: - CMK - DATA_KEY type: string type: object BackupPagedApiQuery: properties: direction: enum: - ASC - DESC type: string filter: $ref: '#/definitions/BackupApiFilter' limit: format: int32 type: integer needTotalCount: type: boolean offset: format: int32 type: integer sortBy: enum: - createTime type: string required: - direction - filter - limit - needTotalCount - offset - sortBy type: object ExtraDependencies: description: Extra dependencies properties: installNodeExporter: description: Install node exporter on nodes type: boolean type: object RestoreBackupParams: properties: actionType: description: Action type enum: - RESTORE - RESTORE_KEYS type: string alterLoadBalancer: description: Alter load balancer state type: boolean backupStorageInfoList: description: Backup's storage info to restore items: $ref: '#/definitions/BackupStorageInfo' type: array cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/definitions/CommunicationPorts' description: Communication ports customerUUID: description: Customer UUID format: uuid type: string deviceInfo: $ref: '#/definitions/DeviceInfo' description: Device information disableChecksum: description: Disable checksum type: boolean enableVerboseLogs: description: Is verbose logging enabled type: boolean encryptionAtRestConfig: $ref: '#/definitions/EncryptionAtRestConfig' description: Encryption at rest configation errorString: description: Error message type: string expectedUniverseVersion: description: Expected universe version format: int32 type: integer extraDependencies: $ref: '#/definitions/ExtraDependencies' description: Extra dependencies firstTry: description: Whether this task has been tried before type: boolean kmsConfigUUID: description: KMS configuration UUID format: uuid type: string newOwner: description: User name of the new tables owner type: string nodeDetailsSet: description: Node details items: $ref: '#/definitions/NodeDetails' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string oldOwner: description: User name of the current tables owner type: string parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer previousTaskUUID: description: Previous task UUID only if this task is a retry format: uuid type: string restoreTimeStamp: description: Restore TimeStamp type: string sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array storageConfigUUID: description: Storage config uuid format: uuid type: string targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array universeUUID: description: Universe UUID format: uuid type: string useTablespaces: description: Is tablespaces information included type: boolean ybPrevSoftwareVersion: description: Previous software version type: string required: - universeUUID type: object YBPSuccess: properties: message: description: API response message. readOnly: true type: string success: description: API operation status. A value of true indicates the operation was successful. readOnly: true type: boolean type: object BackupPagedApiResponse: properties: entities: items: $ref: '#/definitions/BackupResp' type: array hasNext: type: boolean hasPrev: type: boolean totalCount: format: int32 type: integer required: - entities - hasNext - hasPrev - totalCount type: object YBPTasks: type: object BackupRequestParams: description: Backup table parameters properties: alterLoadBalancer: description: Alter load balancer state type: boolean backupType: description: Backup type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/definitions/CommunicationPorts' description: Communication ports cronExpression: description: Cron expression for a recurring backup type: string customerUUID: description: Customer UUID format: uuid type: string deviceInfo: $ref: '#/definitions/DeviceInfo' description: Device information disableChecksum: description: Disable checksum type: boolean enableVerboseLogs: description: Is verbose logging enabled type: boolean encryptionAtRestConfig: $ref: '#/definitions/EncryptionAtRestConfig' description: Encryption at rest configation errorString: description: Error message type: string expectedUniverseVersion: description: Expected universe version format: int32 type: integer expiryTimeUnit: description: Time unit for backup expiry time enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string extraDependencies: $ref: '#/definitions/ExtraDependencies' description: Extra dependencies firstTry: description: Whether this task has been tried before type: boolean frequencyTimeUnit: description: Time unit for user input schedule frequency enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS - MONTHS - YEARS type: string ignoreErrors: description: Should table backup errors be ignored type: boolean keyspaceTableList: description: Backup info items: $ref: '#/definitions/KeyspaceTable' type: array kmsConfigUUID: description: KMS configuration UUID format: uuid type: string minNumBackupsToRetain: description: Minimum number of backups to retain for a particular backup schedule format: int32 type: integer nodeDetailsSet: description: Node details items: $ref: '#/definitions/NodeDetails' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string parallelism: description: Number of concurrent commands to run on nodes over SSH format: int32 type: integer previousTaskUUID: description: Previous task UUID only if this task is a retry format: uuid type: string scheduleName: description: Schedule Name type: string scheduleUUID: description: Schedule UUID format: uuid type: string schedulingFrequency: description: Frequency to run the backup, in milliseconds format: int64 type: integer sourceXClusterConfigs: description: The source universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array sse: description: Is SSE type: boolean storageConfigUUID: description: Storage configuration UUID format: uuid type: string targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array timeBeforeDelete: description: Time before deleting the backup from storage, in milliseconds format: int64 type: integer universeUUID: description: Universe UUID format: uuid type: string useTablespaces: description: Is tablespaces information included type: boolean ybPrevSoftwareVersion: description: Previous software version type: string required: - storageConfigUUID - universeUUID type: object externalDocs: description: YugabyteDB Aeon REST API Documentation url: https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/