openapi: 3.0.0 info: title: Delphix DCT Algorithms HyperscaleInstance API version: 3.28.0 description: Delphix DCT API contact: name: Delphix Support url: https://portal.perforce.com/s/ email: support@delphix.com servers: - url: /dct/v3 security: - ApiKeyAuth: [] tags: - name: HyperscaleInstance paths: /hyperscale-instances: post: tags: - HyperscaleInstance summary: Register a Hyperscale instance operationId: register_hyperscale_instance parameters: - in: query name: validate_instance required: false schema: type: boolean default: false description: If true, validates the registering hyperscale orchestrator and identify dataType. requestBody: content: application/json: schema: x-body-name: hyperscale_instance $ref: '#/components/schemas/HyperscaleInstanceRegistrationParameter' description: The parameters to register a Hyperscale instance. required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/HyperscaleInstance' get: tags: - HyperscaleInstance summary: Returns a list of Hyperscale instances. operationId: get_hyperscale_instances parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/hyperscaleInstancesSortParam' responses: '200': description: OK content: application/json: schema: type: object title: ListHyperscaleInstancesResponse properties: items: type: array items: $ref: '#/components/schemas/HyperscaleInstance' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /hyperscale-instances/search: post: summary: Search for Hyperscale instances. operationId: search_hyperscale_instances tags: - HyperscaleInstance x-filterable: fields: id: type: string name: type: string hostname: type: string creation_date: type: string data_type: type: string insecure_ssl: type: boolean unsafe_ssl_hostname_check: type: boolean status: type: string connection_status: type: string connection_status_details: type: string tags: type: array[object] fields: key: type: string value: type: string parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/hyperscaleInstancesSortParam' requestBody: $ref: '#/components/requestBodies/SearchBody' responses: '200': description: OK content: application/json: schema: type: object title: SearchHyperscaleInstancesResponse properties: items: type: array items: $ref: '#/components/schemas/HyperscaleInstance' response_metadata: $ref: '#/components/schemas/PaginatedResponseMetadata' /hyperscale-instances/{hyperscaleInstanceId}: parameters: - $ref: '#/components/parameters/hyperscaleInstanceId' get: tags: - HyperscaleInstance summary: Returns a Hyperscale Instance by ID. operationId: get_hyperscale_instance_by_id responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/HyperscaleInstance' patch: tags: - HyperscaleInstance summary: Update an Hyperscale Instance operationId: update_hyperscale_instance requestBody: content: application/json: schema: x-body-name: hyperscale_instance_update_params $ref: '#/components/schemas/HyperscaleInstanceUpdateParams' description: Update parameters for a hyperscale instance. required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/HyperscaleInstance' delete: tags: - HyperscaleInstance summary: Unregister a Hyperscale Instance. operationId: unregister_hyperscale_instance responses: '200': description: OK content: application/json: schema: type: object title: UnregisterHyperscaleInstanceResponse properties: job: $ref: '#/components/schemas/Job' description: The initiated job. /hyperscale-instances/{hyperscaleInstanceId}/tags: parameters: - $ref: '#/components/parameters/hyperscaleInstanceId' post: tags: - HyperscaleInstance summary: Create tags for a Hyperscale Instance. operationId: create_hyperscale_instance_tags requestBody: content: application/json: schema: x-body-name: hyperscale_instance_tags $ref: '#/components/schemas/TagsRequest' description: Tags information for Hyperscale Instance. required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/TagsResponse' get: tags: - HyperscaleInstance summary: Get tags for a Hyperscale Instance. operationId: get_hyperscale_instance_tags responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/TagsResponse' /hyperscale-instances/{hyperscaleInstanceId}/tags/delete: parameters: - $ref: '#/components/parameters/hyperscaleInstanceId' post: tags: - HyperscaleInstance summary: Delete tags for a Hyperscale Instance. operationId: delete_hyperscale_instance_tags requestBody: $ref: '#/components/requestBodies/DeleteTags' responses: '204': description: No Content /hyperscale-instances/{hyperscaleInstanceId}/sync-engines: parameters: - $ref: '#/components/parameters/hyperscaleInstanceId' post: tags: - HyperscaleInstance summary: Sync the global object from a source engine to engines on a Hyperscale Instance. operationId: sync_engines_hyperscale_instance requestBody: content: application/json: schema: x-body-name: sync_engines_hyperscale_parameter $ref: '#/components/schemas/SyncEnginesHyperscaleParameters' required: true responses: '200': description: OK content: application/json: schema: type: object title: SyncEnginesHyperscaleResponse properties: job: $ref: '#/components/schemas/Job' /hyperscale-instances/{hyperscaleInstanceId}/add-engine: parameters: - $ref: '#/components/parameters/hyperscaleInstanceId' post: tags: - HyperscaleInstance summary: Add an engine to a Hyperscale Instance. operationId: add_engine_to_hyperscale_instance requestBody: content: application/json: schema: x-body-name: engine_id $ref: '#/components/schemas/EngineIdBody' description: Body containing the ID of the registered engine. required: true responses: '200': description: OK content: application/json: schema: type: object title: AddEngineToHyperscaleResponse properties: job: $ref: '#/components/schemas/Job' /hyperscale-instances/{hyperscaleInstanceId}/remove-engine: parameters: - $ref: '#/components/parameters/hyperscaleInstanceId' post: tags: - HyperscaleInstance summary: Remove an engine from a Hyperscale Instance. operationId: remove_engine_from_hyperscale_instance requestBody: content: application/json: schema: x-body-name: engine_id $ref: '#/components/schemas/EngineIdBody' description: Body containing the ID of the registered engine. required: true responses: '200': description: OK content: application/json: schema: type: object title: RemoveEngineFromHyperscaleResponse properties: job: $ref: '#/components/schemas/Job' /hyperscale-instances/{hyperscaleInstanceId}/move-to-job-orchestrator: parameters: - $ref: '#/components/parameters/hyperscaleInstanceId' put: tags: - HyperscaleInstance summary: Move compliance nodes from a hyperscale orchestrator to a job orchestrator. operationId: move_compliance_nodes_to_job_orchestrator requestBody: content: application/json: schema: x-body-name: move_to_job_orchestrator_request $ref: '#/components/schemas/MoveComplianceNodesToJobOrchestratorRequest' description: The parameters to move compliance nodes to a job orchestrator. required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MoveComplianceNodesResponse' components: schemas: Tag: type: object required: - key - value properties: key: description: Key of the tag type: string minLength: 1 maxLength: 4000 example: key-1 value: description: Value of the tag type: string minLength: 1 maxLength: 4000 example: value-1 HyperscaleInstance: title: HyperscaleInstance type: object description: A registered Hyperscale instance's connection and authentication settings. required: - name - hostname - api_key - job_orchestrator_id properties: id: description: The Hyperscale instance entity ID. type: string readOnly: true name: description: The name of this hyperscale instance. type: string hostname: description: The hostname of this hyperscale instance. type: string data_type: $ref: '#/components/schemas/HyperscaleDataTypeEnum' creation_date: description: The date this hyperscale instance was registered. type: string format: date-time tags: description: The tags to be created for this hyperscale instance. type: array items: $ref: '#/components/schemas/Tag' api_key: description: API key to connect to the hyperscale instance. type: string insecure_ssl: description: 'Allow connections to the hyperscale instance over HTTPs without validating the TLS certificate. Even though the connection to the hyperscale instance might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates. ' type: boolean default: false unsafe_ssl_hostname_check: description: 'Ignore validation of the name associated to the TLS certificate when connecting to the hyperscale instance over HTTPs. Setting this value must only be done if the TLS certificate of the hyperscale instance does not match the hostname, and the TLS configuration of the hyperscale instance cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this hyperscale instance. This is ignored if insecure_ssl is set. ' type: boolean default: false status: description: The status of this hyperscale instance. type: string enum: - CREATED - DELETING nullable: true readOnly: true connection_status: description: The status of the connection to the hyperscale instance. type: string enum: - ONLINE - CONNECTION_ERROR - BAD_CREDENTIALS nullable: true readOnly: true connection_status_details: description: If set, details about the status of the connection to the hyperscale instance. type: string readOnly: true job_orchestrator_id: type: string description: The job orchestrator id that is associated with the hyperscale instance. job_orchestrator_name: description: The job orchestrator name associated with the hyperscale instance. type: string node_count: type: integer description: The Number of compliance nodes registered on Hyperscale Instance if instance is dct_managed. auto_calculate_unload_split: type: boolean default: true description: If set, hyperscale will auto calculate the no of splits required for masking job. consider_continuous_compliance_warning_event_as: type: string enum: - SUCCESS - FAILURE default: SUCCESS description: The flag to control behavior of Hyperscale Job execution on warning event in Continuous Compliance Job execution. Default behavior of Hyperscale Job on the WARNING status of Continuous Compliance Job execution, is to consider it as SUCCESS. One example of warning event in Continuous Compliance is masking non conformant data. create_all_indexes_with_nologging: type: boolean default: false description: Add all indexes with NOLOGGING as part of post load. disable_parallel_index_creation: type: boolean default: false description: Exclude indexes from combining with constraint and trigger groups as part of pre load. enable_all_constraints_with_novalidate: type: boolean default: false description: Enable all constraints with NOVALIDATE as part of post load. max_concurrent_source_connections: type: integer default: 30 description: Maximum number of parallel connection that hyperscale can have with source datasource. max_concurrent_target_connections: type: integer default: 30 description: Maximum number of parallel connection that hyperscale can have with target datasource. max_parallel_connections_per_table: type: integer default: 30 description: Maximum number of parallel connection that per table per masking job. max_records_per_split: type: integer format: int64 default: 30 description: Maximum number of rows allowed per split file for job execution. max_split_per_connection: type: integer default: 4 description: Maximum number of split files allowed per connection for job execution. parallelism_degree: type: integer default: 0 description: Degree of parallelism for target database. retain_execution_data: type: string enum: - 'NO' - ON_ERROR - ALWAYS default: 'NO' description: Defines whether execution data will be stored after execution is complete. Enum having values- NO, ON_ERROR, ALWAYS. stream_size: type: integer default: 0 description: The stream size to be used by sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server. column_array_rows: type: integer default: 0 description: The number of column array rows to be used by sqlldr oracle utility which determines the number of rows loaded before the stream buffer is built. unload_split: type: integer default: 1 description: The number of unloaded files to be generated from the source database. VirtualizationTaskEvent: deprecated: true properties: message_details: type: string Engine: properties: engine_id: type: string minLength: 1 maxLength: 4000 engine_name: type: string minLength: 1 maxLength: 4000 MoveComplianceNodesToJobOrchestratorRequest: description: Parameters to move compliance nodes from a hyperscale orchestrator to a job orchestrator. type: object required: - compliance_node_ids - job_orchestrator_id properties: compliance_node_ids: description: List of compliance node IDs to move. type: array items: type: string example: - node-101 - node-102 - node-103 job_orchestrator_id: description: The ID of the target job orchestrator to move the compliance nodes to. type: string example: f8e7d6c5-b4a3-2109-8765-43210fedcba9 PaginatedResponseMetadata: type: object properties: prev_cursor: description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page. type: string next_cursor: description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page. type: string total: description: The total number of results. This value may not be provided. type: integer format: int_64 JobTaskEvent: properties: message_details: type: string DeleteTag: type: object properties: key: description: Key of the tag type: string minLength: 1 maxLength: 4000 example: key-1 value: description: Value of the tag type: string minLength: 1 maxLength: 4000 example: value-1 tags: description: List of tags to be deleted type: array minItems: 1 maxItems: 1000 uniqueItems: true items: $ref: '#/components/schemas/Tag' JobTask: properties: id: type: string parent_job_id: type: string start_time: type: string format: date-time end_time: type: string format: date-time title: type: string percent_complete: type: integer minimum: 0 maximum: 100 events: type: array items: $ref: '#/components/schemas/JobTaskEvent' status: type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED TagsRequest: type: object required: - tags properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' minItems: 1 maxItems: 1000 uniqueItems: true MoveComplianceNodesResponse: description: Response for compliance node movement operations. type: object properties: job: $ref: '#/components/schemas/Job' description: The Job tracking the compliance node movement. HyperscaleInstanceRegistrationParameter: title: HyperscaleInstanceRegistrationParameter type: object description: Parameters to register and authenticate a Hyperscale instance required: - name - hostname - api_key - job_orchestrator_id properties: name: type: string description: Name in DCT of the Hyperscale instance. minLength: 1 maxLength: 256 hostname: type: string description: Hostname of the Hyperscale instance. If the Hyperscale instance is running on a custom port (not 443), the port can be specified using the "hostname:port" format, for instance "hyperscale-1.mycompany.co:1765" minLength: 1 maxLength: 512 api_key: x-dct-toolkit-credential-field: true description: API key to connect to the Hyperscale instance. type: string nullable: true minLength: 1 maxLength: 4096 insecure_ssl: description: 'Allow connections to the hyperscale instance over HTTPs without validating the TLS certificate. Even though the connection to the hyperscale instance might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates. ' type: boolean default: false unsafe_ssl_hostname_check: description: 'Ignore validation of the name associated to the TLS certificate when connecting to the hyperscale instance over HTTPs. Setting this value must only be done if the TLS certificate of the hyperscale instance does not match the hostname, and the TLS configuration of the hyperscale instance cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. ' type: boolean default: false tags: description: The tags to be created for this engine. type: array items: $ref: '#/components/schemas/Tag' make_current_account_owner: type: boolean default: true description: Whether the account creating this Hyperscale instance must be configured as owner of it. job_orchestrator_id: type: string description: The ID or name of the job orchestrator that is associated with this hyperscale instance. nullable: false auto_calculate_unload_split: type: boolean default: true description: If set, hyperscale will auto calculate the no of splits required for masking job. consider_continuous_compliance_warning_event_as: type: string enum: - SUCCESS - FAILURE default: SUCCESS description: The flag to control behavior of Hyperscale Job execution on warning event in Continuous Compliance Job execution. Default behavior of Hyperscale Job on the WARNING status of Continuous Compliance Job execution, is to consider it as SUCCESS. One example of warning event in Continuous Compliance is masking non conformant data. create_all_indexes_with_nologging: type: boolean default: false description: Add all indexes with NOLOGGING as part of post load. disable_parallel_index_creation: type: boolean default: false description: Exclude indexes from combining with constraint and trigger groups as part of pre load. enable_all_constraints_with_novalidate: type: boolean default: false description: Enable all constraints with NOVALIDATE as part of post load. max_concurrent_source_connections: type: integer default: 30 minimum: 1 maximum: 32767 description: Maximum number of parallel connection that hyperscale can have with source datasource. max_concurrent_target_connections: type: integer default: 30 minimum: 1 maximum: 32767 description: Maximum number of parallel connection that hyperscale can have with target datasource. max_parallel_connections_per_table: type: integer default: 30 minimum: 1 maximum: 32767 description: Maximum number of parallel connection that per table per masking job. max_records_per_split: type: integer format: int64 default: 30 minimum: 1 description: Maximum number of rows allowed per split file for job execution. max_split_per_connection: type: integer default: 4 minimum: 1 maximum: 32767 description: Maximum number of split files allowed per connection for job execution. parallelism_degree: type: integer default: 0 minimum: -1 maximum: 32767 description: Degree of parallelism for target database. retain_execution_data: type: string enum: - 'NO' - ON_ERROR - ALWAYS default: 'NO' description: Defines whether execution data will be stored after execution is complete. Enum having values- NO, ON_ERROR, ALWAYS. stream_size: type: integer default: 0 minimum: 0 description: The stream size to be used by sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server. column_array_rows: type: integer default: 0 minimum: 0 description: The number of column array rows to be used by sqlldr oracle utility which determines the number of rows loaded before the stream buffer is built. unload_split: type: integer default: 1 minimum: 1 maximum: 32767 description: The number of unloaded files to be generated from the source database. SearchBody: description: Search body. type: object properties: filter_expression: type: string minLength: 5 maxLength: 50000 example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku" VirtualizationTask: deprecated: true properties: id: type: string parent_job_id: type: string start_time: type: string format: date-time end_time: type: string format: date-time title: type: string percent_complete: type: integer minimum: 0 maximum: 100 events: type: array items: $ref: '#/components/schemas/VirtualizationTaskEvent' status: type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED SyncEnginesHyperscaleParameters: type: object description: Parameters to sync the global object from a source engine to a list of target engines registered with a Hyperscale Instance. required: - source_engine_id - target_engine_ids properties: source_engine_id: type: string description: The ID of the engine to copy the data from. minLength: 1 maxLength: 256 example: '1' target_engine_ids: type: array items: type: string minLength: 1 maxLength: 256 minItems: 1 description: The IDs of the target engines to copy the data into. example: - '1' - '2' EngineIdBody: description: The ID of the registered engine. type: object properties: engine_id: type: string minLength: 1 example: '1' TagsResponse: type: object properties: tags: description: Array of tags with key value pairs type: array items: $ref: '#/components/schemas/Tag' HyperscaleDataTypeEnum: type: string description: The data type designation for the hyperscale deployment. enum: - ORACLE - MSSQL - DELIMITED_FILES - MONGO_DB example: ORACLE Job: description: An asynchronous task. type: object properties: id: description: The Job entity ID. type: string example: job-123 status: description: The status of the job. type: string enum: - PENDING - STARTED - TIMEDOUT - RUNNING - CANCELED - FAILED - SUSPENDED - WAITING - COMPLETED - ABANDONED example: RUNNING is_waiting_for_telemetry: description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated. type: boolean type: description: The type of job being done. type: string example: DB_REFRESH localized_type: description: The i18n translated type of job being done. type: string example: DB Refresh error_details: description: Details about the failure for FAILED jobs. type: string example: Unable to connect to the engine. warning_message: description: Warnings for the job. type: string example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.' target_id: description: A reference to the job's target. type: string example: vdb-123 target_name: description: A reference to the job's target name. type: string example: vdb start_time: description: The time the job started executing. type: string format: date-time example: '2022-01-02T05:11:24.148000+00:00' update_time: description: The time the job was last updated. type: string format: date-time example: '2022-01-02T06:11:24.148000+00:00' trace_id: description: traceId of the request which created this Job type: string engine_ids: description: IDs of the engines this Job is executing on. type: array items: type: string deprecated: true tags: type: array items: $ref: '#/components/schemas/Tag' engines: type: array items: $ref: '#/components/schemas/Engine' account_id: description: The ID of the account who initiated this job. type: integer example: 1 account_name: description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-. type: string example: User 1 compliance_node_id: type: string description: The ID of the associated compliance node, if applicable. nullable: true compliance_node_name: type: string description: The name of the associated compliance node, if applicable. nullable: true percent_complete: description: Completion percentage of the Job. type: integer minimum: 0 maximum: 100 example: '50' virtualization_tasks: deprecated: true type: array items: $ref: '#/components/schemas/VirtualizationTask' tasks: type: array items: $ref: '#/components/schemas/JobTask' execution_id: description: The ID of the associated masking execution, if any. type: string nullable: true result_type: description: The type of the job result. This is the type of the object present in the result. type: string result: description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property. type: object HyperscaleInstanceUpdateParams: title: HyperscaleInstanceUpdateParams type: object description: Parameters to update a Hyperscale instances. properties: name: type: string description: Name in DCT of the Hyperscale instance. minLength: 1 maxLength: 256 hostname: type: string description: Hostname of the Hyperscale instance. If the Hyperscale instance is running on a custom port (not 443), the port can be specified using the "hostname:port" format, for instance "hyperscale-1.mycompany.co:1765" minLength: 1 maxLength: 512 api_key: x-dct-toolkit-credential-field: true description: API key to connect to the Hyperscale instance. type: string nullable: true minLength: 1 maxLength: 4096 insecure_ssl: description: 'Allow connections to the hyperscale instance over HTTPs without validating the TLS certificate. Even though the connection to the hyperscale instance might be performed over HTTPs, setting this property eliminates the protection against a man-in-the-middle attach for connections to this engine. Instead, consider configuring DCT with Certificate Authority certificates. ' type: boolean unsafe_ssl_hostname_check: description: 'Ignore validation of the name associated to the TLS certificate when connecting to the hyperscale instance over HTTPs. Setting this value must only be done if the TLS certificate of the hyperscale instance does not match the hostname, and the TLS configuration of the hyperscale instance cannot be fixed. Setting this property reduces the protection against a man-in-the-middle attack for connections to this engine. This is ignored if insecure_ssl is set. ' type: boolean job_orchestrator_id: type: string description: The ID or name of the job orchestrator that is associated with this hyperscale instance. nullable: true auto_calculate_unload_split: type: boolean description: If set, hyperscale will auto calculate the no of splits required for masking job. consider_continuous_compliance_warning_event_as: type: string enum: - SUCCESS - FAILURE description: The flag to control behavior of Hyperscale Job execution on warning event in Continuous Compliance Job execution. Default behavior of Hyperscale Job on the WARNING status of Continuous Compliance Job execution, is to consider it as SUCCESS. One example of warning event in Continuous Compliance is masking non conformant data. create_all_indexes_with_nologging: type: boolean description: Add all indexes with NOLOGGING as part of post load. disable_parallel_index_creation: type: boolean description: Exclude indexes from combining with constraint and trigger groups as part of pre load. enable_all_constraints_with_novalidate: type: boolean description: Enable all constraints with NOVALIDATE as part of post load. max_concurrent_source_connections: type: integer minimum: 1 maximum: 32767 description: Maximum number of parallel connection that hyperscale can have with source datasource. max_concurrent_target_connections: type: integer minimum: 1 maximum: 32767 description: Maximum number of parallel connection that hyperscale can have with target datasource. max_parallel_connections_per_table: type: integer minimum: 1 maximum: 32767 description: Maximum number of parallel connection that per table per masking job. max_records_per_split: type: integer format: int64 minimum: 1 description: Maximum number of rows allowed per split file for job execution. max_split_per_connection: type: integer minimum: 1 maximum: 32767 description: Maximum number of split files allowed per connection for job execution. parallelism_degree: type: integer minimum: -1 maximum: 32767 description: Degree of parallelism for target database. retain_execution_data: type: string enum: - 'NO' - ON_ERROR - ALWAYS description: Defines whether execution data will be stored after execution is complete. Enum having values- NO, ON_ERROR, ALWAYS. stream_size: type: integer minimum: 0 description: The stream size to be used by sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server. column_array_rows: type: integer minimum: 0 description: The number of column array rows to be used by sqlldr oracle utility which determines the number of rows loaded before the stream buffer is built. unload_split: type: integer minimum: 1 maximum: 32767 description: The number of unloaded files to be generated from the source database. parameters: hyperscaleInstanceId: in: path name: hyperscaleInstanceId schema: type: string required: true description: The ID of hyperscale instance. hyperscaleInstancesSortParam: name: sort in: query description: The field to sort results by. A property name with a prepended '-' signifies descending order. example: id required: false schema: type: string enum: - id - -id - name - -name - hostname - -hostname - creation_date - -creation_date - status - -status - data_type - -data_type - connection_status - -connection_status - connection_status_details - -connection_status_details - job_orchestrator_id - -job_orchestrator_id - job_orchestrator_name - -job_orchestrator_name - node_count - -node_count nullable: true example: name limit: name: limit in: query description: Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. example: 50 schema: type: integer minimum: 1 maximum: 1000 default: 100 cursor: name: cursor in: query description: Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. schema: type: string minLength: 1 maxLength: 4096 requestBodies: SearchBody: x-skip-codegen-attr: description description: 'A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS ''foobar'', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN [''Goku'', ''Vegeta''] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH ''12''` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ ''Goku'' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ ''Goku'' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS ''foo'') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | "foo", "bar", "foo bar", ''foo'', ''bar'', ''foo bar'' | | Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], [''foo'', "bar"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. ' content: application/json: schema: $ref: '#/components/schemas/SearchBody' examples: nested: description: 'An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0. ' summary: Nested Object Comparison value: filter_expression: repositories CONTAINS {version eq '19.0.0'} relative: description: 'An example of a relative comparison testing that field1 has a value which is less than 123. ' summary: Relative comparison value: filter_expression: field1 LE 123 nil: description: 'An example of using nil to test for the absence of a value for field2. ' summary: Absence of an attribute value value: filter_expression: field2 EQ NIL non-nil: description: 'An example of using nil to test for the existence of a value for field2. ' summary: Existence of an attribute value value: filter_expression: field2 NE NIL contains: description: 'An example of using the ''CONTAINS'' operator to check if field2 contains the string ''foo''. If field2 is string valued then this is checking if ''foo'' is a substring of field2. If field2 is a list of strings then this is checking if ''foo'' is a member of the list. ' summary: Use of the CONTAINS operator value: filter_expression: field2 CONTAINS 'foo' in: description: 'An example of using the ''IN'' operator to check if field1 is an element of a list literal. ' summary: Use of the IN operator value: filter_expression: field1 IN [1, 2, 3] search: description: 'An example of using the ''SEARCH'' operator to retrieve all elements for which ''foo'' is a substring of a filterable attribute. ' summary: Use of the SEARCH operator value: filter_expression: SEARCH 'foo' parenthesis: description: 'An example of parenthesis being used to group operators & override operator precedence. ' summary: Overriding operator precedence value: filter_expression: field1 LT 1234 AND (field2 CONTAINS 'foo' OR field3 CONTAINS 'bar') DeleteTags: description: The parameters to delete tags content: application/json: schema: x-body-name: environment $ref: '#/components/schemas/DeleteTag' examples: delete_all_tags: description: Delete all tags for given object - No request body required summary: Delete all tags value: {} delete_tags_by_key: description: Delete all tags for given object with matching key summary: Delete tags by key value: key: key-1 delete_tags_by_key_value: description: Delete tag for given object with matching key and value summary: Delete a tag by key & value value: key: key-1 value: value-1 delete_multiple_tags_by_key_value: description: Delete tags for given list of tags with matching key and value summary: Delete multiple tags by key & value value: tags: - key: key-1 value: value-1 - key: key-2 value: value-2 securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization