Get list of registered catalogs
GET /catalogs
Get list of registered catalogs
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.catalog.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
default_catalogs
boolean
Default catalogs flag for cornerstone feature
view
string
Internal view parameter for cornerstone feature
Response
200 - Success
catalogs
array
List of catalogs
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Register delta and hudi tables
POST /catalogs/{catalog_id}/schemas/{schema_id}/register
Register delta and hudi tables
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.table.register
Auditing
Calling this method generates the following auditing event.
Request
Request Body
RegisterTableBody
Request body
metadata_location
Required *
string
Metadata location
table_name
Required *
string
Table name
Path Parameters
catalog_id
Required *
string
catalog id
schema_id
Required *
string
URL encoded schema name
Query Parameters
Response
201 - Success
response
SuccessResponse
Response of success
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Load delta and hudi tables metadata
GET /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/metadata
Load delta and hudi tables metadata
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.table.load
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
catalog_id
Required *
string
catalog id
schema_id
Required *
string
URL encoded schema name
table_id
Required *
string
URL encoded table name
Query Parameters
Response
200 - Success
metadata_location
string
Metadata location
table_path
string
Path to the table
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get catalog engine association
GET /catalogs/{catalog_name}/engines
Get catalog engine association
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.catalog_engine.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
catalog_name
Required *
string
catalog name
Query Parameters
Response
200 - Success
associated_engines
array
List of associated engines
catalog_name
string
Name of the catalog
catalog_type
string
Catalog type like iceberg,hive etc
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete schema
DELETE /catalogs/{catalog_name}/schemas/{schema_name}
Delete a schema
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.schema.delete
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
catalog_name
Required *
string
Catalog name
schema_name
Required *
string
URL encoded Schema name
Query Parameters
engine_id
Required *
string
Engine id of presto/prestissimo/spark/db2/netezza other engine
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List all tables
GET /catalogs/{catalog_name}/schemas/{schema_name}/tables
List all tables in a schema in a catalog for a given engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.table.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
catalog_name
Required *
string
catalog name
schema_name
Required *
string
URL encoded schema name
Query Parameters
engine_id
Required *
string
Engine id of presto/prestissimo/spark
Response
200 - Success
tables
array
List of the tables present in the schema
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get table details
GET /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}
Get details of a given table in a catalog and schema
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.table.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
columns
array
List of columns
name
string
Table name
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete table
DELETE /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}
Delete table for a given schema and catalog
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.table.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Rename table
PATCH /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}
Rename table
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.table.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Request body
Response
200 - Success
columns
array
List of columns
name
string
Table name
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List all columns of a table
GET /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/columns
List all columns of a table in a given a schema for a given catalog
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.column.list
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
columns
array
List of the columns present in the table
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Add column(s)
POST /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/columns
Add one or multiple columns to a table in a schema for a given catalog
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.column.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
ColumnPrototype
Request body
columns
array
List of the tables present in the schema
Response
201 - Success
columns
array
List of the columns present in the table
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete column
DELETE /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/columns/{column_name}
Delete column in a table for a given schema and catalog
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.column.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Alter column
PATCH /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/columns/{column_name}
Update the given column - rename column
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.column.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Request body
Response
200 - Success
comment
string
Optional comment or description of the column
extra
string
Extra column attributes, e.g., AUTO_INCREMENT, DEFAULT, etc.
length
string
Length for types like VARCHAR or CHAR. Should be a numeric string.
name
string
Valid SQL column name
precision
string
Precision (total number of digits) for numeric types like DECIMAL
scale
string
Scale (number of digits after the decimal point) for numeric types like DECIMAL
type
string
SQL data type, e.g., varchar, int, decimal(10,2), etc.
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Rollback snapshot
POST /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/rollback
Rollback table to snapshot
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.table_rollback.set
Auditing
Calling this method generates the following auditing event.
Request
Request Body
RollbackPrototype
Request body
snapshot_id
string
Snapshot Id
Path Parameters
catalog_name
Required *
string
Catalog name
schema_name
Required *
string
Schema name
table_name
Required *
string
Table name
Query Parameters
engine_id
string
Engine id
Response
201 - Success
response
SuccessResponse
Response of success
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get table snapshots
GET /catalogs/{catalog_name}/schemas/{schema_name}/tables/{table_name}/snapshots
List all table snapshots
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.table_snapshot.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
catalog_name
Required *
string
Catalog name
schema_name
Required *
string
Schema name
table_name
Required *
string
Table name
Query Parameters
engine_id
string
Engine name
Response
200 - Success
snapshots
array
List of snapshots
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List all schemas
GET /catalogs/{id}/schemas
List all schemas in catalog
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.schema.list
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
schemas
array
List of schemas fetched from given catalog
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create schema
POST /catalogs/{id}/schemas
Create a new schema
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.schema.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
SchemaPrototype
Request body
custom_path
Required *
string
Path within bucket where schema will be created
hostname
string
Host name of the HDFS bucket. Need to be provided if using HDFS
name
Required *
string
Unique schema name, schemas with same names are not allowed in a catalog
port
integer
Port of the HDFS bucket. Need to be provided if using HDFS
storage_name
string
Bucket associated to catalog where schema will be added
Path Parameters
Query Parameters
Response
201 - Success
custom_path
string
Path within bucket where schema will be created
hostname
string
Host name of the HDFS bucket. Need to be provided if using HDFS
name
string
Unique schema name, schemas with same names are not allowed in a catalog
port
integer
Port of the HDFS bucket. Need to be provided if using HDFS
storage_name
string
Bucket associated to catalog where schema will be added
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
External Iceberg table registration
POST /catalogs/{id}/sync
Synchronize the external Iceberg table registration for a catalog identified by catalog_id.
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.catalog_sync.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
SyncPrototype
Request body
auto_add_new_tables
boolean
Automatically detect and add new tables to the system when they appear in the source
register_new_tables
boolean
Register newly discovered tables in the system so they can be tracked and managed
sync_existing_tables
boolean
Synchronize and update metadata for existing tables that are already registered
sync_iceberg_md
boolean
Indicates whether to synchronize metadata from Iceberg tables with the system
sync_path
string
Path within the bucket from where the details will be sync-ed
Path Parameters
id
Required *
string
catalog ID
Query Parameters
Response
200 - Success
response
SuccessResponse
Response of success
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get catalog properties by catalog_id
GET /catalogs/{name}
Get catalog properties of a catalog identified by catalog_id
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.catalog.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
actions
array
List of allowed actions
associated_databases
array
List of associated databases
associated_engines
array
List of associated engines
associated_storage
array
List of associated storage
base_path
string
catalog base path
catalog_sync_metadata
CatalogSyncMetadata
Catalog synchronization metadata
created_at
string
Epoch timestamp when the catalog was created
created_by
string
Created by
days_left
string
Days left for catalog dissociation in case of vulnerability
description
string
The description if added, for the catalog
location_uri
string
catalog location uri
managed_by
string
Managed by
mds_connection_information
MdsConnectionInfo
MDS Thrift server connection details
metastore
string
Underlying catalog or storage backend used for metadata operations.For example,if the database type is `hive_hadoop2` or `iceberg`, the metastore is often set to `glue`.For HDFS, the metastore may be set to `hdfs`
name
string
Name of the catalog
status
string
Catalog status
tags
array
List of tags added to this catalog
catalog_names
array
Catalog names
type
string
Catalog type like iceberg,hive etc
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete catalog catalog_id
DELETE /catalogs/{name}
Delete catalog identified by catalog_id
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.catalog.delete
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
skip_mds_call
boolean
Skip MDS call when Unity catalog is added
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of databases
GET /database_registrations
Get list of databases
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.database_registration.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
database_registrations
array
Database body
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Add/Create database
POST /database_registrations
Add or create a new database
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.database_registration.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
DatabaseRegistrationPrototype
Request body
associated_catalog
DatabaseCatalogPrototype
database catalog
catalog_name
string
catalog name
catalog_type
string
catalog type
connection
DatabaseDetailsPrototype
database details
authentication_type
string
Authentication method
authentication_value
string
Authentication method
authentication_value_key_vault
object
secret details
broker_authentication_password
string
Broker authentication password
broker_authentication_type
string
Broker authentication type
broker_authentication_user
string
Broker authentication user
broker_host
string
Broker host
broker_port
integer
Broker port
certificate
string
contents of a pem/crt file
certificate_extension
string
extension of the certificate file
connection_method
string
connection mode
connection_mode
string
connection mode
connection_mode_value
string
connection mode value
connection_type
string
Connection type
controller_authentication_password
string
Controller authentication password
controller_authentication_type
string
Controller authentication type
controller_authentication_user
string
Controller authentication user
coordinator_host
string
Coordinator host
coordinator_port
integer
Coordinator port
cpd_hostname
string
CPD Hostname
credentials_key
string
Base 64 encoded json file
domain_name
string
Domain name
hostname
string
Host name
hostname_in_certificate
string
Hostname in certificate
hosts
string
String of hostname:port
informix_server
string
informix server value
name
string
Database name
password
string
Psssword
password_key_vault
object
secret details
port
integer
Port
project_id
string
Project ID
sasl
boolean
SASL Mode
sasl_mechanism
string
sasl mechanism for kafka. Allowed values are plain, scram_sha_256, scram_sha_512
schema_name
string
Schema name
schemas
string
Add tables
service_api_key
string
service api key
service_hostname
string
service hostname
service_password
string
service password
service_port
integer
Service Port
service_ssl
boolean
Service SSL Mode
service_token_url
string
service token url
service_username
string
service username
ssl
boolean
SSL Mode
sslcertificate_key_vault
object
secret details
tables
string
Add tables
username
string
Username
username_key_vault
object
secret details
validate_server_certificate
boolean
Verify certificate
vault_enabled
boolean
vault enabled or not
verify_host_name
boolean
Verify host name
warehouse_name
string
Warehouse name
created_at
string
Created on
description
string
Database description
display_name
Required *
string
Database display name
properties
array
This will hold all the properties for a custom database
source_asset_id
string
Source connection assset Id from platform
source_catalog_id
string
Source catalog Id from platform
source_project_id
string
Source project Id from platform
tags
array
tags
target_catalog_id
string
Target catalog id in the platform to save the database connection
type
Required *
string
Connector type
Path Parameters
Query Parameters
Response
201 - Success
actions
array
actions
associated_catalog
DatabaseCatalog
database catalog
catalog_name
string
Catalog name
connection
DatabaseDetails
database details
created_at
string
Created on
created_by
string
Created by
description
string
Database description
display_name
string
Database display name
id
string
Database ID
properties
array
This will hold all the properties for a custom database
target_catalog_id
string
Target catalog id in the platform to save the database connection
source_asset_id
string
Source connection assset Id from platform
source_catalog_id
string
Source catalog Id from platform
source_project_id
string
Source project Id from platform
tables
array
List of tables
tags
array
tags
topics
array
List of topics
type
string
Connector type
vault_enabled
boolean
vault enabled or not
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Add database catalog
POST /database_registrations/{database_id}/catalogs
Add catalog to a registered database
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.catalog.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
DatabaseCatalogName
Request body
catalog_name
string
catalog name
Response
201 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get database
GET /database_registrations/{id}
Get a registered databases
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.database_registration.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
actions
array
actions
associated_catalog
DatabaseCatalog
database catalog
catalog_name
string
Catalog name
connection
DatabaseDetails
database details
created_at
string
Created on
created_by
string
Created by
description
string
Database description
display_name
string
Database display name
id
string
Database ID
properties
array
This will hold all the properties for a custom database
target_catalog_id
string
Target catalog id in the platform to save the database connection
source_asset_id
string
Source connection assset Id from platform
source_catalog_id
string
Source catalog Id from platform
source_project_id
string
Source project Id from platform
tables
array
List of tables
tags
array
tags
topics
array
List of topics
type
string
Connector type
vault_enabled
boolean
vault enabled or not
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete database
DELETE /database_registrations/{id}
Delete a database
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.database_registration.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update database
PATCH /database_registrations/{id}
Update database details
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.database_registration.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Request body
Path Parameters
Query Parameters
Response
200 - Success
actions
array
actions
associated_catalog
DatabaseCatalog
database catalog
catalog_name
string
Catalog name
connection
DatabaseDetails
database details
created_at
string
Created on
created_by
string
Created by
description
string
Database description
display_name
string
Database display name
id
string
Database ID
properties
array
This will hold all the properties for a custom database
target_catalog_id
string
Target catalog id in the platform to save the database connection
source_asset_id
string
Source connection assset Id from platform
source_catalog_id
string
Source catalog Id from platform
source_project_id
string
Source project Id from platform
tables
array
List of tables
tags
array
tags
topics
array
List of topics
type
string
Connector type
vault_enabled
boolean
vault enabled or not
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of db2 engines
GET /db2_engines
Get list of all db2 engines
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.db2_engine.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
db2_engines
array
list db2 engines
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create db2 engine
POST /db2_engines
Create a new db2 engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.db2_engine.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Db2EnginePrototype
Create db2 engine body
configuration
Required *
Db2EngineDetailsBody
External engine details
connection_string
Required *
string
External engine connection string
description
string
Engine description
display_name
Required *
string
Engine display name
origin
Required *
string
Origin of the engine
tags
array
Tags
Path Parameters
Query Parameters
Response
201 - Success
actions
array
Actions
build_version
string
watsonx.data build version
configuration
Db2EngineDetails
External engine details
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description.
display_name
string
Engine display name
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
Engine programmatic name
origin
string
Origin - place holder
port
integer
Engine port
status
string
Status of db2 engnine
tags
array
Tags
type
string
Engine type
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete db2 engine
DELETE /db2_engines/{id}
Delete a db2 engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.db2_engine.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update db2 engine
PATCH /db2_engines/{id}
Update details of db2 engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.db2_engine.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Update Engine Body
Path Parameters
Query Parameters
Response
200 - Success
actions
array
Actions
build_version
string
watsonx.data build version
configuration
Db2EngineDetails
External engine details
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description.
display_name
string
Engine display name
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
Engine programmatic name
origin
string
Origin - place holder
port
integer
Engine port
status
string
Status of db2 engnine
tags
array
Tags
type
string
Engine type
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List ingestion jobs
GET /lhingestion/api/v1/ingestion/jobs
Get list of ingestion jobs.
Request
Path Parameters
Query Parameters
start
string
Page offset
limit
integer
Page size
Response
200 - Ok
limit
integer
Pagination Limit
offset
integer
Pagination Offset
total_count
integer
Pagination Result Total Count
jobs
array
List ingestion jobs
first
PagedResultsLink
Pagination next/previous page links
last
PagedResultsLink
Pagination next/previous page links
next
PagedResultsLink
Pagination next/previous page links
400 - Bad Request
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not Found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal Server Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Submit ingestion job
POST /lhingestion/api/v1/ingestion/jobs
Submit an ingestion job with the provided source and target details.
Request
Request Body
IngestionJobPrototype
id
Required *
string
Job ID of the ingestion job
source
Required *
SourceDetails
Details of ingestion source files.
file_paths
string
Comma separated source file or directory path.
file_type
string
Source file types (parquet, csv, json, orc, avro or text)
source_type
Required *
string
Ingestion source type
schema
array
List of schema information derived from file. Updates to a schema must be added to schema_transformations
schema_transformations
array
List of additions/transformations applied to the schema.
schema_name
string
Source DB Schema Name
table_name
string
Source DB Table Name
bucket_details
object
Storage connection details
iceberg_source_table
object
Iceberg source table information
source_database
object
Database credentials model
file_format_properties
object
Options used to read CSV or Text file.
is_local_ingestion
boolean
Determine if ingestion job is a local ingestion job
target
Required *
TargetDetails
Details of ingestion target table.
catalog
Required *
string
Catalog of target table.
schema
Required *
string
Schema of target table.
table
Required *
string
Target table where files will be ingested.
write_mode
Required *
string
Append to existing data or overwrite it.
merge_on_read
boolean
Create table with 'merge-on-read' property.
schema_mode
string
Controls schema validation mode. Use 'strict' to enforce exact schema match, or 'sloppy' to allow relaxed matching.
schema_infer
boolean
Cast source column types to match target table types during append operations. When enabled, matching columns are cast to target types to prevent type mismatch errors. Works independently of schema_mode.
catalog_uri
string
Metastore catalog URI
bucket_details
object
Storage connection details
location
string
Warehouse location
is_new_schema
boolean
Determine if target schema was created in this ingestion job
is_new_table
boolean
Determine if target table was created in this ingestion job
engine
IngestionEngine
Spark Engine Detail
engine_id
string
Engine programmatic name
name
string
Engine display name
endpoint
string
Engine endpoint
origin
string
Origin - created or registered
execute_config
object
Ingestion engine configuration
bucket_details
object
Storage connection details
log_path
string
Engine log path
engine_id
string
ID of the spark engine to be used for ingestion
execute_config
ExecuteConfig
Ingestion engine configuration
driver_memory
string
Driver memory configuration (in GB) for Spark engine
driver_cores
integer
Driver core(s) configuration for Spark engine
executor_memory
string
Executor memory configuration (in GB) for Spark engine
executor_cores
integer
Executor core(s) configuration for Spark engine
num_executors
integer
Number of executors to assign for Spark engine
source_iceberg_table
IcebergSourceTable
Iceberg source table information
schema_name
string
Iceberg schema name
table_name
string
Iceberg table name
catalog_name
string
Iceberg catalog name
warehouse_name
string
Iceberg warehouse name
snapshot_id
integer
Iceberg snapshot ID
partition_by
string
Comma delimited list of columns to partition by
capacity
CapacityDetails
Capacity Details
id
string
Capacity ID for given spark engine.
Path Parameters
Query Parameters
Response
201 - Ingestion job submitted successfully
instance_id
string
Instance ID of the lakehouse where ingestion job is executed
job_id
string
Job ID of the ingestion job
application_id
string
Application ID of the ingestion job
username
string
Ingestion job user
start_timestamp
string
Unix timestamp of ingestion job starting
end_timestamp
string
Unix timestamp of ingestion job completing
status
string
Current state of ingestion job
source_data_files
string
Source data location of the ingestion job
target_table
string
Target table name in format catalog.schema.table
details
string
Error messages of failed ingestion job
engine_logs
string
Engine application logs
engine_id
string
ID of the spark engine to be used for ingestion
engine_name
string
Name of the spark engine to be used for ingestion
partition_by
string
Comma delimited list of columns to partition by
is_new_schema
boolean
Determine if target schema was created in this ingestion job
is_new_table
boolean
Determine if target table was created in this ingestion job
400 - Bad Request
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not Found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get ingestion job by ID
GET /lhingestion/api/v1/ingestion/jobs/{id}
Get ingestion job by ID.
Request
Path Parameters
id
Required *
string
Ingestion Job ID
Query Parameters
Response
200 - Ok
instance_id
string
Instance ID of the lakehouse where ingestion job is executed
job_id
string
Job ID of the ingestion job
application_id
string
Application ID of the ingestion job
username
string
Ingestion job user
start_timestamp
string
Unix timestamp of ingestion job starting
end_timestamp
string
Unix timestamp of ingestion job completing
status
string
Current state of ingestion job
source_data_files
string
Source data location of the ingestion job
target_table
string
Target table name in format catalog.schema.table
details
string
Error messages of failed ingestion job
engine_logs
string
Engine application logs
engine_id
string
ID of the spark engine to be used for ingestion
engine_name
string
Name of the spark engine to be used for ingestion
partition_by
string
Comma delimited list of columns to partition by
is_new_schema
boolean
Determine if target schema was created in this ingestion job
is_new_table
boolean
Determine if target table was created in this ingestion job
400 - Bad Request
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not Found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal Server Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
To validate an integration
POST /integration_validation
To validate the details of an integration.
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.dashboard.view
Auditing
Calling this method generates the following auditing event.
Request
Request Body
ValidateIntegrationPrototype
Body paramters for validating an integration credentials
access_token
string
Access Token for the integration of type `databand`.
apikey
string
ApiKey for the integration of type `manta` and `ikc`.
catalogs
Catalogs
Details of catalogs associated with `ikc`
catalog_names
Required *
array
Comma separated list of catalogs for which `ikc` needs to be enabled
certificate
string
Certificate to be provided if ssl is enabled for integration type `ikc` in Cloud Pack for Data.
password
string
Password for the integration of type `ranger`.
ssl
boolean
SSL enabler/disabler for `ikc` in Cloud Pack for Data.
type
Required *
string
Type of the integration to be integrated. It can only have the following values: `ranger`, `ikc`, `databand` and `manta`.
url
string
URL of the integration to be integrated. Applicable for all the 4 types: `ranger`, `ikc`, `databand` and `manta`
username
string
Username of the `ikc`/`manta`/`ranger` integration to be integrated.
Path Parameters
Query Parameters
Response
200 - Success
message
string
A brief description of the `message_code`
message_code
string
Message code stating if a success or failure.
ranger_details
RangerDetails
Details realted to the available resources for `ranger`
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal Server Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List integrations
GET /integrations
List all existing integrations (can be filtered based on `type`)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.dashboard.view
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
type
array
Filter based on the type of the integration. It can only have the following values: `ranger`, `ikc`, `databand` and `manta`.
state
array
Filter based on the state of the integration. It can only have the following values: `active`, `inactive`, and `failed`.
Response
200 - Success
integrations
array
Database body
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create an integration
POST /integrations
To create an integration of type Apache Ranger, IBM Knowlege Catalog, IBM Manta Data lineage or IBM Data Observability by Databand
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.dashboard.view
Auditing
Calling this method generates the following auditing event.
Request
Request Body
IntegrationPrototype
Parameters for registering an integration
access_token
string
Access Token for the integration of type `databand`.
apikey
string
ApiKey for the integration of type `manta` and `ikc`.
catalogs
Catalogs
Details of catalogs associated with `ikc`
catalog_names
Required *
array
Comma separated list of catalogs for which `ikc` needs to be enabled
certificate
string
Certificate if ssl is enabled for integration type `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
certificate_extension
string
Certificate extension of the certificate provided if ssl is enabled for integration type `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
connection_mode
string
Connection mode for manta
cross_account_integration
boolean
To enable/disable cross account integration for `ikc` in IBM Cloud / MCSP.
enable_data_policy_within_wxd
boolean
To check if WatsonX.data policies are enabled along with `ranger`.
ikc_user_account_id
string
The Account ID where the `ikc` is existing with which cross account integration needs to be enabled, to be used compulsorily with `cross_account_integration`.
password
string
Password for the integration of type `ranger`.
policy_cache_time_configuration
string
Displays the policy cache type configuration for integration type `ranger`.
resource
string
Currently selected resource for `ranger`.
ssl
boolean
SSL enabled/disabled for `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
type
string
Type of the integration to be integrated. It can only have the following values: `ranger`, `ikc`, `databand` and `manta`.
url
string
URL of the integration to be integrated. Applicable for all the 4 types: `ranger`, `ikc`, `databand` and `manta`
username
string
Username of the `ikc`/`manta`/`ranger` integration to be integrated.
Response
201 - Success
access_token
string
Access Token for the integration of type `databand`. The value will be encrypted.
apikey
string
ApiKey for the integration of type `manta` and `ikc`. The value will be encrypted.
auth_url
string
Authentication url for the corresponding `manta` integration in saas (Internal use only).
catalogs
Catalogs
Details of catalogs associated with `ikc`
certificate
string
Certificate if ssl is enabled for integration type `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
certificate_extension
string
Certificate extension of the certificate provided if ssl is enabled for integration type `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
config_properties
string
Properties for `ikc`.
connection_mode
string
Connection mode for manta
cross_account_integration
boolean
To enable/disable cross account integration for `ikc` in IBM Cloud / MCSP.
enable_data_policy_within_wxd
boolean
To check if WatsonX.data policies are enabled along with `ranger`.
governance_properties
string
Properties for `ikc`.
id
string
Unique id to identify the integration
ikc_user_account_id
string
The Account ID where the `ikc` is existing with which cross account integration needs to be enabled, to be used compulsorily with `cross_account_integration`.
manta_url
string
Manta specific Url derived from the url provided for `manta` integration in Saas
modified_at
integer
Last Modified time for the corresponding integration in epoch format
modified_by
string
Last Modified user name for the corresponding integration
password
string
Password for the integration of type `ranger`. The value will be encrypted.
policy_cache_time_configuration
string
Displays the policy cache type configuration for integration type `ranger`.
resource
string
Currently selected resource for `ranger`.
ssl
boolean
SSL enabled/disabled for `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
state
string
Current state of the integration
type
string
Type of the integration integrated. It will only have the following values: `ranger`, `ikc`, `databand` and `manta`.
url
string
URL of the integration. Applicable for all the 4 types: `ranger`, `ikc`, `databand` and `manta`
username
string
Username of the `ikc`/`manta`/`ranger` integration.
zen_apikey
string
Zen API key for the integration of type `manta` (Internal use only).
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get an Integration
GET /integrations/{id}
To get the details of an integration
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.dashboard.view
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
access_token
string
Access Token for the integration of type `databand`. The value will be encrypted.
apikey
string
ApiKey for the integration of type `manta` and `ikc`. The value will be encrypted.
auth_url
string
Authentication url for the corresponding `manta` integration in saas (Internal use only).
catalogs
Catalogs
Details of catalogs associated with `ikc`
certificate
string
Certificate if ssl is enabled for integration type `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
certificate_extension
string
Certificate extension of the certificate provided if ssl is enabled for integration type `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
config_properties
string
Properties for `ikc`.
connection_mode
string
Connection mode for manta
cross_account_integration
boolean
To enable/disable cross account integration for `ikc` in IBM Cloud / MCSP.
enable_data_policy_within_wxd
boolean
To check if WatsonX.data policies are enabled along with `ranger`.
governance_properties
string
Properties for `ikc`.
id
string
Unique id to identify the integration
ikc_user_account_id
string
The Account ID where the `ikc` is existing with which cross account integration needs to be enabled, to be used compulsorily with `cross_account_integration`.
manta_url
string
Manta specific Url derived from the url provided for `manta` integration in Saas
modified_at
integer
Last Modified time for the corresponding integration in epoch format
modified_by
string
Last Modified user name for the corresponding integration
password
string
Password for the integration of type `ranger`. The value will be encrypted.
policy_cache_time_configuration
string
Displays the policy cache type configuration for integration type `ranger`.
resource
string
Currently selected resource for `ranger`.
ssl
boolean
SSL enabled/disabled for `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
state
string
Current state of the integration
type
string
Type of the integration integrated. It will only have the following values: `ranger`, `ikc`, `databand` and `manta`.
url
string
URL of the integration. Applicable for all the 4 types: `ranger`, `ikc`, `databand` and `manta`
username
string
Username of the `ikc`/`manta`/`ranger` integration.
zen_apikey
string
Zen API key for the integration of type `manta` (Internal use only).
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete an Integration
DELETE /integrations/{id}
Deletes an existing integration completely from WatsonX.data
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.dashboard.view
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update an Integration
PATCH /integrations/{id}
To Update information details and state of an existing integration
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.dashboard.view
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Body for parameters supported for integrations
Response
200 - Success
access_token
string
Access Token for the integration of type `databand`. The value will be encrypted.
apikey
string
ApiKey for the integration of type `manta` and `ikc`. The value will be encrypted.
auth_url
string
Authentication url for the corresponding `manta` integration in saas (Internal use only).
catalogs
Catalogs
Details of catalogs associated with `ikc`
certificate
string
Certificate if ssl is enabled for integration type `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
certificate_extension
string
Certificate extension of the certificate provided if ssl is enabled for integration type `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
config_properties
string
Properties for `ikc`.
connection_mode
string
Connection mode for manta
cross_account_integration
boolean
To enable/disable cross account integration for `ikc` in IBM Cloud / MCSP.
enable_data_policy_within_wxd
boolean
To check if WatsonX.data policies are enabled along with `ranger`.
governance_properties
string
Properties for `ikc`.
id
string
Unique id to identify the integration
ikc_user_account_id
string
The Account ID where the `ikc` is existing with which cross account integration needs to be enabled, to be used compulsorily with `cross_account_integration`.
manta_url
string
Manta specific Url derived from the url provided for `manta` integration in Saas
modified_at
integer
Last Modified time for the corresponding integration in epoch format
modified_by
string
Last Modified user name for the corresponding integration
password
string
Password for the integration of type `ranger`. The value will be encrypted.
policy_cache_time_configuration
string
Displays the policy cache type configuration for integration type `ranger`.
resource
string
Currently selected resource for `ranger`.
ssl
boolean
SSL enabled/disabled for `ikc` (ikc hosted in Cloud Pack for Data) and `ranger`.
state
string
Current state of the integration
type
string
Type of the integration integrated. It will only have the following values: `ranger`, `ikc`, `databand` and `manta`.
url
string
URL of the integration. Applicable for all the 4 types: `ranger`, `ikc`, `databand` and `manta`
username
string
Username of the `ikc`/`manta`/`ranger` integration.
zen_apikey
string
Zen API key for the integration of type `manta` (Internal use only).
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of milvus services
GET /milvus_services
Get list milvus services
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service.read
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
milvus_services
array
List of milvus services
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create milvus service
POST /milvus_services
Create milvus service
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
MilvusServicePrototype
Create milvus service
dc_cpu
number
data coordinator cpus, only configurable in cpd
dc_memory
number
data coordinator memory, only configurable in cpd
dc_replicas
integer
data coordinator replicas, only configurable in cpd
description
string
Descriptioon of Milvus service added by the user
display_name
Required *
string
Display name for milvus services
dw_cpu
number
data worker cpus, only configurable in cpd
dw_memory
number
data worker memory, only configurable in cpd
dw_replicas
integer
data worker replicas, only configurable in cpd
etcd_cpu
number
etcd cpus, only configurable in cpd
etcd_memory
number
etcd memory, only configurable in cpd
id
string
Engine id
index_type
string
index type
iw_cpu
number
index worker cpu
iw_memory
number
index worker memory
iw_replicas
integer
index worker replicas
kafka_cpu
number
kafka cpus, only configurable in cpd
kafka_memory
number
kafka memory, only configurable in cpd
origin
Required *
string
Origin of the milvus service
proxy_cpu
number
proxy cpus, only configurable in cpd
proxy_memory
number
proxy memory, only configurable in cpd
proxy_replicas
integer
proxy replicas, only configurable in cpd
qc_cpu
number
query coordinator cpus, only configurable in cpd
qc_memory
number
query coordinator memory, only configurable in cpd
qc_replicas
integer
query coordinator replicas, only configurable in cpd
qw_cpu
number
query worker cpu
qw_memory
number
query worker memory
qw_replicas
integer
query worker replicas
rc_cpu
number
root coordinator cpus, only configurable in cpd
rc_memory
number
root coodinator memory, only configurable in cpd
rc_replicas
integer
root coordinator replicas, only configurable in cpd
root_path
Required *
string
Root path in storage where milvus vectors will be stored.
storage_name
string
storage name
tags
array
Tags
tshirt_size
Required *
string
Predefined tshirt size for the milvus service
vector
integer
vector
vector_dimension
integer
vector dimension
Response
202 - Success
access_key
string
storage access key
actions
array
Actions
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
dc_cpu
number
data coordinator cpus, only configurable in cpd
dc_memory
number
data coordinator memory, only configurable in cpd
dc_replicas
integer
data coordinator replicas, only configurable in cpd
description
string
Descriptioon of Milvus service added by the user
display_name
string
Display name for milvus services
dw_cpu
number
data worker cpus, only configurable in cpd
dw_memory
number
data worker memory, only configurable in cpd
dw_replicas
integer
data worker replicas, only configurable in cpd
endpoint
string
storage endpoint
etcd_cpu
number
etcd cpus, only configurable in cpd
etcd_memory
number
etcd memory, only configurable in cpd
failure_message
string
Failure message
grpc_host
string
milvus grpc_host
grpc_port
integer
milvus port
host_name
string
milvus display name
https_host
string
milvus https_host
https_port
integer
milvus port
id
string
Engine id
index_type
string
Index type of milvus engine
iw_cpu
number
index worker cpu
iw_memory
number
index worker memory
iw_replicas
integer
index worker replicas
kafka_cpu
number
kafka cpus, only configurable in cpd
kafka_memory
number
kafka memory, only configurable in cpd
managed_by
string
How is the Milvus instance managed
origin
string
Origin of the milvus service
proxy_cpu
number
proxy cpus, only configurable in cpd
proxy_host
string
milvus proxy host
proxy_memory
number
proxy memory, only configurable in cpd
proxy_port
integer
milvus proxy port
proxy_replicas
integer
proxy replicas, only configurable in cpd
qc_cpu
number
query coordinator cpus, only configurable in cpd
qc_memory
number
query coordinator memory, only configurable in cpd
qc_replicas
integer
query coordinator replicas, only configurable in cpd
qw_cpu
number
query worker cpu
qw_memory
number
query worker memory
qw_replicas
integer
query worker replicas
rc_cpu
number
root coordinator cpus, only configurable in cpd
rc_memory
number
root coodinator memory, only configurable in cpd
rc_replicas
integer
root coordinator replicas, only configurable in cpd
root_path
string
Root path in storage where milvus vectors will be stored.
secret_key
string
storage secret access key
status
string
milvus status
status_code
integer
milvus status code
storage_name
string
storage name
tags
array
Tags
tshirt_size
string
Predefined tshirt size for the milvus service
type
string
service type
vector
integer
vector
vector_dimension
integer
vector dimension
version
string
Milvus version
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get milvus service
GET /milvus_services/{id}
Get milvus service
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
access_key
string
storage access key
actions
array
Actions
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
dc_cpu
number
data coordinator cpus, only configurable in cpd
dc_memory
number
data coordinator memory, only configurable in cpd
dc_replicas
integer
data coordinator replicas, only configurable in cpd
description
string
Descriptioon of Milvus service added by the user
display_name
string
Display name for milvus services
dw_cpu
number
data worker cpus, only configurable in cpd
dw_memory
number
data worker memory, only configurable in cpd
dw_replicas
integer
data worker replicas, only configurable in cpd
endpoint
string
storage endpoint
etcd_cpu
number
etcd cpus, only configurable in cpd
etcd_memory
number
etcd memory, only configurable in cpd
failure_message
string
Failure message
grpc_host
string
milvus grpc_host
grpc_port
integer
milvus port
host_name
string
milvus display name
https_host
string
milvus https_host
https_port
integer
milvus port
id
string
Engine id
index_type
string
Index type of milvus engine
iw_cpu
number
index worker cpu
iw_memory
number
index worker memory
iw_replicas
integer
index worker replicas
kafka_cpu
number
kafka cpus, only configurable in cpd
kafka_memory
number
kafka memory, only configurable in cpd
managed_by
string
How is the Milvus instance managed
origin
string
Origin of the milvus service
proxy_cpu
number
proxy cpus, only configurable in cpd
proxy_host
string
milvus proxy host
proxy_memory
number
proxy memory, only configurable in cpd
proxy_port
integer
milvus proxy port
proxy_replicas
integer
proxy replicas, only configurable in cpd
qc_cpu
number
query coordinator cpus, only configurable in cpd
qc_memory
number
query coordinator memory, only configurable in cpd
qc_replicas
integer
query coordinator replicas, only configurable in cpd
qw_cpu
number
query worker cpu
qw_memory
number
query worker memory
qw_replicas
integer
query worker replicas
rc_cpu
number
root coordinator cpus, only configurable in cpd
rc_memory
number
root coodinator memory, only configurable in cpd
rc_replicas
integer
root coordinator replicas, only configurable in cpd
root_path
string
Root path in storage where milvus vectors will be stored.
secret_key
string
storage secret access key
status
string
milvus status
status_code
integer
milvus status code
storage_name
string
storage name
tags
array
Tags
tshirt_size
string
Predefined tshirt size for the milvus service
type
string
service type
vector
integer
vector
vector_dimension
integer
vector dimension
version
string
Milvus version
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete milvus service
DELETE /milvus_services/{id}
Delete milvus service
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update milvus service
PATCH /milvus_services/{id}
Update details of milvus service
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Update milvus service
Path Parameters
Query Parameters
Response
200 - Success
access_key
string
storage access key
actions
array
Actions
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
dc_cpu
number
data coordinator cpus, only configurable in cpd
dc_memory
number
data coordinator memory, only configurable in cpd
dc_replicas
integer
data coordinator replicas, only configurable in cpd
description
string
Descriptioon of Milvus service added by the user
display_name
string
Display name for milvus services
dw_cpu
number
data worker cpus, only configurable in cpd
dw_memory
number
data worker memory, only configurable in cpd
dw_replicas
integer
data worker replicas, only configurable in cpd
endpoint
string
storage endpoint
etcd_cpu
number
etcd cpus, only configurable in cpd
etcd_memory
number
etcd memory, only configurable in cpd
failure_message
string
Failure message
grpc_host
string
milvus grpc_host
grpc_port
integer
milvus port
host_name
string
milvus display name
https_host
string
milvus https_host
https_port
integer
milvus port
id
string
Engine id
index_type
string
Index type of milvus engine
iw_cpu
number
index worker cpu
iw_memory
number
index worker memory
iw_replicas
integer
index worker replicas
kafka_cpu
number
kafka cpus, only configurable in cpd
kafka_memory
number
kafka memory, only configurable in cpd
managed_by
string
How is the Milvus instance managed
origin
string
Origin of the milvus service
proxy_cpu
number
proxy cpus, only configurable in cpd
proxy_host
string
milvus proxy host
proxy_memory
number
proxy memory, only configurable in cpd
proxy_port
integer
milvus proxy port
proxy_replicas
integer
proxy replicas, only configurable in cpd
qc_cpu
number
query coordinator cpus, only configurable in cpd
qc_memory
number
query coordinator memory, only configurable in cpd
qc_replicas
integer
query coordinator replicas, only configurable in cpd
qw_cpu
number
query worker cpu
qw_memory
number
query worker memory
qw_replicas
integer
query worker replicas
rc_cpu
number
root coordinator cpus, only configurable in cpd
rc_memory
number
root coodinator memory, only configurable in cpd
rc_replicas
integer
root coordinator replicas, only configurable in cpd
root_path
string
Root path in storage where milvus vectors will be stored.
secret_key
string
storage secret access key
status
string
milvus status
status_code
integer
milvus status code
storage_name
string
storage name
tags
array
Tags
tshirt_size
string
Predefined tshirt size for the milvus service
type
string
service type
vector
integer
vector
vector_dimension
integer
vector dimension
version
string
Milvus version
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Pause milvus service
POST /milvus_services/{id}/pause
Pause a running milvus service
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service.pause
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
id
Query Parameters
Response
201 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Resume milvus service
POST /milvus_services/{id}/resume
Resume a paused milvus service
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service.resume
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
id
Query Parameters
Response
201 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Scale a milvus service
POST /milvus_services/{id}/scale
Scale an existing milvus service
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service.scale
Auditing
Calling this method generates the following auditing event.
Request
Request Body
MilvusServiceScale
Scale Service Body
dc_cpu
number
data coordinator cpus, only configurable in cpd
dc_memory
number
data coordinator memory, only configurable in cpd
dc_replicas
integer
data coordinator replicas, only configurable in cpd
dw_cpu
number
data worker cpus, only configurable in cpd
dw_memory
number
data worker memory, only configurable in cpd
dw_replicas
integer
data worker replicas, only configurable in cpd
etcd_cpu
number
etcd cpus, only configurable in cpd
etcd_memory
number
etcd memory, only configurable in cpd
index_type
string
index type, required for custom size
iw_cpu
number
index worker cpus
iw_memory
number
index worker memory
iw_replicas
integer
index worker replicas
kafka_cpu
number
kafka cpus, only configurable in cpd
kafka_memory
number
kafka memory, only configurable in cpd
proxy_cpu
number
proxy cpus, only configurable in cpd
proxy_memory
number
proxy memory, only configurable in cpd
proxy_replicas
integer
proxy replicas, only configurable in cpd
qc_cpu
number
query coordinator cpus, only configurable in cpd
qc_memory
number
query coordinator memory, only configurable in cpd
qc_replicas
integer
query coordinator replicas, only configurable in cpd
qw_cpu
number
query worker cpus
qw_memory
number
query worker memory
qw_replicas
integer
query worker replicas
rc_cpu
number
root coordinator cpus, only configurable in cpd
rc_memory
number
root coodinator memory, only configurable in cpd
rc_replicas
integer
root coordinator replicas, only configurable in cpd
tshirt_size
Required *
string
tshirt size
vector
integer
vector
vector_dimension
integer
vector dimension
Path Parameters
id
Required *
string
id
Query Parameters
Response
201 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get milvus service databases
GET /milvus_services/{service_id}/databases
Get milvus service databases
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service_databases.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
databases
array
List of milvus service databases
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get milvus database collections
GET /milvus_services/{service_id}/databases/{database_id}/collections
Get milvus database collections
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_database_collections.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
collections
array
List of Milvus database collections
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get milvus database collection partitions
GET /milvus_services/{service_id}/databases/{database_id}/collections/{collection_name}/partitions
Get milvus database collection partitions
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_database_collections.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
partitions
array
List of milvus database collection partitions
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update milvus service storage
PATCH /milvus_services/{service_id}/storage
Update details of milvus service bucket
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.milvus_service.update.bucket
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Update milvus service bucket
Path Parameters
Query Parameters
Response
200 - Success
access_key
string
storage access key
actions
array
Actions
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
dc_cpu
number
data coordinator cpus, only configurable in cpd
dc_memory
number
data coordinator memory, only configurable in cpd
dc_replicas
integer
data coordinator replicas, only configurable in cpd
description
string
Descriptioon of Milvus service added by the user
display_name
string
Display name for milvus services
dw_cpu
number
data worker cpus, only configurable in cpd
dw_memory
number
data worker memory, only configurable in cpd
dw_replicas
integer
data worker replicas, only configurable in cpd
endpoint
string
storage endpoint
etcd_cpu
number
etcd cpus, only configurable in cpd
etcd_memory
number
etcd memory, only configurable in cpd
failure_message
string
Failure message
grpc_host
string
milvus grpc_host
grpc_port
integer
milvus port
host_name
string
milvus display name
https_host
string
milvus https_host
https_port
integer
milvus port
id
string
Engine id
index_type
string
Index type of milvus engine
iw_cpu
number
index worker cpu
iw_memory
number
index worker memory
iw_replicas
integer
index worker replicas
kafka_cpu
number
kafka cpus, only configurable in cpd
kafka_memory
number
kafka memory, only configurable in cpd
managed_by
string
How is the Milvus instance managed
origin
string
Origin of the milvus service
proxy_cpu
number
proxy cpus, only configurable in cpd
proxy_host
string
milvus proxy host
proxy_memory
number
proxy memory, only configurable in cpd
proxy_port
integer
milvus proxy port
proxy_replicas
integer
proxy replicas, only configurable in cpd
qc_cpu
number
query coordinator cpus, only configurable in cpd
qc_memory
number
query coordinator memory, only configurable in cpd
qc_replicas
integer
query coordinator replicas, only configurable in cpd
qw_cpu
number
query worker cpu
qw_memory
number
query worker memory
qw_replicas
integer
query worker replicas
rc_cpu
number
root coordinator cpus, only configurable in cpd
rc_memory
number
root coodinator memory, only configurable in cpd
rc_replicas
integer
root coordinator replicas, only configurable in cpd
root_path
string
Root path in storage where milvus vectors will be stored.
secret_key
string
storage secret access key
status
string
milvus status
status_code
integer
milvus status code
storage_name
string
storage name
tags
array
Tags
tshirt_size
string
Predefined tshirt size for the milvus service
type
string
service type
vector
integer
vector
vector_dimension
integer
vector dimension
version
string
Milvus version
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of Netezza engines
GET /netezza_engines
Get list of all netezza engines
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.netezza_engine.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
netezza_engines
array
list Netezza engines
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create netezza engine
POST /netezza_engines
Create a new netezza engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.netezza_engine.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
NetezzaEnginePrototype
Create netezza engine body
configuration
Required *
NetezzaEngineConfigurationBody
External engine details
connection_string
Required *
string
External engine connection string
description
string
Engine description
display_name
Required *
string
Engine display name
origin
Required *
string
Origin - created or registered
tags
array
Tags
Path Parameters
Query Parameters
Response
201 - Success
actions
array
Actions
build_version
string
watsonx.data build version
configuration
NetezzaEngineConfiguration
External engine details
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description
display_name
string
Engine display name
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
Engine programmatic name
origin
string
Origin
port
integer
Engine port
status
string
Engine status
tags
array
Tags
type
string
Engine type
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete netezza engine
DELETE /netezza_engines/{id}
Delete a netezza engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.netezza_engine.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update netezza engine
PATCH /netezza_engines/{id}
Update details of netezza engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.netezza_engine.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Update Engine Body
Path Parameters
Query Parameters
Response
200 - Success
actions
array
Actions
build_version
string
watsonx.data build version
configuration
NetezzaEngineConfiguration
External engine details
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description
display_name
string
Engine display name
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
Engine programmatic name
origin
string
Origin
port
integer
Engine port
status
string
Engine status
tags
array
Tags
type
string
Engine type
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of other engines
GET /other_engines
Get list of other engines
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.other_engine.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
other_engines
array
list other engines
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create other engine
POST /other_engines
Create a new engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.other_engine.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
OtherEnginePrototype
Create other Engine Body
configuration
Required *
OtherEngineConfigurationBody
External engine details
connection_string
Required *
string
External engine connection string
type
Required *
string
Actual engine type
description
string
engine description
display_name
Required *
string
engine display name
origin
Required *
string
Origin - created or registered
tags
array
other engine tags
Path Parameters
Query Parameters
Response
201 - Success
actions
array
Actions
configuration
OtherEngineConfiguration
External engine details
created_at
integer
created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
engine description
display_name
string
Engine display name
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
engine programmatic name
origin
string
origin
port
integer
Engine port
status
string
engine status
tags
array
Tags
type
string
Type like presto, netezza, external,..
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete engine
DELETE /other_engines/{id}
Delete an engine from lakehouse
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.other_engine.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of prestissimo engines
GET /prestissimo_engines
Get list of prestissimo engines
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
prestissimo_engines
array
list prestissimo engines
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create prestissimo engine
POST /prestissimo_engines
Create a new prestissimo engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
PrestissimoEnginePrototype
Create Engine Body
associated_catalogs
array
Associated catalogs
configuration
Required *
PrestissimoEngineDetails
External engine details
coordinator
Required *
object
Presto engine configurations.
size_config
Required *
string
CPD supported sizes are: custom, starter, small, medium, large, xlarge, and xxlarge. IBM cloud supported sizes are: custom, starter, small, medium, large, cache_optimized, compute_optimized and lite.
worker
Required *
object
Presto engine configurations.
description
string
Engine description
display_name
Required *
string
Engine display name
id
string
Engine id
origin
Required *
string
Origin - created or registered
tags
array
Tags
Path Parameters
Query Parameters
Response
201 - Success
actions
array
Actions
analyze_status
string
status of optimizer sync
associated_catalogs
array
List of catalogs associated with the the engine
build_version
string
watsonx.data build version
configuration
PrestissimoEngineDetails
External engine details
coordinator
NodeDescription
Presto engine configurations.
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description
display_name
string
Engine display name
external_host_name
string
Applicable only for OCP based clusters. This is typically servicename+route
failure_message
string
Failure message
group_id
string
Group ID
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
Engine programmatic name
is_qhmm_engine
boolean
Is QHMM engine
last_time_analyzed
string
last optimizer sync call
optimizer_enabled
string
optimizer enabled status
origin
string
Origin - place holder
port
integer
Engine port
properties
PrestissimoEngineProperties
Engine properties
query_status
string
Query status
region
string
Region - place holder
size_config
string
CPD supported sizes are: custom, starter, small, medium, large, xlarge, and xxlarge. IBM cloud supported sizes are: custom, starter, small, medium, large, cache_optimized, compute_optimized and lite.
status
string
Engine status
status_code
integer
Engine status code
tags
array
Tags
remove_engine_properties
RemovePrestissimoEngineProperties
RemoveEngine properties
restart_type
string
engine will restart accordingily
type
string
Engine type
version
string
Version of the engine
worker
NodeDescription
Presto engine configurations.
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get prestissimo engine catalog
GET /prestissimo_engines/{engine_id}/catalogs/{id}
Get catalog attached to a prestissimo engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine_catalog.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
engine_id
Required *
string
engine id
id
Required *
string
catalog id
Query Parameters
Response
200 - Success
actions
array
List of allowed actions
associated_databases
array
List of associated databases
associated_engines
array
List of associated engines
associated_storage
array
List of associated storage
base_path
string
catalog base path
catalog_sync_metadata
CatalogSyncMetadata
Catalog synchronization metadata
created_at
string
Epoch timestamp when the catalog was created
created_by
string
Created by
days_left
string
Days left for catalog dissociation in case of vulnerability
description
string
The description if added, for the catalog
location_uri
string
catalog location uri
managed_by
string
Managed by
mds_connection_information
MdsConnectionInfo
MDS Thrift server connection details
metastore
string
Underlying catalog or storage backend used for metadata operations.For example,if the database type is `hive_hadoop2` or `iceberg`, the metastore is often set to `glue`.For HDFS, the metastore may be set to `hdfs`
name
string
Name of the catalog
status
string
Catalog status
tags
array
List of tags added to this catalog
catalog_names
array
Catalog names
type
string
Catalog type like iceberg,hive etc
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get prestissimo engine
GET /prestissimo_engines/{id}
Prestissimo engine details
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
actions
array
Actions
analyze_status
string
status of optimizer sync
associated_catalogs
array
List of catalogs associated with the the engine
build_version
string
watsonx.data build version
configuration
PrestissimoEngineDetails
External engine details
coordinator
NodeDescription
Presto engine configurations.
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description
display_name
string
Engine display name
external_host_name
string
Applicable only for OCP based clusters. This is typically servicename+route
failure_message
string
Failure message
group_id
string
Group ID
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
Engine programmatic name
is_qhmm_engine
boolean
Is QHMM engine
last_time_analyzed
string
last optimizer sync call
optimizer_enabled
string
optimizer enabled status
origin
string
Origin - place holder
port
integer
Engine port
properties
PrestissimoEngineProperties
Engine properties
query_status
string
Query status
region
string
Region - place holder
size_config
string
CPD supported sizes are: custom, starter, small, medium, large, xlarge, and xxlarge. IBM cloud supported sizes are: custom, starter, small, medium, large, cache_optimized, compute_optimized and lite.
status
string
Engine status
status_code
integer
Engine status code
tags
array
Tags
remove_engine_properties
RemovePrestissimoEngineProperties
RemoveEngine properties
restart_type
string
engine will restart accordingily
type
string
Engine type
version
string
Version of the engine
worker
NodeDescription
Presto engine configurations.
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete prestissimo engine
DELETE /prestissimo_engines/{id}
Delete a prestissimo engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update prestissimo engine
PATCH /prestissimo_engines/{id}
Update details of prestissimo engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Update prestissimo engine body
Path Parameters
Query Parameters
Response
200 - Success
actions
array
Actions
analyze_status
string
status of optimizer sync
associated_catalogs
array
List of catalogs associated with the the engine
build_version
string
watsonx.data build version
configuration
PrestissimoEngineDetails
External engine details
coordinator
NodeDescription
Presto engine configurations.
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description
display_name
string
Engine display name
external_host_name
string
Applicable only for OCP based clusters. This is typically servicename+route
failure_message
string
Failure message
group_id
string
Group ID
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
Engine programmatic name
is_qhmm_engine
boolean
Is QHMM engine
last_time_analyzed
string
last optimizer sync call
optimizer_enabled
string
optimizer enabled status
origin
string
Origin - place holder
port
integer
Engine port
properties
PrestissimoEngineProperties
Engine properties
query_status
string
Query status
region
string
Region - place holder
size_config
string
CPD supported sizes are: custom, starter, small, medium, large, xlarge, and xxlarge. IBM cloud supported sizes are: custom, starter, small, medium, large, cache_optimized, compute_optimized and lite.
status
string
Engine status
status_code
integer
Engine status code
tags
array
Tags
remove_engine_properties
RemovePrestissimoEngineProperties
RemoveEngine properties
restart_type
string
engine will restart accordingily
type
string
Engine type
version
string
Version of the engine
worker
NodeDescription
Presto engine configurations.
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get prestissimo engine catalogs
GET /prestissimo_engines/{id}/catalogs
Get list of all catalogs attached a prestissimo engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine_catalog.list
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
catalogs
array
List of catalogs
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Associate catalogs to a prestissimo engine
POST /prestissimo_engines/{id}/catalogs
Associate one or more catalogs to a prestissimo engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine_catalog.add
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
Query Parameters
Response
201 - Success
catalogs
array
List of catalogs
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Disassociate catalogs from a prestissimo engine
DELETE /prestissimo_engines/{id}/catalogs
Disassociate one or more catalogs from a prestissimo engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine_catalog.remove
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
catalog_names
Required *
string
Catalog id(s) to be stopped, comma separated
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Pause prestissimo engine
POST /prestissimo_engines/{id}/pause
Pause a running prestissimo engine ie, only available is SAAS
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine.pause
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
engine id
Query Parameters
Response
200 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Explain query
POST /prestissimo_engines/{id}/query_explain
Explain a query statement
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.query_explain.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
id
Required *
string
Engine id
Query Parameters
Response
200 - Success
result
string
result
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Explain analyze
POST /prestissimo_engines/{id}/query_explain_analyze
Return query metrics after query is complete
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.query_explain_analyze.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
id
Required *
string
Engine id
Query Parameters
Response
200 - Success
result
string
explainAnalyzeStatement result
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Restart a prestissimo engine
POST /prestissimo_engines/{id}/restart
Restart an existing prestissimo engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine.refresh
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
engine id
Query Parameters
Response
200 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Resume prestissimo engine
POST /prestissimo_engines/{id}/resume
Resume a paused prestissimo engine ie, only available is SAAS
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine.resume
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
engine id
Query Parameters
Response
200 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Scale a prestissimo engine
POST /prestissimo_engines/{id}/scale
Scale an existing prestissimo engine ie, only available is SAAS
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.prestissimo_engine.scale
Auditing
Calling this method generates the following auditing event.
Request
Request Body
PrestissimoEngineScale
Scale Engine Body
coordinator
NodeDescription
Presto engine configurations.
node_type
string
Presto engine node type.
quantity
integer
Quantity of presto engine node
worker
NodeDescription
Presto engine configurations.
node_type
string
Presto engine node type.
quantity
integer
Quantity of presto engine node
Path Parameters
id
Required *
string
engine id
Query Parameters
Response
202 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of Presto(Java) engines
GET /presto_engines
Get list of all Presto(Java) engines
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
presto_engines
array
List of Presto engines.
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create presto engine
POST /presto_engines
Create a new presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
PrestoEnginePrototype
Create Engine Body
associated_catalogs
array
Catalogs associated to the presto engine
configuration
Required *
EngineDetails
Engine configuration details.
coordinator
Required *
object
Presto engine configurations.
size_config
Required *
string
CPD supported sizes are: custom, starter, small, medium, large, xlarge, and xxlarge. IBM cloud supported sizes are: custom, starter, small, medium, large, cache_optimized, compute_optimized and lite.
worker
Required *
object
Presto engine configurations.
autoscaling_enabled
boolean
Enable autoscaling for the engine
autoscaling_config
object
Autoscaling configuration for the engine
description
string
Engine description
display_name
Required *
string
Engine display name
id
string
Engine id
origin
Required *
string
Origin of presto engine .
tags
Tags
Tags
Path Parameters
Query Parameters
Response
201 - Success
actions
array
Actions
associated_catalogs
array
Catalogs associated to the presto engine
build_version
string
watsonx.data build version
configuration
EngineDetails
Engine configuration details.
coordinator
NodeDescription
Presto engine configurations.
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description
display_name
string
Engine display name
drivers
array
Driver details
properties
EngineProperties
Engine properties
remove_engine_properties
RemoveEngineProperties
The engine properties to be removed which was added through api customisation.
restart_type
string
The type of engine restart . The value can be set to forcefully restart an engine
external_host_name
string
Applicable only for OCP based clusters. This is typically servicename+route
failure_message
string
Failure message
group_id
string
Group ID
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
The unigue identifier for the engine
is_qhmm_engine
boolean
Is QHMM engine
origin
string
Origin
port
integer
Engine port
query_status
string
Query status
resource_groups
array
Resource group details
size_config
string
CPD supported sizes are: custom, starter, small, medium, large, xlarge, and xxlarge. IBM cloud supported sizes are: custom, starter, small, medium, large, cache_optimized, compute_optimized and lite.
status
string
Engine status
status_code
integer
Engine status code
tags
Tags
Tags
type
string
Engine type presto
version
string
Version of the engine
worker
NodeDescription
Presto engine configurations.
autoscaling_enabled
boolean
Enable autoscaling for the engine
autoscaling_config
AutoscalingConfig
Autoscaling configuration for the engine
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update Autoscaling Configuration
PATCH /presto_engines/{engine_id}/autoscaling
Update autoscaling configuration for an existing running Presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine_autoscaling.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Autoscaling configuration
Path Parameters
engine_id
Required *
string
Engine ID
Query Parameters
Response
200 - Success
autoscaling_enabled
boolean
Whether autoscaling is enabled
autoscaling_config
PatchAutoscalingConfig
Updated autoscaling configuration
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get presto engine catalogs
GET /presto_engines/{engine_id}/catalogs
Get list of all catalogs attached to a presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine_catalog.list
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
catalogs
array
List of catalogs
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Associate catalogs to presto engine
POST /presto_engines/{engine_id}/catalogs
Associate one or more catalogs to a presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine_catalog.add
Auditing
Calling this method generates the following auditing event.
Request
Request Body
CatalogPrototype
Request body
catalog_names
Required *
array
Catalog names
Path Parameters
Query Parameters
Response
201 - Success
actions
array
List of allowed actions
associated_databases
array
List of associated databases
associated_engines
array
List of associated engines
associated_storage
array
List of associated storage
base_path
string
catalog base path
catalog_sync_metadata
CatalogSyncMetadata
Catalog synchronization metadata
created_at
string
Epoch timestamp when the catalog was created
created_by
string
Created by
days_left
string
Days left for catalog dissociation in case of vulnerability
description
string
The description if added, for the catalog
location_uri
string
catalog location uri
managed_by
string
Managed by
mds_connection_information
MdsConnectionInfo
MDS Thrift server connection details
metastore
string
Underlying catalog or storage backend used for metadata operations.For example,if the database type is `hive_hadoop2` or `iceberg`, the metastore is often set to `glue`.For HDFS, the metastore may be set to `hdfs`
name
string
Name of the catalog
status
string
Catalog status
tags
array
List of tags added to this catalog
catalog_names
array
Catalog names
type
string
Catalog type like iceberg,hive etc
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Disassociate catalogs from a presto engine
DELETE /presto_engines/{engine_id}/catalogs
Disassociate one or more catalogs from a presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine_catalog.remove
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
catalog_names
Required *
string
Catalog id(s) to be stopped, comma separated
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get presto engine catalog
GET /presto_engines/{engine_id}/catalogs/{id}
Get catalog attached to presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine_catalog.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
engine_id
Required *
string
engine id
id
Required *
string
catalog id
Query Parameters
Response
200 - Success
actions
array
List of allowed actions
associated_databases
array
List of associated databases
associated_engines
array
List of associated engines
associated_storage
array
List of associated storage
base_path
string
catalog base path
catalog_sync_metadata
CatalogSyncMetadata
Catalog synchronization metadata
created_at
string
Epoch timestamp when the catalog was created
created_by
string
Created by
days_left
string
Days left for catalog dissociation in case of vulnerability
description
string
The description if added, for the catalog
location_uri
string
catalog location uri
managed_by
string
Managed by
mds_connection_information
MdsConnectionInfo
MDS Thrift server connection details
metastore
string
Underlying catalog or storage backend used for metadata operations.For example,if the database type is `hive_hadoop2` or `iceberg`, the metastore is often set to `glue`.For HDFS, the metastore may be set to `hdfs`
name
string
Name of the catalog
status
string
Catalog status
tags
array
List of tags added to this catalog
catalog_names
array
Catalog names
type
string
Catalog type like iceberg,hive etc
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get Presto Engine Configuration
GET /presto_engines/{engine_id}/config
Retrieve Presto engine configuration properties. Supports filtering by sections: catalog, configuration, event_listener, global, jmx_exporter_config, jvm, log_config
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine_config.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
engine_id
Required *
string
Engine ID
Query Parameters
sections
string
Comma-separated list of sections to retrieve (catalog,configuration,event_listener,global,jmx_exporter_config,jvm,log_config)
Response
200 - Success
engine_properties
object
Presto engine configuration properties
400 - Bad Request
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not Found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal Server Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update Presto Engine Configuration
PATCH /presto_engines/{engine_id}/config
Update Presto engine configuration properties including catalog, configuration, event_listener, global, jmx_exporter_config, jvm, and log_config settings
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine_config.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Engine properties configuration to update
Path Parameters
engine_id
Required *
string
Engine ID
Query Parameters
Response
200 - Success
400 - Bad Request
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not Found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal Server Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get presto engine
GET /presto_engines/{id}
Get details of one presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
actions
array
Actions
associated_catalogs
array
Catalogs associated to the presto engine
build_version
string
watsonx.data build version
configuration
EngineDetails
Engine configuration details.
coordinator
NodeDescription
Presto engine configurations.
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description
display_name
string
Engine display name
drivers
array
Driver details
properties
EngineProperties
Engine properties
remove_engine_properties
RemoveEngineProperties
The engine properties to be removed which was added through api customisation.
restart_type
string
The type of engine restart . The value can be set to forcefully restart an engine
external_host_name
string
Applicable only for OCP based clusters. This is typically servicename+route
failure_message
string
Failure message
group_id
string
Group ID
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
The unigue identifier for the engine
is_qhmm_engine
boolean
Is QHMM engine
origin
string
Origin
port
integer
Engine port
query_status
string
Query status
resource_groups
array
Resource group details
size_config
string
CPD supported sizes are: custom, starter, small, medium, large, xlarge, and xxlarge. IBM cloud supported sizes are: custom, starter, small, medium, large, cache_optimized, compute_optimized and lite.
status
string
Engine status
status_code
integer
Engine status code
tags
Tags
Tags
type
string
Engine type presto
version
string
Version of the engine
worker
NodeDescription
Presto engine configurations.
autoscaling_enabled
boolean
Enable autoscaling for the engine
autoscaling_config
AutoscalingConfig
Autoscaling configuration for the engine
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete presto engine
DELETE /presto_engines/{id}
Delete a presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update presto engine
PATCH /presto_engines/{id}
Update details of presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Update Engine Body
Path Parameters
Query Parameters
Response
200 - Success
actions
array
Actions
associated_catalogs
array
Catalogs associated to the presto engine
build_version
string
watsonx.data build version
configuration
EngineDetails
Engine configuration details.
coordinator
NodeDescription
Presto engine configurations.
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Engine description
display_name
string
Engine display name
drivers
array
Driver details
properties
EngineProperties
Engine properties
remove_engine_properties
RemoveEngineProperties
The engine properties to be removed which was added through api customisation.
restart_type
string
The type of engine restart . The value can be set to forcefully restart an engine
external_host_name
string
Applicable only for OCP based clusters. This is typically servicename+route
failure_message
string
Failure message
group_id
string
Group ID
host_name
string
Engine host name. In case of OCP based clusters, this is internal hostname
id
string
The unigue identifier for the engine
is_qhmm_engine
boolean
Is QHMM engine
origin
string
Origin
port
integer
Engine port
query_status
string
Query status
resource_groups
array
Resource group details
size_config
string
CPD supported sizes are: custom, starter, small, medium, large, xlarge, and xxlarge. IBM cloud supported sizes are: custom, starter, small, medium, large, cache_optimized, compute_optimized and lite.
status
string
Engine status
status_code
integer
Engine status code
tags
Tags
Tags
type
string
Engine type presto
version
string
Version of the engine
worker
NodeDescription
Presto engine configurations.
autoscaling_enabled
boolean
Enable autoscaling for the engine
autoscaling_config
AutoscalingConfig
Autoscaling configuration for the engine
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Pause presto engine
POST /presto_engines/{id}/pause
Pause a running presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine.pause
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
engine id
Query Parameters
Response
200 - Success
response
SuccessResponse
Response of success
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Explain presto query
POST /presto_engines/{id}/query_explain
Explain a query statement.
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.query_explain.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
id
Required *
string
Engine id
Query Parameters
Response
200 - Success
response
SuccessResponse
Response of success
result
string
Result
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Explain presto analyze
POST /presto_engines/{id}/query_explain_analyze
Return query metrics after query is complete
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.query_explain_analyze.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
id
Required *
string
Engine id
Query Parameters
Response
200 - Success
response
SuccessResponse
Response of success
result
string
Result
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Restart a presto engine
POST /presto_engines/{id}/restart
Restart an existing presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine.refresh
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
engine id
Query Parameters
Response
200 - Success
response
SuccessResponse
Response of success
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Resume Presto(Java) engine
POST /presto_engines/{id}/resume
Resume a paused presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine.resume
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
engine id
Query Parameters
Response
200 - Success
response
SuccessResponse
Response of success
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Scale a presto engine
POST /presto_engines/{id}/scale
Scale an existing presto engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.presto_engine.scale
Auditing
Calling this method generates the following auditing event.
Request
Request Body
PrestoEngineScale
Scale Engine Body
coordinator
NodeDescription
Presto engine configurations.
node_type
string
Presto engine node type.
quantity
integer
Quantity of presto engine node
worker
NodeDescription
Presto engine configurations.
node_type
string
Presto engine node type.
quantity
integer
Quantity of presto engine node
Path Parameters
id
Required *
string
engine id
Query Parameters
Response
202 - Success
response
SuccessResponse
Response of success
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get semantic automation layer Integration of the instance
GET /sal_integration
Get basic details of the semantic automation layer(SAL) integration with IBM Knowledge Catalog(IKC)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
category_id
string
IBM Knowledge Catalog(IKC) category UUID
created_at_epoch
string
SAL integration creation timestamp
engine_id
string
registered engine id of the SAL integration
errors
array
exceptions happens when creating integration with IKC on remote side
instance_id
string
SAL integration instance id
status
string
status of the SAL integration
storage_resource_crn
string
COS resource CRN
storage_type
string
COS storage type
trial_plan
boolean
whether the integration is based on IKC trial plan, which is available on watsonx.data Saas only
username
string
ID of the user who enabled the SAL integration
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create semantic automation layer integration with IBM Knowledge Catalog
POST /sal_integration
Create semantic automation layer integration(SAL) with IBM Knowledge Catalog(IKC)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
SalIntegrationPrototype
Request body
apikey
Required *
string
IAM apikey with IBM Knowledge Catalog access
engine_id
Required *
string
ID of the engine(support presto or prestissimo) to be registered for SAL integration
storage_resource_crn
string
COS storage resource crn, required on Watsonx.data SaaS and not applicable for CPD
storage_type
string
COS storage type, required on Watsonx.data SaaS and not applicable for CPD
trial_plan
boolean
whether the integration is based on IKC trial plan, which is available on IBMCloud only
Path Parameters
Query Parameters
Response
201 - Success
category_id
string
IBM Knowledge Catalog(IKC) category UUID
created_at_epoch
string
SAL integration creation timestamp
engine_id
string
registered engine id of the SAL integration
errors
array
exceptions happens when creating integration with IKC on remote side
instance_id
string
SAL integration instance id
status
string
status of the SAL integration
storage_resource_crn
string
COS resource CRN
storage_type
string
COS storage type
trial_plan
boolean
whether the integration is based on IKC trial plan, which is available on watsonx.data Saas only
username
string
ID of the user who enabled the SAL integration
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete Semantic Automation Layer(SAL) integration
DELETE /sal_integration
Remove Semantic automation layer integration
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Patch Semantic automation layer integration
PATCH /sal_integration
Update Semantic automation layer(SAL) integration properties
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Request body
Path Parameters
Query Parameters
Response
200 - Success
category_id
string
IBM Knowledge Catalog(IKC) category UUID
created_at_epoch
string
SAL integration creation timestamp
engine_id
string
registered engine id of the SAL integration
errors
array
exceptions happens when creating integration with IKC on remote side
instance_id
string
SAL integration instance id
status
string
status of the SAL integration
storage_resource_crn
string
COS resource CRN
storage_type
string
COS storage type
trial_plan
boolean
whether the integration is based on IKC trial plan, which is available on watsonx.data Saas only
username
string
ID of the user who enabled the SAL integration
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
create enrichment jobs of schema(or tables in schema)
POST /sal_integration/enrichment
create enrichment job of schemas, notifing the schema(tables) changes to IBM Knowledge Catalog(IKC) and kick off an import and metadata enrichment job
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
SalEnrichmentPrototype
Request body
changes
array
changed to be submitted and processed by the enrichment job
Path Parameters
Query Parameters
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List semantic enriched data_assets in IBM Knowledge catalog
GET /sal_integration/enrichment/data_assets
List semantic enrichment data_assets(enriched tables) associated with the schema by IBM Knowledge Catalog project id, which can be fetched from /sal_integration/mappings
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment_assets.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
project_id
Required *
string
project id of enriched schema in IBM Knowledge Catalog
Response
200 - Success
data_assets
array
list of enrichment asset in IKC
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get semantic enrichment data_asset associated with the table
GET /sal_integration/enrichment/data_assets/{id}
Get semantic enrichment data_asset associated with the table by IBM Knowledge Catalog project id and asset id, which can be retrived by /sal_integration/enrichement/data_assets
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment_assets_by_id.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
enrichment data asset id in IBM Knowledge Catalog
Query Parameters
project_id
Required *
string
enrichment project id in IBM Knowledge Catalog
Response
200 - Success
attributes
array
attributes of the asset
id
string
data asset id in IKC
name
string
asset name (table name)
resource_key
string
unique resource name of IKC asset
schema_name
string
schema name
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get metadata enrichment global settings
GET /sal_integration/enrichment/global_settings
Get metadata enrichment global settings
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment_global_settings.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
expansion
SalEnrichmentSettingsExpansion
semantic expansion
term_assignment
SalEnrichmentSettingsTermAssignment
semantic expansion
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create or update metadata enrichment global settings
PUT /sal_integration/enrichment/global_settings
Create or update metadata enrichment global settings
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment_global_settings.put
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
Query Parameters
Response
200 - Success
expansion
SalEnrichmentSettingsExpansion
semantic expansion
term_assignment
SalEnrichmentSettingsTermAssignment
semantic expansion
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List semantic enrichment jobs associated with the schema
GET /sal_integration/enrichment/jobs
List semantic enrichment jobs in wkc that associated with the schema by project id(in the given project from IBM Knowledge Catalog perspective)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment_jobs.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
project_id
Required *
string
IBM Knowledge Catalog project id
Response
200 - Success
jobs
array
list of enrichment jobs
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List semantic enrichment job runs associated with the schema
GET /sal_integration/enrichment/jobs/{job_id}/runs
List runs of an SAL enrichement job associated with the schema(project in IBM Knowledge Catalog perspective)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment_job_runs.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
job_id
Required *
string
enrichment job id, refered as 'asset_id' in '/Sal_integration/enrichment/jobs'
Query Parameters
project_id
Required *
string
enrichment project id
Response
200 - Success
runs
array
list of job runs as response
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get semantic enrichment job run logs associated with the job run
GET /sal_integration/enrichment/jobs/{job_id}/runs/{run_id}/logs
Get semantic enrichment job run logs associated with the job run
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment_job_run_logs.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
job_id
Required *
string
IBM Knowledge Catalog enrichment job id
run_id
Required *
string
IBM Knowledge Catalog enrichment job run id
Query Parameters
project_id
Required *
string
IBM Knowledge Catalog project id
Response
200 - Success
results
array
response from enrichment job run log request
total_count
integer
name
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
get metadata enrichment settings for a IBM Knowledge Catalog project(schema)
GET /sal_integration/enrichment/project_settings
get metadata enrichment settings for a IBM Knowledge Catalog project(schema)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment_project_settings.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
project_id
Required *
string
IBM Knowledge Catalog project id
Response
200 - Success
expansion
SalEnrichmentSettingsExpansion
semantic expansion
term_assignment
SalEnrichmentSettingsTermAssignment
semantic expansion
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create or update project level metadata enrichment settings
PUT /sal_integration/enrichment/project_settings
Create or update metadata enrichment settings for a IBM Knowledge Catalog project(enriched schema)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_enrichment_project_settings.put
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
Query Parameters
project_id
Required *
string
IBM Knowledge Catalog project id
Response
202 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of uploaded glossary terms
GET /sal_integration/glossary/terms
Get list of uploaded glossary terms
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_glossary_terms.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
glossary_terms
array
collection of glossary terms
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Upload semantic enrichment business terms glossary
POST /sal_integration/glossary/upload_processes
Upload semantic enrichment business terms glossary
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_upload_glossary.post
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
Query Parameters
Response
201 - Success
id
string
glossary uploading process id
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get status of glossary uploading process(job)
GET /sal_integration/glossary/upload_processes/{id}/status
Get status of glossary uploading process(job)
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_upload_glossary_status.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
upload process id
Query Parameters
Response
200 - Success
response
string
response of the uploading process status in json
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Post watsonx.data schema to fetch mapped catalog and project
GET /sal_integration/mappings
use the list of watsonx.data catalog and schema to fetch mapped IKC project id and catalog id
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_integration_mappings.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
catalog_name
string
catalog name in Watsonx.data
schema_name
string
schema name in Watsonx.data
next
string
reference as an continue of reading results from earlier query (if the results exceed 100)
Response
200 - Success
mappings
array
list of results as sal maapping in Watsonx.data vs IKC metadata
next
string
reference for next part of the query results (if results number exceed 100)
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List Semantic Search queries snapshot
GET /sal_integration/semantic_search/queries
List Semantic Search queries snapshot
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.semantic_search_queries.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
engine_id
string
engine id
schema_search_enabled
boolean
enable schemas search
column_search_enabled
boolean
enable columns search
max_result_number
integer
max history records limitation
run_search
boolean
if the response include actual search result
Response
200 - Success
queries
array
List of semantic search results
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Trigger a global search among IBM Knowledge Catalog metadata by given query
POST /sal_integration/semantic_search/queries
Execute a query of global search among IBM Knowledge Catalog metadata
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.semantic_search_queries.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
SemanticSearchBody
Request body
engine_id
Required *
string
engine id
query_input
Required *
string
search string
search_config
SemanticSearchBodySearchConfig
request payload for semantic search configurations
column_search_enabled
boolean
enable columns search
fields
array
search fields
max_result_number
integer
max result number limitation
schema_search_enabled
boolean
enable schemas search
Path Parameters
Query Parameters
Response
201 - Success
id
string
id of the semantic search query record
last_search_time
string
last time of searching the same query string
results
array
search results of given query
search_query
string
input search query
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Clear semantic search query history
DELETE /sal_integration/semantic_search/queries
Delete the history records of semantic search in batch, if no batch_size given, entire semantic search history list will be removed
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.semantic_search_queries.delete
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
batch_size
integer
max number to queries to be deleted (most recent to least), if no number provided all queries history will be clear
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete semantic search query history by record id
DELETE /sal_integration/semantic_search/queries/{id}
Delete the history records of semantic search by record id
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.semantic_search_queries_by_id.delete
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
id
Required *
string
id of the semanric search query record
Query Parameters
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete Semantic automation layer(SAL) integration metadata
DELETE /sal_metadata
Delete SAL integration metadata
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.sal_metadata.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of spark engines
GET /spark_engines
Get list of spark engines
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
spark_engines
array
List of spark engines
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create spark engine
POST /spark_engines
Create a new spark engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
SparkEnginePrototype
Create spark engine Body
associated_catalogs
array
Catalogs to be Associated to the engine.
configuration
SparkEngineDetails
Spark engine configuration details
api_key
string
Api key to be used for connecting with external Analytics engine instance. Applicable only for external engine.
connection_string
string
External engine connection string. Applicable only for external engine.
default_config
object
Default Spark configuration properties to be applied for all applications running on this Spark engine
default_version
string
Default spark version for applications run on this Spark engine.
endpoints
object
Spark engine endpoints.
engine_home
object
Engine home properties for Spark engine configuration
engine_sub_type
string
spark engine sub type
instance_id
string
Id of Analytics engine instance used as external engine.
managed_by
string
How is the spark instance managed
resource_limit_enabled
boolean
Resource limit enabled flag
resource_limits
object
Native spark engine resource quota
resource_utilisation
object
Native spark engine resource utilisation
scale_config
object
Spark instance scale configuration
vscode_config
object
Spark vscode configuration
description
string
Information on the Spark engine
display_name
Required *
string
Engine display name
id
string
Engine id
origin
Required *
string
Origin - created or registered
status
string
Status of engine
tags
array
Tags
type
string
Type of spark engine
Path Parameters
Query Parameters
Response
202 - Accepted
actions
array
Actions
associated_catalogs
array
Catalogs to be Associated to the engine.
build_version
string
watsonx.data build version
configuration
SparkEngineDetails
Spark engine configuration details
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Information on the Spark engine.
display_name
string
Engine display name
id
string
Engine id
mode
string
Mode of spark engine
origin
string
Origin - created or registered
status
string
Status of engine
tags
array
Tags
type
string
Type of spark engine
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get spark engine catalog
GET /spark_engines/{engine_id}/catalogs/{id}
Get catalog attached to spark engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_catalog.get
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
engine_id
Required *
string
engine id
id
Required *
string
catalog id
Query Parameters
Response
200 - Success
actions
array
List of allowed actions
associated_databases
array
List of associated databases
associated_engines
array
List of associated engines
associated_storage
array
List of associated storage
base_path
string
catalog base path
catalog_sync_metadata
CatalogSyncMetadata
Catalog synchronization metadata
created_at
string
Epoch timestamp when the catalog was created
created_by
string
Created by
days_left
string
Days left for catalog dissociation in case of vulnerability
description
string
The description if added, for the catalog
location_uri
string
catalog location uri
managed_by
string
Managed by
mds_connection_information
MdsConnectionInfo
MDS Thrift server connection details
metastore
string
Underlying catalog or storage backend used for metadata operations.For example,if the database type is `hive_hadoop2` or `iceberg`, the metastore is often set to `glue`.For HDFS, the metastore may be set to `hdfs`
name
string
Name of the catalog
status
string
Catalog status
tags
array
List of tags added to this catalog
catalog_names
array
Catalog names
type
string
Catalog type like iceberg,hive etc
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get spark engine
GET /spark_engines/{id}
Get spark engine by ID
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
actions
array
Actions
associated_catalogs
array
Catalogs to be Associated to the engine.
build_version
string
watsonx.data build version
configuration
SparkEngineDetails
Spark engine configuration details
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Information on the Spark engine.
display_name
string
Engine display name
id
string
Engine id
mode
string
Mode of spark engine
origin
string
Origin - created or registered
status
string
Status of engine
tags
array
Tags
type
string
Type of spark engine
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Delete spark engine
DELETE /spark_engines/{id}
Delete a spark engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine.delete
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update spark engine
PATCH /spark_engines/{id}
Update details of spark engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Update Engine Body
Path Parameters
Query Parameters
Response
200 - Success
actions
array
Actions
associated_catalogs
array
Catalogs to be Associated to the engine.
build_version
string
watsonx.data build version
configuration
SparkEngineDetails
Spark engine configuration details
created_at
integer
Created time in epoch format
created_by
string
Username of the user who created the watsonx.data instance
description
string
Information on the Spark engine.
display_name
string
Engine display name
id
string
Engine id
mode
string
Mode of spark engine
origin
string
Origin - created or registered
status
string
Status of engine
tags
array
Tags
type
string
Type of spark engine
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get spark engine catalogs
GET /spark_engines/{id}/catalogs
Get list of all catalogs attached to a spark engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_catalog.list
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
catalogs
array
List of catalogs
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Associate catalogs to spark engine
POST /spark_engines/{id}/catalogs
Associate one or more catalogs to a spark engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_catalog.add
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
Query Parameters
Response
201 - Success
catalogs
array
List of catalogs
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Disassociate catalogs from a spark engine
DELETE /spark_engines/{id}/catalogs
Disassociate one or more catalogs from a spark engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_catalog.remove
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
catalog_names
Required *
string
Catalog id(s) to be stopped, comma separated
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Pause engine
POST /spark_engines/{id}/pause
Pause engine. this feature is only available in SAAS
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine.pause
Auditing
Calling this method generates the following auditing event.
Request
Request Body
PauseSparkEnginePrototype
Pause spark engine parameters
force
boolean
force spark engine pause. Default value is false.
Response
202 - Accepted
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Resume engine. This feature is only available in SAAS
POST /spark_engines/{id}/resume
Resume engine. This feature is only available in SAAS
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine.resume
Auditing
Calling this method generates the following auditing event.
Request
Response
202 - Accepted
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Scale engine. This feature is only available in SAAS
POST /spark_engines/{id}/scale
Scale engine. This feature is only available in SAAS
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine.scale
Auditing
Calling this method generates the following auditing event.
Request
Request Body
SparkEngineScalePrototype
Scale spark application parameters
number_of_nodes
integer
Node count
Response
202 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get spark engine application details
GET /spark_engines/{engine_id}/applications/{id}
Get spark engine application details
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_application.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
application_details
SparkApplicationDetails
Application details
auto_termination_time
string
Time when the application is automatically stopped. This property is available only in SAAS
creation_time
string
Time when the application request was accepted. Software only.
deploy_mode
string
Deployment mode
end_time
string
End Time
failed_time
string
Failed time
finish_time
string
Time when the application finished running or was stopped. This property is available only after the application finishes running.
id
string
Application ID
init_scripts
array
Initialization scripts to run before the application starts
max_retries
string
Maximum number of retries for the application. Supported only in watsonx.data software
min_retry_interval_in_seconds
string
Minimum retry interval in seconds between retry attempts. Supported only in watsonx.data software
retry_attempt
string
Current retry attempt number
runtime
SparkApplicationRuntime
Application runtime configuration
spark_application_id
string
Spark application ID
spark_application_name
string
Spark application name
spark_ui
string
Spark UI Endpoint
spark_version
string
Included if spark_version was specified in application creation request or a default value was set in spark engine details.
start_time
string
Time when the application started running. This property is available only if/after the application starts running.
state
string
Application state
state_details
array
Application state details
submission_time
string
Time when the request was accepted. SAAS only.
template_id
string
Image template id based on spark version. Software only
wxd_application_ui_endpoint
string
Wxd history_server endpoint
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Stop Spark Applications
DELETE /spark_engines/{engine_id}/applications/{id}
Stop a running spark application
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_application.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Redirect to spark UI
GET /spark_engines/{engine_id}/applications/{id}/ui
Redirect to spark UI
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_application.ui
Auditing
Calling this method generates the following auditing event.
Request
Response
301 - Permanent redirection
302 - Temporary login redirection
400 - Invalid Request
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error.
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List all applications in a spark engine
GET /spark_engines/{id}/applications
List all applications in a spark engine
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_application.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
state
array
state
submission_time_interval
string
Submission time interval in <lower timestamp limit>,<upper timestamp limit> format
start_time_interval
string
Start time interval in <lower timestamp limit>,<upper timestamp limit> format
end_time_interval
string
End time interval in <lower timestamp limit>,<upper timestamp limit> format
limit
integer
limit to specify the rows
start
string
Token used to fetch the next or the previous page of the applications list
Response
200 - Success
applications
array
Application body
first
PaginationLink
Link to a page of results
limit
integer
The number of items returned per page
next
PaginationLink
Link to a page of results
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Create spark engine application
POST /spark_engines/{id}/applications
Create spark engine application
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_application.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
SparkEngineApplicationPrototype
Create spark application parameters
application_details
Required *
SparkApplicationDetails
Application details
application
Required *
string
Path/URL for the application script or jar file. The file can be in object storage or in a mounted volume (volumes available only in software).
archives
string
Comma separated list of zip file paths in object storage or volumes. These files will be extracted and loaded into the working directory of all executor nodes of the Spark cluster created to run this application.
arguments
array
List of arguments. This should be set if the application script requires any arguments.
conf
object
Default Spark configuration properties to be updated. To remove a property, set its value to null.
env
object
Default Spark configuration properties to be updated. To remove a property, set its value to null.
files
string
Comma separated list of file paths in object storage or volumes. These files will be loaded into the working directory of all executor nodes of the Spark cluster created to run this application.
jars
string
Comma separated list for file paths for jars in object storage or volumes. These files will be loaded into the classpath of executor and driver nodes of the Spark application cluster. This should be set only if the application is a jar file and if you want to satisfy third party library dependencies of the application via these jars.
name
string
Display name of the spark application
packages
string
Comma separated list of package identifiers that recognizable by maven. These packages will be downloaded from default maven repo or any additional maven repositories that you may have specified in the request. Applicable only for java/scala applications.
repositories
string
Comma separated list of maven repository urls. In addition to default maven repo, the repositories specified here will be used to search for any specified packages. Applicable only for java/scala applications.
runtime
object
Application runtime configuration
spark_version
string
Spark Version
callback
SparkEngineApplicationCallback
Spark Engine Application Callback
url
string
callback url
context_id
string
GUID
context_type
string
type of context for the spark application
deploy_mode
string
mode
idempotency_key
string
Unique key to ensure idempotent operation
init_scripts
array
Initialization scripts to run before the application starts
job_endpoint
string
Job endpoint
max_retries
string
Maximum number of retries for the application. Supported only in watsonx.data software
min_retry_interval_in_seconds
string
Minimum retry interval in seconds between retry attempts. Supported only in watsonx.data software
service_instance_id
string
Service Instance ID for POST
timeout_in_seconds
string
Timeout for the application in seconds
type
string
Engine Type
volumes
array
Spark application volumes to mount. This property is applicable only in watsonx.data software.
Response
200 - Success
auto_termination_time
string
Time when the application is automatically stopped. This property is available only in SAAS
creation_time
string
Time when the application request was accepted. Software only.
deploy_mode
string
Deployment mode
end_time
string
End Time
failed_time
string
Failed time
finish_time
string
Time when the application finished running or was stopped. This property is available only after the application finishes running.
id
string
Application ID
idempotency_key
string
Unique key to ensure idempotent operation
init_scripts
array
Initialization scripts to run before the application starts
max_retries
string
Maximum number of retries for the application. Supported only in watsonx.data software
min_retry_interval_in_seconds
string
Minimum retry interval in seconds between retry attempts. Supported only in watsonx.data software
retry_attempt
string
Current retry attempt number. Supported only in watsonx.data software
runtime
SparkApplicationRuntime
Application runtime configuration
spark_application_id
string
Spark application ID
spark_application_name
string
Spark application name
spark_ui
string
Spark UI Endpoint
spark_version
string
Included if spark_version was specified in application creation request or a default value was set in spark engine details.
start_time
string
Time when the application started running. This property is available only if/after the application starts running.
state
string
Application state
state_details
array
Application state details
submission_time
string
Time when the request was accepted. SAAS only.
template_id
string
Image template id based on spark version. Software only
timeout_in_seconds
string
Timeout for the application in seconds
wxd_application_ui_endpoint
string
Wxd history_server endpoint
201 - Success
auto_termination_time
string
Time when the application is automatically stopped. This property is available only in SAAS
creation_time
string
Time when the application request was accepted. Software only.
deploy_mode
string
Deployment mode
end_time
string
End Time
failed_time
string
Failed time
finish_time
string
Time when the application finished running or was stopped. This property is available only after the application finishes running.
id
string
Application ID
idempotency_key
string
Unique key to ensure idempotent operation
init_scripts
array
Initialization scripts to run before the application starts
max_retries
string
Maximum number of retries for the application. Supported only in watsonx.data software
min_retry_interval_in_seconds
string
Minimum retry interval in seconds between retry attempts. Supported only in watsonx.data software
retry_attempt
string
Current retry attempt number. Supported only in watsonx.data software
runtime
SparkApplicationRuntime
Application runtime configuration
spark_application_id
string
Spark application ID
spark_application_name
string
Spark application name
spark_ui
string
Spark UI Endpoint
spark_version
string
Included if spark_version was specified in application creation request or a default value was set in spark engine details.
start_time
string
Time when the application started running. This property is available only if/after the application starts running.
state
string
Application state
state_details
array
Application state details
submission_time
string
Time when the request was accepted. SAAS only.
template_id
string
Image template id based on spark version. Software only
timeout_in_seconds
string
Timeout for the application in seconds
wxd_application_ui_endpoint
string
Wxd history_server endpoint
202 - Success
auto_termination_time
string
Time when the application is automatically stopped. This property is available only in SAAS
creation_time
string
Time when the application request was accepted. Software only.
deploy_mode
string
Deployment mode
end_time
string
End Time
failed_time
string
Failed time
finish_time
string
Time when the application finished running or was stopped. This property is available only after the application finishes running.
id
string
Application ID
idempotency_key
string
Unique key to ensure idempotent operation
init_scripts
array
Initialization scripts to run before the application starts
max_retries
string
Maximum number of retries for the application. Supported only in watsonx.data software
min_retry_interval_in_seconds
string
Minimum retry interval in seconds between retry attempts. Supported only in watsonx.data software
retry_attempt
string
Current retry attempt number. Supported only in watsonx.data software
runtime
SparkApplicationRuntime
Application runtime configuration
spark_application_id
string
Spark application ID
spark_application_name
string
Spark application name
spark_ui
string
Spark UI Endpoint
spark_version
string
Included if spark_version was specified in application creation request or a default value was set in spark engine details.
start_time
string
Time when the application started running. This property is available only if/after the application starts running.
state
string
Application state
state_details
array
Application state details
submission_time
string
Time when the request was accepted. SAAS only.
template_id
string
Image template id based on spark version. Software only
timeout_in_seconds
string
Timeout for the application in seconds
wxd_application_ui_endpoint
string
Wxd history_server endpoint
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get Spark history server details
GET /spark_engines/{id}/history_server
Get Spark history server details
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_history_server.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
auto_termination_time
string
The time when the Spark history server will automatically stop. Applicable only in SAAS.
cores
string
CPU cores allocated for the history server. Available when the history server is running.
memory
string
Memory allocated for the history server. Kubernetes memory units are used. Available when the history server is running
start_time
string
History server start time
state
string
History server state
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Start spark history server
POST /spark_engines/{id}/history_server
Start spark history server
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_history_server.start
Auditing
Calling this method generates the following auditing event.
Request
Request Body
SparkHistoryServerPrototype
Start history server parameter
cores
string
CPU cores to be allocated to the history server.
memory
string
Memory to be allocated for the history server. Kuberneted memory unit (G) must also be specified.
Response
201 - Success
auto_termination_time
string
The time when the Spark history server will automatically stop. Applicable only in SAAS.
cores
string
CPU cores allocated for the history server. Available when the history server is running.
memory
string
Memory allocated for the history server. Kubernetes memory units are used. Available when the history server is running
start_time
string
History server start time
state
string
History server state
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Stop spark history server
DELETE /spark_engines/{id}/history_server
Stop spark history server
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_history_server.stop
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Redirect to spark history server UI
GET /spark_engines/{id}/history_server/ui
Redirect to spark history server UI
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.spark_engine_history_server.ui
Auditing
Calling this method generates the following auditing event.
Request
Response
301 - Permanent redirection
302 - Temporary login redirection
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Add/Create HDFS storage
POST /storage_hdfs_registrations
Add or create a new HDFS database
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.storage_hdfs_registration.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Path Parameters
Query Parameters
Response
201 - Success
actions
array
Actions
associated_catalog
StorageCatalog
storage catalog
created_at
string
Creation date
created_by
string
Username who created the HDFS storage
description
string
HDFS description
display_name
string
HDFS storage display name
id
string
HDFS Storage ID auto generated during registration
managed_by
string
managed by
state
string
mark hdfs active or inactive
tags
array
tags
type
string
HDFS type
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get list of storage registrations
GET /storage_registrations
Get list of storage registrations
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.storage_registration.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
Query Parameters
Response
200 - Success
storage_registrations
array
Storages
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Register storage
POST /storage_registrations
Register a new storage
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.storage_registration.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
StorageRegistrationPrototype
Request body
associated_catalog
StorageCatalogPrototype
storage catalog
base_path
string
catalog base path
catalog_name
string
catalog name
catalog_tags
Required *
array
catalog tags
catalog_type
string
catalog type
connection
StorageDetails
storage details
access_key
string
Access key ID, encrypted during storage registration
access_key_vault
object
secret details
account_name
string
actual storage name
application_id
string
Application Id for storage registration
auth_mode
string
auth mode
container_name
string
actual container name
directory_id
string
Directory Id for storage registration
endpoint
string
Cos endpoint
key_file
string
Key file, encrypted during storage registration
name
string
actual storage name
provider
string
storage provider
region
string
Region where the storage is located
role_arn
string
arn role
sas_token
string
sas token, encrypted during storage registration
secret_key
string
Secret access key, encrypted during storage registration
secret_key_vault
object
secret details
vault_enabled
boolean
vault enabled or not
description
Required *
string
storage description
display_name
Required *
string
Storage display name
managed_by
Required *
string
managed by
region
string
Region where the storage is located
storage_use
string
parameter to show whether the bucket is of acl or qhmm use. Allowed values are qhmm or acl
tags
array
tags
type
Required *
string
storage type
Path Parameters
Query Parameters
Response
201 - Success
actions
array
Actions
associated_catalogs
array
associated catalogs
connection
StorageDetails
storage details
created_at
string
Creation date
created_by
string
Username of the user who created the storage
description
string
storage description
display_name
string
Storage display name
id
string
storage ID auto generated during storage registration
managed_by
string
managed by
region
string
Region where the storage is located
state
string
Mark storage as active or inactive
storage_use
string
parameter to show whether the bucket is of acl or qhmm use
system_storage_update_credentials
boolean
Boolean value to specify whether updating HMAC credentials for internal system storage
tags
array
tags
associated_catalog
StorageCatalogPrototype
storage catalog
type
string
storage type
vault_enabled
boolean
Boolean value to specify whether vault enabled or not
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get storage
GET /storage_registrations/{id}
Get a registered storage
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.storage_registration.get
Auditing
Calling this method generates the following auditing event.
Request
Response
200 - Success
actions
array
Actions
associated_catalogs
array
associated catalogs
connection
StorageDetails
storage details
created_at
string
Creation date
created_by
string
Username of the user who created the storage
description
string
storage description
display_name
string
Storage display name
id
string
storage ID auto generated during storage registration
managed_by
string
managed by
region
string
Region where the storage is located
state
string
Mark storage as active or inactive
storage_use
string
parameter to show whether the bucket is of acl or qhmm use
system_storage_update_credentials
boolean
Boolean value to specify whether updating HMAC credentials for internal system storage
tags
array
tags
associated_catalog
StorageCatalogPrototype
storage catalog
type
string
storage type
vault_enabled
boolean
Boolean value to specify whether vault enabled or not
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Unregister Storage
DELETE /storage_registrations/{id}
Unregister a storage
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.storage_registration.delete
Auditing
Calling this method generates the following auditing event.
Request
Response
204 - No Content
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Update storage
PATCH /storage_registrations/{id}
Update storage details & credentials
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.storage_registration.update
Auditing
Calling this method generates the following auditing event.
Request
Request Body
Request body
Path Parameters
Query Parameters
Response
200 - Success
actions
array
Actions
associated_catalogs
array
associated catalogs
connection
StorageDetails
storage details
created_at
string
Creation date
created_by
string
Username of the user who created the storage
description
string
storage description
display_name
string
Storage display name
id
string
storage ID auto generated during storage registration
managed_by
string
managed by
region
string
Region where the storage is located
state
string
Mark storage as active or inactive
storage_use
string
parameter to show whether the bucket is of acl or qhmm use
system_storage_update_credentials
boolean
Boolean value to specify whether updating HMAC credentials for internal system storage
tags
array
tags
associated_catalog
StorageCatalogPrototype
storage catalog
type
string
storage type
vault_enabled
boolean
Boolean value to specify whether vault enabled or not
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Add storage catalog
POST /storage_registrations/{storage_id}/catalogs
Add storage catalog
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.catalog.create
Auditing
Calling this method generates the following auditing event.
Request
Request Body
StorageCatalogPrototype
Request body
base_path
string
catalog base path
catalog_name
string
catalog name
catalog_tags
Required *
array
catalog tags
catalog_type
string
catalog type
Path Parameters
Query Parameters
Response
201 - Success
message
string
Message
message_code
string
Message code
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
Get storage object properties
POST /storage_registrations/{storage_id}/object_properties
Get storage object properties
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.storage.object.properties
Auditing
Calling this method generates the following auditing event.
Request
Request Body
StorageObjectSize
Request body
paths
array
storage object size
Path Parameters
Query Parameters
Response
201 - Success
object_properties
array
muliple storage object properties
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
List storage objects
GET /storage_registrations/{storage_id}/objects
Fetch all objects from a given storage
Authorization
To call this method, you must be assigned one or more IAM access roles that include the following action.
lakehouse.storage_registration_object.list
Auditing
Calling this method generates the following auditing event.
Request
Path Parameters
storage_id
Required *
string
storage id
Query Parameters
path
string
path
paginated
boolean
data to be paginated or not
page_size
integer
The number of items per page (default is 1000 , max 1000)
prefix
string
prefix to filter the objects by.
start_after
string
StartAfter is where you want Amazon S3 to start listing from.
Response
200 - Success
objects
array
storage object
400 - Error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
401 - Unauthorized
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
403 - Forbidden
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
404 - Not found
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.
500 - Internal server error
errors
array
The array of error entries associated with the error response
exception
string
String representation of the error
message
string
Error message
message_code
string
Error code
more_info
string
publicly-accessible URL where information about the error can be read
status_code
integer
Http error code
trace
string
The error trace information.