openapi: 3.1.0 info: title: YugabyteDB Aeon REST Access Keys PITR management 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: PITR management paths: /api/v1/customers/{cUUID}/universes/{uniUUID}/clone: post: description: YbaApi Internal. operationId: cloneNamespace 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/CloneNamespaceParams' examples: CloneNamespaceRequestExample: summary: Default cloneNamespace request x-microcks-default: true value: expectedUniverseVersion: 6 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK cloneTimeInMillis: 0 targetKeyspaceName: targetKeyspaceName 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 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl pitrConfigUUID: 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 errorString: errorString 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 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 1 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: perform clone via PITR required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: CloneNamespace200Example: summary: Default cloneNamespace 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 Clone Namespace via PITR on a Universe tags: - PITR management x-codegen-request-body-name: namespaceClone x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/keyspaces/{tableType}/{keyspaceName}/pitr_config: post: operationId: createPitrConfig 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: tableType required: true schema: type: string example: DEFAULT - in: path name: keyspaceName required: true schema: type: string example: example-keyspaceName - in: query name: request schema: {} example: example-request requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePitrConfigParams' examples: CreatePitrConfigRequestExample: summary: Default createPitrConfig request x-microcks-default: true value: expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK 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 intervalInSeconds: 6 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl 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 errorString: errorString retentionPeriodInSeconds: 1 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 ybcInstalled: true name: name 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 5 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: post pitr config required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: CreatePitrConfig200Example: summary: Default createPitrConfig 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 Pitr Config for a Keyspace in a Universe tags: - PITR management x-codegen-request-body-name: pitrConfig x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr: post: operationId: performPitr 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/RestoreSnapshotScheduleParams' examples: PerformPitrRequestExample: summary: Default performPitr request x-microcks-default: true value: expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK 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 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl pitrConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 restoreTimeInMillis: 6 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 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString 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 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 1 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: perform PITR required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: PerformPitr200Example: summary: Default performPitr 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 Perform PITR on a Universe tags: - PITR management x-codegen-request-body-name: performPitr x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config: get: operationId: ListOfPitrConfigs 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/PitrConfig' type: array examples: ListOfPitrConfigs200Example: summary: Default ListOfPitrConfigs 200 response x-microcks-default: true value: - dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere List the PITR Configs of a Universe tags: - PITR management x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/v1/customers/{cUUID}/universes/{uniUUID}/pitr_config/{pUUID}: delete: operationId: deletePitrConfig 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: pUUID required: true schema: format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - in: query name: request schema: {} example: example-request responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: DeletePitrConfig200Example: summary: Default deletePitrConfig 200 response x-microcks-default: true value: taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: successful operation security: - apiKeyAuth: [] summary: YugabyteDB Anywhere Delete Pitr Config on a Universe tags: - PITR management x-microcks-operation: delay: 0 dispatcher: FALLBACK put: description: 'WARNING: This is a preview API that could change.' operationId: updatePitrConfig 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: pUUID 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/UpdatePitrConfigParams' examples: UpdatePitrConfigRequestExample: summary: Default updatePitrConfig request x-microcks-default: true value: expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK 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 intervalInSeconds: 6 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl 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 errorString: errorString retentionPeriodInSeconds: 1 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 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 5 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 description: put pitr config required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/YBPTask' examples: UpdatePitrConfig200Example: summary: Default updatePitrConfig 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 Update Pitr Config for a Keyspace in a Universe tags: - PITR management x-codegen-request-body-name: pitrConfig x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: 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 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 CloneNamespaceParams: description: Clone Namespace parameters example: expectedUniverseVersion: 6 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK cloneTimeInMillis: 0 targetKeyspaceName: targetKeyspaceName 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 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl pitrConfigUUID: 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 errorString: errorString 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 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 1 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: cloneTimeInMillis: description: Time in millis at which to clone the source namespace. If not specifed, it is cloned to current state. format: int64 type: integer example: 1000 cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string example: example-cmkArn communicationPorts: $ref: '#/components/schemas/CommunicationPorts' creatingUser: $ref: '#/components/schemas/Users' deviceInfo: $ref: '#/components/schemas/DeviceInfo' 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 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' pitrConfigUUID: description: PITR Config UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 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 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 targetKeyspaceName: description: Clone namespace name type: string example: example-targetKeyspaceName targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 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 type: object UpdatePitrConfigParams: description: Update PITR config parameters example: expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK 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 intervalInSeconds: 6 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl 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 errorString: errorString retentionPeriodInSeconds: 1 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 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 5 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string example: example-cmkArn communicationPorts: $ref: '#/components/schemas/CommunicationPorts' creatingUser: $ref: '#/components/schemas/Users' deviceInfo: $ref: '#/components/schemas/DeviceInfo' 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 intervalInSeconds: description: Time interval between snapshots format: int64 type: integer example: 1000 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' 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 retentionPeriodInSeconds: description: Retention period of a snapshot 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 targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 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 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 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 ExtraDependencies: description: Extra dependencies example: installNodeExporter: true properties: installNodeExporter: description: Install node exporter on nodes type: boolean example: true type: object PitrConfig: description: PITR config created on the universe example: dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 properties: createTime: description: Create time of the PITR config example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string createdForDr: description: Created for DR readOnly: true type: boolean example: true customerUUID: description: Customer UUID of this config format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 dbName: description: DB Name type: string example: example-dbName disabled: description: Whether the PITR config is disabled readOnly: true type: boolean example: true intermittentMinRecoverTimeInMillis: description: Intermittent min recovery time in millis if retention period is increased format: int64 type: integer example: 1000 maxRecoverTimeInMillis: format: int64 type: integer example: 10 minRecoverTimeInMillis: format: int64 type: integer example: 1000 name: description: PITR config name type: string example: example-name retentionPeriod: description: Retention Period in seconds format: int64 type: integer example: 1000 scheduleInterval: description: Interval between snasphots in seconds format: int64 type: integer example: 1000 state: enum: - UNKNOWN - CREATING - COMPLETE - DELETING - DELETED - FAILED - CANCELLED - RESTORING - RESTORED type: string example: UNKNOWN tableType: description: Table Type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string example: YQL_TABLE_TYPE updateTime: description: Update time of the PITR con example: 2022-12-12 13:07:18+00:00 format: date-time type: string usedForXCluster: readOnly: true type: boolean example: true uuid: description: PITR config UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 required: - maxRecoverTimeInMillis - minRecoverTimeInMillis - state type: object CreatePitrConfigParams: description: Create PITR config parameters example: expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK 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 intervalInSeconds: 6 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl 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 errorString: errorString retentionPeriodInSeconds: 1 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 ybcInstalled: true name: name 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 5 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string example: example-cmkArn communicationPorts: $ref: '#/components/schemas/CommunicationPorts' creatingUser: $ref: '#/components/schemas/Users' deviceInfo: $ref: '#/components/schemas/DeviceInfo' 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 intervalInSeconds: description: Time interval between snapshots format: int64 type: integer example: 1000 name: description: PITR config name type: string example: example-name 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' 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 retentionPeriodInSeconds: description: Retention period of a snapshot 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 targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array example: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 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 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 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 RestoreSnapshotScheduleParams: description: Restore snapshot schedule parameters example: expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK 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 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl pitrConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 restoreTimeInMillis: 6 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 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString 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 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 1 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string example: example-cmkArn communicationPorts: $ref: '#/components/schemas/CommunicationPorts' creatingUser: $ref: '#/components/schemas/Users' deviceInfo: $ref: '#/components/schemas/DeviceInfo' 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 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' pitrConfigUUID: description: PITR Config UUID format: uuid type: string example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 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 restoreTimeInMillis: description: Restore Time 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 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 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 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 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 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 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 CloneNamespaceParams_2: description: Clone Namespace parameters example: expectedUniverseVersion: 6 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK cloneTimeInMillis: 0 targetKeyspaceName: targetKeyspaceName 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 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl pitrConfigUUID: 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 errorString: errorString 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 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 1 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: cloneTimeInMillis: description: Time in millis at which to clone the source namespace. If not specifed, it is cloned to current state. format: int64 type: integer cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/components/schemas/CommunicationPorts_2' creatingUser: $ref: '#/components/schemas/Users_2' deviceInfo: $ref: '#/components/schemas/DeviceInfo_2' 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 nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails_2' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string pitrConfigUUID: description: PITR Config UUID format: uuid type: string 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 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 targetKeyspaceName: description: Clone namespace name type: string targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array ybPrevSoftwareVersion: description: Previous software version type: string ybcInstalled: type: boolean ybcSoftwareVersion: type: string required: - creatingUser - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis type: object UpdatePitrConfigParams_2: description: Update PITR config parameters example: expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK 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 intervalInSeconds: 6 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl 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 errorString: errorString retentionPeriodInSeconds: 1 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 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 5 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/components/schemas/CommunicationPorts_2' creatingUser: $ref: '#/components/schemas/Users_2' deviceInfo: $ref: '#/components/schemas/DeviceInfo_2' 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 intervalInSeconds: description: Time interval between snapshots format: int64 type: integer nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails_2' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string platformUrl: type: string platformVersion: readOnly: true type: string previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string retentionPeriodInSeconds: description: Retention period of a snapshot 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 targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array ybPrevSoftwareVersion: description: Previous software version type: string ybcInstalled: type: boolean ybcSoftwareVersion: type: string required: - creatingUser - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis 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 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 ExtraDependencies_2: description: Extra dependencies example: installNodeExporter: true properties: installNodeExporter: description: Install node exporter on nodes type: boolean type: object PitrConfig_2: description: PITR config created on the universe example: dbName: dbName updateTime: 2022-12-12 13:07:18+00:00 createdForDr: true uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 minRecoverTimeInMillis: 1 scheduleInterval: 5 tableType: YQL_TABLE_TYPE customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 createTime: 2022-12-12 13:07:18+00:00 intermittentMinRecoverTimeInMillis: 0 maxRecoverTimeInMillis: 6 name: name disabled: true usedForXCluster: true state: UNKNOWN retentionPeriod: 5 properties: createTime: description: Create time of the PITR config example: 2022-12-12 13:07:18+00:00 format: date-time readOnly: true type: string createdForDr: description: Created for DR readOnly: true type: boolean customerUUID: description: Customer UUID of this config format: uuid type: string dbName: description: DB Name type: string disabled: description: Whether the PITR config is disabled readOnly: true type: boolean intermittentMinRecoverTimeInMillis: description: Intermittent min recovery time in millis if retention period is increased format: int64 type: integer maxRecoverTimeInMillis: format: int64 type: integer minRecoverTimeInMillis: format: int64 type: integer name: description: PITR config name type: string retentionPeriod: description: Retention Period in seconds format: int64 type: integer scheduleInterval: description: Interval between snasphots in seconds format: int64 type: integer state: enum: - UNKNOWN - CREATING - COMPLETE - DELETING - DELETED - FAILED - CANCELLED - RESTORING - RESTORED type: string tableType: description: Table Type enum: - YQL_TABLE_TYPE - REDIS_TABLE_TYPE - PGSQL_TABLE_TYPE - TRANSACTION_STATUS_TABLE_TYPE type: string updateTime: description: Update time of the PITR con example: 2022-12-12 13:07:18+00:00 format: date-time type: string usedForXCluster: readOnly: true type: boolean uuid: description: PITR config UUID format: uuid type: string required: - maxRecoverTimeInMillis - minRecoverTimeInMillis - state type: object CreatePitrConfigParams_2: description: Create PITR config parameters example: expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK 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 intervalInSeconds: 6 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl 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 errorString: errorString retentionPeriodInSeconds: 1 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 ybcInstalled: true name: name 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 5 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/components/schemas/CommunicationPorts_2' creatingUser: $ref: '#/components/schemas/Users_2' deviceInfo: $ref: '#/components/schemas/DeviceInfo_2' 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 intervalInSeconds: description: Time interval between snapshots format: int64 type: integer name: description: PITR config name type: string nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails_2' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string platformUrl: type: string platformVersion: readOnly: true type: string previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string retentionPeriodInSeconds: description: Retention period of a snapshot 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 targetXClusterConfigs: description: The target universe's xcluster replication relationships items: format: uuid type: string readOnly: true type: array ybPrevSoftwareVersion: description: Previous software version type: string ybcInstalled: type: boolean ybcSoftwareVersion: type: string required: - creatingUser - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis 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 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 RestoreSnapshotScheduleParams_2: description: Restore snapshot schedule parameters example: expectedUniverseVersion: 0 sourceXClusterConfigs: - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - 046b6c7f-0b8a-43b9-b35d-6489e6daee91 nodeExporterUser: nodeExporterUser encryptionAtRestConfig: encryptionAtRestEnabled: true opType: ENABLE kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: CMK 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 sleepAfterTServerRestartMillis: 5 runOnlyPrechecks: true platformUrl: platformUrl pitrConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 restoreTimeInMillis: 6 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 universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 errorString: errorString 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 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 cmkArn: cmkArn sleepAfterMasterRestartMillis: 1 previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: cmkArn: description: Amazon Resource Name (ARN) of the CMK type: string communicationPorts: $ref: '#/components/schemas/CommunicationPorts_2' creatingUser: $ref: '#/components/schemas/Users_2' deviceInfo: $ref: '#/components/schemas/DeviceInfo_2' 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 nodeDetailsSet: description: Node details items: $ref: '#/components/schemas/NodeDetails_2' type: array uniqueItems: true nodeExporterUser: description: Node exporter user type: string pitrConfigUUID: description: PITR Config UUID format: uuid type: string platformUrl: type: string platformVersion: readOnly: true type: string previousTaskUUID: description: Previous task UUID of a retry format: uuid type: string restoreTimeInMillis: description: Restore Time 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 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 ybPrevSoftwareVersion: description: Previous software version type: string ybcInstalled: type: boolean ybcSoftwareVersion: type: string required: - creatingUser - platformUrl - sleepAfterMasterRestartMillis - sleepAfterTServerRestartMillis 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 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 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. externalDocs: description: YugabyteDB Aeon REST API Documentation url: https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/