Request a new access token
POST /auth/tokens
Authenticates the user credentials and returns an access token that can be used when invoking the operations.
Request
Request Body
UserCredentials
User credentials
userid
Required *
string
The user's ID
password
Required *
string
The user's password
Response
200 - Authentication token
userid
string
User ID associated with the generated token.
token
string
Token string that can be used in subsequent requests that require authentication.
401 - Invalid credentials
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns public key of Json Web Token
GET /auth/token/publickey
Returns public key of Json Web Token.
Request
Response
200 - Token public key and key id.
kty
string
Public key type.
e
string
Exponent of public key.
kid
string
Key ID of public key.
alg
string
Algorithm of public key.
n
string
Modulus of public key.
Perform logout operation for a token
DELETE /auth/token/logout
Perform logout operation for a token.
Request
Response
200 - Logout successfully.
default - Error payload
Creates a new authentication policy ADMIN ONLY
POST /auth_policies
Creates a new authentication policy which can be used to control password parameters.
Request
Request Body
Response
201 - Authentication policy created
count
integer
Number of elements
resources
array
List of active connections
403 - Only administrators can execute this operation
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Lists all authentication policies ADMIN ONLY
GET /auth_policies
Returns a list of authentication policies.
Request
Response
200 - List of authentication policies
403 - Only administrators can execute this operation
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns an authentication policy ADMIN ONLY
GET /auth_policies/{id}
Returns an authentication policy.
Request
Path Parameters
id
Required *
string
policy ID
Query Parameters
Response
200 - Authentication policy
id
string
Policy ID.
name
string
A display name for the policy.
password_history
integer
Number of previously used passwords kept in the history. When a user changes its password, the new password is rejected if it is found in the history. If set to 0 no password history is maintained.
password_expiration
integer
Number of days a password is valid for. After this period, login attempts will be rejected and the users will be required to change their password. If set to 0 passwords will never expire.
failed_login_attempts
integer
Number of failed logins before the user account is locked. If set to 0 the account is not locked and any number of consecutive invalid login attempts are allowed.
lockout_duration
integer
Number of minutes an account will be locked after too many failed login attempts. After this period the account will be automatically unlocked. It must be a number greater than zero. This parameter has no effect if failed_login_attempts is set to zero.
min_password_length
integer
Minimum number of characters for passwords
metadata
ResourceMetadata
Meta information of an resource. Metadata is ready-only and values are auto-generated by the system.
403 - Only administrators can execute this operation
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Policy not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Updates an authentication policy ADMIN ONLY
PUT /auth_policies/{id}
Updates an authentication policy.
Request
Request Body
Path Parameters
id
Required *
string
policy ID
Query Parameters
Response
200 - Authentication policy
id
string
Policy ID.
name
string
A display name for the policy.
password_history
integer
Number of previously used passwords kept in the history. When a user changes its password, the new password is rejected if it is found in the history. If set to 0 no password history is maintained.
password_expiration
integer
Number of days a password is valid for. After this period, login attempts will be rejected and the users will be required to change their password. If set to 0 passwords will never expire.
failed_login_attempts
integer
Number of failed logins before the user account is locked. If set to 0 the account is not locked and any number of consecutive invalid login attempts are allowed.
lockout_duration
integer
Number of minutes an account will be locked after too many failed login attempts. After this period the account will be automatically unlocked. It must be a number greater than zero. This parameter has no effect if failed_login_attempts is set to zero.
min_password_length
integer
Minimum number of characters for passwords
metadata
ResourceMetadata
Meta information of an resource. Metadata is ready-only and values are auto-generated by the system.
403 - Only administrators can execute this operation
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Policy not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
DELETE /auth_policies/{id}
Deletes an existing policy.
Only administratos can delete policies.
Request
Path Parameters
id
Required *
string
ID of the policy to be deleted.
Query Parameters
Response
200 - Policy deleted
403 - Removal of this policy is not allowed
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - The policy does not exist
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Sets a new password using dswebToken
PUT /auth/password
Sets a new password using the dswebToken obtained from /auth/reset.
Request
Request Body
UserPasswordReset
New password and dswebToken
password
Required *
string
New password
dswebToken
Required *
string
dswebToken received by email
Response
200 - Password changed
code
string
status code
400 - Invalid or missing new password
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - If dswebToken is missing or invalid
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Requests a password reset based on user's email
POST /auth/reset
An email is sent with the password reset link and code. To set a new password, the user can open the link on a web browser, or use the /auth/password endpoint providing the dswebToken. The dswebToken is valid for 12 hours.
Request
Request Body
UserPasswordResetRequest
User's email address and ID
Required *
string
Email address that will receive the password reset instructions and dswebToken
userId
Required *
string
User ID
Response
202 - Request accepted
code
string
status code
400 - Invalid or missing email address and userId
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - The user name and email address do not match.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Lists all schemas in the database
GET /schemas
Returns a list of schemas.
Request
Response
200 - List of schemas
default - Error payload
Returns schema information
GET /schemas/{schema_name}
Returns schema information.
Request
Path Parameters
schema_name
Required *
string
Schema name
Query Parameters
Response
200 - Schema information
name
string
The schema name
404 - Schema not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Lists tables in a schema
GET /schemas/{schema_name}/tables
Returns the list of tables in a schema.
Request
Path Parameters
schema_name
Required *
string
Schema name
Query Parameters
Response
200 - List of tables
count
integer
Number of elements
resources
array
List of tables
404 - Database or schema not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns information about a table
GET /schemas/{schema_name}/tables/{table_name}
Return information about a table.
Request
Path Parameters
schema_name
Required *
string
Schema name
table_name
Required *
string
Table name
Query Parameters
Response
200 - Table information
name
string
The table name
schema
string
The schema name
comments
string
User provided comments
columns
array
status
string
It can assume values
stats
object
404 - Table not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Deletes all table data
DELETE /schemas/{schema_name}/tables/{table_name}/data
Deletes all table data using a TRUNCATE operation.
Request
Path Parameters
schema_name
Required *
string
Schema name
table_name
Required *
string
Table name
Query Parameters
Response
200 - Success
403 - Not authorized to access table data
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Table not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query the list of object schemas
GET /admin/schemas/obj_type/{obj_type}
Query the list of object schemas.
Request
Path Parameters
obj_type
Required *
string
Object type.
Query Parameters
search_name
string
Object type.
show_systems
string
Whether to show system objects.
rows_return
string
The amount of return records.
Response
200 - Query the list of object schemas.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Create schema
POST /admin/schemas
Creates a new schema. Any user with enough database authority can create schemas using dbapi directly. Regular users can create new schemas indirectly by creating a new table or other database object and specifying the name of the new schema where the object will be placed.
Request
Request Body
CreateSchemaReqBody
name
Required *
string
Schema name.
authorization
string
Authorization ID.
Response
201 - Schema created.
name
string
The schema name
400 - Invalid parameters or schema already exists
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Only administrators can create schemas directly.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Drops an empty schema
DELETE /admin/schemas
Drops an empty schema. An error is returned if the schema contains any objects.
Request
Request Body
DropSchemaReqBody
Response
200 - The schema was dropped successfully.
status
string
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get single object privilege
GET /admin/privileges
Get single object privilege.
Request
Path Parameters
Query Parameters
obj_type
Required *
string
Object type.
schema
string
Schema name of the object. For table and database, this parameter is not required.
obj_name
string
Name of the object. For database, this parameter is not required.
rows_return
string
The amount of return records.
Response
200 - Get object privilege.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Privilege list of selected objects
POST /admin/privileges
Privilege list of selected objects.
Request
Request Body
privilegsReqBody
obj_type
string
rows_return
integer
filter
array
Response
200 - Privilege list of selected objects
400 - Get error when search authid
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Grant or revoke privileges
PUT /admin/privileges
Grant or revoke privileges
Request
Request Body
privilegesChangeReqBody
stop_on_error
boolean
privileges
array
Response
200 - The status of grant or revoke
status
string
400 - Get error when grant or revoke
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Generate schema DDL
POST /admin/schemas/ddl
Generate schema DDL.
Request
Request Body
GenerateSchemaDDLReqBody
objects
array
Only when the action is more, this parameter is needed.
options
array
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - depobj = Generates the basic DDL statements. - privilege = Generate the authorization DDL statements such as GRANT statements.
stat_terminator
string
Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Path Parameters
Query Parameters
action
Required *
string
Type of operation.
Response
200 - Generate schema DDL.
commands
string
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Create a new table
PUT /admin/tables
Create a new table.
Request
Request Body
CreateAlterTableReqBody
schema
string
Schema name of the object.
table
string
Unqualified name of the object.
column_info
array
Response
201 - The table was created successfully.
status
string
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Drop table
DELETE /admin/tables
Drop table.
Request
Request Body
DropTableReqBody
Response
200 - The alias was dropped successfully.
status
string
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get table definition
GET /admin/schemas/{schema_name}/tables/{table_name}/definition
Get table definition.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
table_name
Required *
string
Table name.
Query Parameters
Response
200 - Get table definition.
schema
string
Table schema.
comments
string
stats
ObjectStatus
columns
array
name
string
Table name.
status
string
Status of the object.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query table data
GET /admin/schemas/{schema_name}/tables/{table_name}/data
Fetches the table data up to a maximum of 100,000 rows. Currently it's not possible to retrieve data from tables that contain CLOB, BLOB or DBCLOB values.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
table_name
Required *
string
Table name.
Query Parameters
rows_return
integer
The amount of return records.
Response
200 - Returned result was successful.
columns
array
Column definitions
rows
array
Table rows
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get column detail properties
GET /admin/schemas/{schema_name}/tables/{table_name}/columns/{column_name}/properties
Get column detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
table_name
Required *
string
Table name.
column_name
Required *
string
Column name.
Query Parameters
Response
200 - Get column detail properties.
column_name
string
Name of the column.
table_name
string
Unqualified name of the table, view, or nickname that contains the column.
table_schema
string
Schema name of the table, view, or nickname that contains the column.
type_name
string
Unqualified name of the data type for the column.
length
string
Maximum length of the data; 0 for distinct types.
scale
string
Scale if the column type is DECIMAL or number of digits of fractional seconds if the column type is TIMESTAMP; 0 otherwise.
nulls
string
Nullability attribute for the column.
default
string
Default value for the column of a table expressed as a constant, special register, or cast-function appropriate for the data type of the column. Can also be the keyword NULL. Values might be converted from what was specified as a default value. For example, date and time constants are shown in ISO format, cast-function names are qualified with schema names, and identifiers are delimited. Null value if a DEFAULT clause was not specified or the column is a view column.
logged
string
Whether the column is logged.
compact
string
Whether the column is compacted.
compress
string
Compress.
identity
string
Identity.
generated
string
Type of generated column.
row_change_timestamp
string
Row change timestamp.
start
string
Start value of the sequence. The null value if the sequence is an alias.
increment
string
Increment value. The null value if the sequence is an alias.
min_value
string
Minimum value of the sequence. The null value if the sequence is an alias.
max_value
string
Maximum value of the sequence. The null value if the sequence is an alias.
cycle
string
Indicates whether or not the sequence can continue to generate values after reaching its maximum or minimum value.
cache
string
Number of sequence values to pre-allocate in memory for faster access. 0 indicates that values of the sequence are not to be preallocated. In a partitioned database, this value applies to each database partition. -1 if the sequence is an alias.
order
string
Indicates whether or not the sequence numbers must be generated in order of request.
inline_length
string
Maximum size in bytes of the internal representation of an instance of an XML document, a structured type, or a LOB data type, that can be stored in the base table; 0 when not applicable.
primary_key
string
Whether it is a primary key.
part_key_seq
string
The column's numerical position within the table's distribution key; 0 or the null value if the column is not in the distribution key. The null value for columns of subtables and hierarchy tables.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the metadata type
GET /admin/tables/meta/datatype
Get the metadata type.
Request
Response
200 - Get the metadata type.
default - Error payload
Generate table DDL
POST /admin/tables/ddl
Generate table DDL.
Request
Request Body
GenerateTableDDLReqBody
schema
string
Schema name of the object. Only When the action is create or alter, this parameter is needed.
table
string
Unqualified name of the object. Only When the action is create or alter, this parameter is needed.
column_info
array
Only When the action is create or alter, this parameter is needed.
objects
array
Only when the action is more, this parameter is needed.
options
array
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - create = Generates DDL statements with the CREATE OR REPLACE clause. - creatorname:creatorID = Generates DDL statements for objects that were created with the specified creator ID. - depobj = Generates the basic DDL statements - view = Generate the CREATE VIEW DDL statements - privilege = Generate the authorization DDL statements such as GRANT statements.
stat_terminator
string
Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Path Parameters
Query Parameters
action
Required *
string
Type of operation.
Response
200 - Generate table DDL.
commands
string
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get distributin keys
GET /admin/schemas/{schema_name}/tables/{table_name}/distribution_keys
Get distributin keys.
Request
Path Parameters
schema_name
Required *
string
Schema name of the table.
table_name
Required *
string
Name of the table.
Query Parameters
Response
200 - Get distributin keys.
partition_mode
string
Indicates how data is distributed among database partitions in a partitioned database system.
keys
array
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get data distributin property
GET /admin/schemas/{schema_name}/tables/{table_name}/distributions/properties
Get data distributin property.
Request
Path Parameters
schema_name
Required *
string
Schema name of the table.
table_name
Required *
string
Name of the table.
Query Parameters
Response
200 - Get data distributin property.
primary_distribution_key
PrimaryDistributionKey
skew_data
SkewData
Table row counts.
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get partition expressions
GET /admin/schemas/{schema_name}/tables/{table_name}/partitions/expressions
Get partition expressions.
Request
Path Parameters
schema_name
Required *
string
Schema name of the table.
table_name
Required *
string
Name of the table.
Query Parameters
Response
200 - Get partition expressions.
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get data partitions
GET /admin/schemas/{schema_name}/tables/{table_name}/partitions
Get data partitions.
Request
Path Parameters
schema_name
Required *
string
Schema name of the table.
table_name
Required *
string
Name of the table.
Query Parameters
Response
200 - Get data partitions.
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query view detail properties
GET /admin/schemas/{schema_name}/views/{view_name}/properties
Query view detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the view.
view_name
Required *
string
Name of the view.
Query Parameters
Response
200 - Query view detail properties.
view_name
string
Unqualified name of the view.
view_schema
string
Schema name of the view.
view_check
string
View check.
read_only
string
Whether it is read-only.
valid
string
Whether it is valid.
optimize_query
string
Whether to optimize the query.
owner
string
Authorization ID of the owner of the view.
owner_type
string
Owner type.
create_time
string
Time at which the object was created.
alter_time
string
Time at which the object was last altered.
stats_time
string
Time at which any change was last made to recorded statistics for this object. The null value if statistics are not collected.
sql
string
Full text of the view CREATE statement, exactly as typed.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Drop views
DELETE /admin/views
Drop views.
Request
Request Body
DropViewReqBody
Response
200 - The alias was dropped successfully.
status
string
400 - Run sql exception.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query view data
GET /admin/schemas/{schema_name}/views/{view_name}/data
Query view data.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
view_name
Required *
string
View name.
Query Parameters
rows_return
integer
The amount of return records.
Response
200 - Returned result was successful.
columns
array
rows
array
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get View definition
GET /admin/schemas/{schema_name}/views/{view_name}/definition
Get view definition.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
view_name
Required *
string
View name.
Query Parameters
Response
200 - Get View definition.
schema
string
View schema.
comments
string
stats
ObjectStatus
columns
array
name
string
View name.
status
string
Status of the object.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Generate view DDL
POST /admin/views/ddl
Generate view DDL.
Request
Request Body
GenerateViewDDLReqBody
schema
string
Schema name. Only When the action is create or alter, this parameter is needed.
view
string
View name. This parameter is required to modify the view.
objects
array
Only when the action is more, this parameter is needed.
options
array
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - create = Generates DDL statements with the CREATE OR REPLACE clause. - creatorname:creatorID = Generates DDL statements for objects that were created with the specified creator ID. - depobj = Generates the basic DDL statements - privilege = Generate the authorization DDL statements such as GRANT statements.
stat_terminator
string
Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Path Parameters
Query Parameters
action
Required *
string
Type of operation.
Response
200 - Generate view DDL.
commands
string
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the dependencies of the object
GET /admin/schemas/{schema_name}/{obj_type}/{object_name}/dependencies
Get the dependencies of the object.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
obj_type
Required *
string
Type of object.
object_name
Required *
string
Name of the object.
Query Parameters
Response
200 - Get the dependencies of the object.
references
array
dependencies
array
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the dependencies of the tablespace
GET /admin/tablespaces/{tablespace}/dependencies
Get the dependencies of the tablespace.
Request
Path Parameters
tablespace
Required *
string
Tablespace name.
Query Parameters
Response
200 - Get the dependencies of the object.
references
array
dependencies
array
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query bufferpool detail properties
GET /admin/bufferpools/{bufferpool_name}/properties
Query bufferpool detail properties.
Request
Path Parameters
bufferpool_name
Required *
string
Name of the object.
Query Parameters
Response
200 - Returned result was successful.
bufferpool_name
string
Name of the buffer pool.
automatic
string
Whether the buffer pool is automatically managed by DB2.
block_size
string
Number of pages in a block.
npages
string
Default number of pages in this buffer pool on database partitions in this database partition group.
num_block_pages
string
Number of pages of the buffer pool that are to be in a block-based area. A block-based area of the buffer pool is only used by prefetchers doing a sequential prefetch.
page_size
string
Page size for this buffer pool on database partitions in this database partition group.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query constraint detail properties
GET /admin/schemas/{schema_name}/tables/{table_name}/constraints/{constraint_name}/properties
Query constraint detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
table_name
Required *
string
Table name.
constraint_name
Required *
string
Name of the constraint.
Query Parameters
Response
200 - Returned result was successful.
constraint_name
string
Name of the constraint.
table_name
string
Unqualified name of the table to which this constraint applies.
table_schema
string
Schema name of the table to which this constraint applies.
type
string
Indicates the constraint type.
ref_member
string
Referencing key.
ref_table_name
string
Referencing table.
ref_table_schema
string
Referencing schema.
enforced
string
Whether it is a enforce constraint.
member
string
Members.
update_rule
string
Update rule.
delete_rule
string
Delete rule.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query index detail properties
GET /admin/schemas/{schema_name}/tables/{table_name}/indexes/{index_name}/properties
Query index detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
table_name
Required *
string
Table name.
index_name
Required *
string
Name of the index.
Query Parameters
Response
200 - Returned result was successful.
index_name
string
Unqualified name of the index.
index_schema
string
Schema name of the index.
member
string
Name of the column.
table_name
string
Unqualified name of the table or nickname on which the index is defined.
table_schema
string
Schema name of the table or nickname on which the index is defined.
table_space
string
Name of the table space.
index_type
string
Type of index.
unique
string
Whether it is unique.
cluster
string
Whether it is a clustering index
compression
string
Specifies whether index compression is activated
reverse_scans
string
Whether the index supports reverse scanning
percent_free
string
Percentage of each index page to be reserved during the initial building of the index.
level2pctfree
string
Percentage of each index level 2 page to be reserved during initial building of the index.
owner
string
Authorization ID of the owner of the index.
owner_type
string
Owner type.
system_generated
string
Whether it is system generated.
create_time
string
Time when the index was created.
last_used
string
Date when the index was last used by any DML statement to perform a scan, or used to enforce referential integrity constraints. This column is not updated when the index is used on an HADR standby database, nor is it updated when rows are inserted into the table on which the index is defined. The default value is '0001-01-01'. This value is updated asynchronously not more than once within a 24 hour period and might not reflect usage within the last 15 minutes.
stats_time
string
Last time that any change was made to the recorded statistics for this index. The null value if no statistics are available.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query trigger detail properties
GET /admin/schemas/{schema_name}/triggers/{trigger_name}/properties
Query trigger detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
trigger_name
Required *
string
Name of the trigger.
Query Parameters
Response
200 - Returned result was successful.
trigger_name
string
Unqualified name of the trigger.
table_name
string
Unqualified name of the table or view to which this trigger applies.
table_schema
string
Schema name of the table or view to which this trigger applies.
trigger_schema
string
Schema name of the trigger.
trigger_time
string
Time at which triggered actions are applied to the base table, relative to the event that fired the trigger.
trigger_event
string
Event that fires the trigger.
granularity
string
evel of granularity.
valid
string
Whether the trigger is valid.
secure
string
Indicates whether the trigger is secure for row and column access control.
text
string
Full text of the CREATE TRIGGER statement, exactly as typed.
remarks
string
User-provided comments, or the null value.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query MQT detail properties
GET /admin/schemas/{schema_name}/mqts/{mqt_name}/properties
Query MQT detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
mqt_name
Required *
string
Name of the MQT.
Query Parameters
Response
200 - Returned result was successful.
table_name
string
Unqualified name of the materialized query table.
table_schema
string
Schema name of the materialized query table.
tablespace
string
Name of the primary table space for the table.
index_tablespace
string
Name of the table space that holds all indexes created on this table.
long_tablespace
string
Name of the table space that holds all long data (LONG or LOB column types) for this table.
owner
string
Authorization ID of the owner of the materialized query table.
owner_type
string
Owner type.
table_org
string
Table organization.
value_compression
string
Compression mode for the table.
row_compression
string
Row compression mode for the table.
refresh
string
Refresh mode.
pctfree
string
Percentage of each page to be reserved for future inserts.
drop_rule
string
Drop rule.
volatile
string
Volatile.
append_mode
string
For row-organized tables, controls how rows are inserted into pages.
data_capture
string
Data capture.
lock_size
string
Indicates the preferred lock granularity for tables that are accessed by data manipulation language (DML) statements.
not_logged_initially
string
Specifies whether the created temporary table is logged.
refresh_time
string
For REFRESH = 'D' or 'O', time at which the data was last refreshed (REFRESH TABLE statement); null value otherwise.
create_time
string
Time at which the object was created.
alter_time
string
Time at which the object was last altered.
stats_time
string
Time at which any change was last made to recorded statistics for this object. The null value if statistics are not collected.
maintained_by
string
Properties for a table.
sql
string
Full text of the materialized query table CREATE statement, exactly as typed.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query UDF detail properties
GET /admin/schemas/{schema_name}/functions/{specific_name}/properties
Query UDF detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
specific_name
Required *
string
Name of the UDF.
Query Parameters
Response
200 - Returned result was successful.
udf_name
string
Name of the UDF.
udf_schema
string
Schema name of the UDF.
text
string
The full text of the CREATE FUNCTION statement.
specific_name
string
Name of the routine instance (might be system-generated).
language
string
Implementation language for the routine body (or for the source function body, if this function is sourced on another function).
parameter_style
string
Parameter style that was declared when the routine was created.
sql_data_access
string
Indicates what type of SQL statements, if any, the database manager should assume is contained in the routine.
deterministic
string
Whether the result is deterministic.
external_action
string
Whether the function has external side-effects.
commit_on_return
string
Indicates whether the transaction is committed on successful return from this procedure.
parallel
string
Whether the routine can be executed in parallel.
fenced
string
Indicates if there is a fence.
implementation
string
Implementation
owner
string
Authorization ID of the owner.
owner_type
string
Owner type.
create_time
string
Time at which the object was created.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query tablespace detail properties
GET /admin/tablespaces/{table_space}/properties
Query tablespace detail properties.
Request
Path Parameters
table_space
Required *
string
Tablespace name of the object.
Query Parameters
Response
200 - Returned result was successful.
tablespace_name
string
Name of the table space.
db_partition_group
string
Name of the database partition group that is associated with this table space.
buffer_pool_name
string
Name of the buffer pool.
storage_group_name
string
Name of the storage group the table space is using.
tbspace_data_type
string
Type of data that can be stored in this table space.
tablespace_type
string
Type of table space.
reclaimable
string
Indicates if it is reclaimable.
drop_recovery
string
Indicates whether or not tables in this table space can be recovered after a drop table operation.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query procedure detail properties
GET /admin/schemas/{schema_name}/procedures/{specific_name}/properties
Query procedure detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
specific_name
Required *
string
Name of the procedure.
Query Parameters
Response
200 - Returned result was successful.
stored_procedure_name
string
Name of the procedure.
stored_procedure_schema
string
Schema name of the procedure.
text
string
The full text of the CREATE PROCEDURE statement.
specific_name
string
Name of the routine instance (might be system-generated).
language
string
Implementation language for the routine body (or for the source function body, if this function is sourced on another function).
parameter_style
string
Parameter style that was declared when the routine was created.
sql_data_access
string
Indicates what type of SQL statements, if any, the database manager should assume is contained in the routine.
deterministic
string
Whether the result is deterministic.
external_action
string
Whether the function has external side-effects.
commit_on_return
string
Indicates whether the transaction is committed on successful return from this procedure.
parallel
string
Whether the routine can be executed in parallel.
fenced
string
Indicates if there is a fence.
implementation
string
Implementation.
owner
string
Authorization ID of the owner.
owner_type
string
Owner type.
create_time
string
Time at which the object was created.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query sequence detail properties
GET /admin/schemas/{schema_name}/sequences/{sequence_name}/properties
Query sequence detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
sequence_name
Required *
string
Name of the sequence.
Query Parameters
Response
200 - Returned result was successful.
sequence_name
string
Unqualified name of the sequence.
sequence_schema
string
Schema name of the sequence.
type_name
string
Unqualified name of the data type.
precision
string
Precision of the data type of the sequence.
start
string
Start value of the sequence.
increment
string
Increment value.
min_value
string
Maximum value of the sequence.
max_value
string
Minimum value of the sequence.
cycle
string
Indicates whether or not the sequence can continue to generate values after reaching its maximum or minimum value.
cache
string
Number of sequence values to pre-allocate in memory for faster access.
order
string
Indicates whether or not the sequence numbers must be generated in order of request.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query package detail properties
GET /admin/schemas/{schema_name}/packages/{package_name}/properties
Query package detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
package_name
Required *
string
Name of the package.
Query Parameters
Response
200 - Returned result was successful.
package_name
string
Unqualified name of the package.
package_schema
string
Schema name of the package.
default_schema
string
Default schema name used for unqualified names in static SQL statements.
bound_by
string
Authorization ID of the binder and owner of the package.
owner
string
Authorization ID of the binder and owner of the package.
blocking
string
Cursor blocking option.
total_sect
string
Number of sections in the package.
query_opt
string
Optimization class under which this package was bound. Used for rebind operations.
explain_snapshot
string
Value of the EXPLSNAP bind option.
func_path
string
SQL path in effect when the package was bound.
statement
string
Text of the SQL statement.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query UDT detail properties
GET /admin/schemas/{schema_name}/udts/{type_name}/properties
Query UDT detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
type_name
Required *
string
Name of the user-defined type.
Query Parameters
Response
200 - Returned result was successful.
type_name
string
Unqualified name of the data type.
type_schema
string
Schema name of the module to which the data type belongs.
length
string
Maximum length of the type.
scale
string
Scale for distinct types or reference representation types based on the built-in DECIMAL type; the number of digits of fractional seconds for distinct types based on the built-in TIMESTAMP type; 6 for the built-in TIMESTAMP type; 0 for all other types (including DECIMAL itself).
source_name
string
For distinct types or array types, the unqualified name of the source data type. For user-defined structured types, the unqualified built-in type name of the reference representation type. Null for other data types.
source_schema
string
For distinct types or array types, the schema name of the source data type. For user-defined structured types, the schema name of the built-in type of the reference representation type. Null for other data types.
meta_type
string
Meta type.
remarks
string
User-provided comments
instantiable
string
Indicates whether the type can be instantiated.
final
string
Indicates whether the user-defined type can have subtypes.
inline_length
string
Maximum length of a structured type that can be kept with a base table row; 0 otherwise.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query alias detail properties
GET /admin/schemas/{schema_name}/aliases/{alias_name}/properties
Query alias detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
alias_name
Required *
string
Alias name.
Query Parameters
Response
200 - Query alias detail properties.
alias_name
string
Unqualified name of the object.
alias_schema
string
Schema name of the object.
base_obj_name
string
The name of the object referenced by the alias.
base_obj_schema
string
The schema name of the object referenced by the alias.
owner
string
Authorization ID of the owner.
owner_type
string
Owner type.
create_time
string
Time at which the object was created.
alter_time
string
Time at which the object was last altered.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Schema or alias not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get table detail properties
GET /admin/schemas/{schema_name}/tables/{table_name}/properties
Get table detail properties.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
table_name
Required *
string
Table name.
Query Parameters
Response
200 - Get table detail properties.
table_name
string
Unqualified name of the object.
table_schema
string
Schema name of the object.
obj_type
string
Type of object.
tablespace
string
Name of the primary table space for the table.
index_tablespace
string
Name of the table space that holds all indexes created on this table.
long_tablespace
string
Name of the table space that holds all long data (LONG or LOB column types) for this table.
table_org
string
Table organization.
temporal_type
string
Type of temporal table.
drop_rule
string
Drop rule.
volatile
string
Volatile.
value_compression
string
Compression mode for the table.
row_compression
string
Row compression mode for the table.
clustered
string
Clustered.
partition_mode
string
Indicates how data is distributed among database partitions in a partitioned database system.
avg_row_size
string
Average length (in bytes) of both compressed and uncompressed rows in this table; -1 if statistics are not collected.
table_status
string
Status of the object.
append_mode
string
For row-organized tables, controls how rows are inserted into pages.
primary_key
string
Primary key.
row_count
string
Total number of rows in the table; -1 if statistics are not collected.
create_time
string
Time at which the object was created.
last_used
string
Date when the table was last used by any DML statement or the LOAD command.
alter_time
string
Time at which the object was last altered.
stats_time
string
Time at which any change was last made to recorded statistics for this object. The null value if statistics are not collected.
pctfree
string
Percentage of each page to be reserved for future inserts.
data_capture
string
Data capture.
lock_size
string
Indicates the preferred lock granularity for tables that are accessed by data manipulation language (DML) statements.
not_logged_initially
string
Specifies whether the created temporary table is logged.
owner
string
Authorization ID of the owner.
owner_type
string
Owner type.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Object not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Create alias
PUT /admin/aliases
Create alias.
Request
Request Body
AliasObject
base_obj_schema
string
The schema of the object based.
base_obj_name
string
The name of the object based.
alias_name
string
Alias name.
alias_schema
string
Alias schema.
Response
200 - The alias was created successfully.
status
string
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Drop alias
DELETE /admin/aliases
Drop alias.
Request
Request Body
DropAliasArray
Response
200 - The alias was dropped successfully.
status
string
400 - Invalid parameters or run sql exception.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Generate Alias DDL
POST /admin/aliases/ddl
Generate Alias DDL.
Request
Request Body
GenerateAliasDDLReqBody
base_obj_schema
string
The schema of the object based. Only When the action is create, this parameter is needed.
base_obj_name
string
The name of the object based. Only When the action is create, this parameter is needed.
alias_name
string
Alias name. Only When the action is create, this parameter is needed.
alias_schema
string
Alias schema. Only When the action is create, this parameter is needed.
objects
array
Only when the action is more, this parameter is needed.
options
array
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - create = Generates DDL statements with the CREATE OR REPLACE clause. - creatorname:creatorID = Generates DDL statements for objects that were created with the specified creator ID. - depobj = Generates the basic DDL statements - view = Generate the CREATE VIEW DDL statements - privilege = Generate the authorization DDL statements such as GRANT statements.
stat_terminator
string
Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Path Parameters
Query Parameters
action
Required *
string
Type of operation.
Response
200 - Generate Alias DDL.
commands
string
400 - Invalid parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query alias data
GET /admin/schemas/{schema_name}/aliases/{alias_name}/data
Query alias data.
Request
Path Parameters
schema_name
Required *
string
Schema name of the object.
alias_name
Required *
string
Alias name.
Query Parameters
rows_return
integer
The amount of return records.
Response
200 - Returned result was successful.
columns
array
rows
array
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Schema or alias not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the SQL statement template for creating MQT table
POST /admin/mqts/ddl
Get the SQL statement template for creating MQT table.
Request
Request Body
GenerateMQTDDLReqBody
schema
string
Schema name of the object. Only When the action is create, this parameter is needed.
objects
array
Only when the action is more, this parameter is needed.
options
array
The options used to generate DDL. Select 0 or one or several options. Only when the action is more, this parameter is needed. - create = Generates DDL statements with the CREATE OR REPLACE clause. - creatorname:creatorID = Generates DDL statements for objects that were created with the specified creator ID. - depobj = Generates the basic DDL statements - view = Generate the CREATE VIEW DDL statements - privilege = Generate the authorization DDL statements such as GRANT statements.
stat_terminator
string
Specifies the statement delimiter for SQL statements that are generated. Only when the action is more, this parameter is needed.
Path Parameters
Query Parameters
action
Required *
string
Response
200 - The SQL statement of creating MQT table
commands
string
400 - Get error when create MQT table
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Delete mqt tables
DELETE /admin/mqts
Delete mqt tables.
Request
Request Body
deleteMqtReqBody
Response
200 - The status of deleting MQT tables
status
string
400 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the definition of MQT table
GET /admin/schemas/{schema_name}/mqts/{mqt_name}/definition
Get the definition of MQT table.
Request
Path Parameters
schema_name
Required *
string
Schema name
mqt_name
Required *
string
mqt name
Query Parameters
Response
200 - Definition of MTQ table
schema
string
comments
string
stats
adminStats
columns
array
name
string
status
string
400 - Error information when get mqt definition
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the data of specified mqt table
GET /admin/schemas/{schema_name}/mqts/{mqt_name}/data
Get the data of specified mqt table.
Request
Path Parameters
schema_name
Required *
string
mqt_name
Required *
string
Query Parameters
rows_return
integer
Response
200 - Get the data of MQT table,include table columns information and data
columns
array
rows
array
400 - Error information when get mqt data
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get authentications through the authid filter
GET /admin/privileges/authentications
Get authentications through the authid filter
Request
Path Parameters
Query Parameters
rows_return
integer
0 means return all query results
authid
Required *
string
Response
200 - The list of authid and authid type
400 - Get error when search authid
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the privieles of auth id
GET /admin/privileges/{authid_type}/{authid}/{obj_type}
Get the privieles of auth id
Request
Path Parameters
authid_type
Required *
string
authid type
authid
Required *
string
Authorization id.
obj_type
Required *
string
Type of object
Query Parameters
rows_return
integer
Response
200 - Returned result was successful.
400 - Get error when get privileges
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get SQL statement of grant or revoke privileges
POST /admin/privileges/dcl
Get SQL statement of grant or revoke privileges
Request
Request Body
privilegesChangeDclReqBody
Response
201 - SQL statement for grant or revoke privileges
commands
string
400 - Get error when get privileges
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Add new role
POST /admin/privileges/roles
Add new role
Request
Request Body
rolesReqBody
authid
string
Response
201 - The status of adding new role
status
string
400 - Get error when add new roles
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Grant or revoke the privilges of role
PUT /admin/privileges/roles
Grant or revoke the privilges of role
Request
Request Body
privilegesChangeRoleReqBody
stop_on_error
boolean
privileges
array
Response
200 - The status of grant or revoke the role's privileges
status
string
400 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Delete one role
DELETE /admin/privileges/roles/{role_name}
Delete one role
Request
Path Parameters
role_name
Required *
string
Query Parameters
Response
200 - The status of deleting one role
status
string
400 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the membership of authid
GET /admin/privileges/roles/{authid_type}/{authid}
Get the membership of authid
Request
Path Parameters
authid_type
Required *
string
authid type
authid
Required *
string
authid
Query Parameters
rows_return
Required *
integer
Response
200 - The membership of one auth
400 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get SQL statement of grant or revoke role
POST /admin/privileges/roles/dcl
Get SQL statement of grant or revoke role
Request
Request Body
privilegesChangeRoleDclReqBody
Response
201 - The SQL statement of grant or revoke role
commands
string
400 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get SQL statement for grant or revoke privileges
POST /admin/privileges/multiple_objtypes/dcl
Get SQL statement for grant or revoke privileges
Request
Request Body
PrivilegesMultipleObjectTypeChangeDclReqBody
grantee
array
privileges
array
Response
201 - The SQL statement for grant or revoke privileges
commands
string
400 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Grant or revole privileges for multiple objects and objects type
PUT /admin/privileges/multiple_objtypes
Grant or revole privileges for multiple objects and objects type
Request
Request Body
PrivilegesMultipleObjectTypeChangeReqBody
grantee
array
privileges
array
stop_on_error
boolean
Response
200 - The status of grant or revoke privileges
status
string
400 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the SQL statement for grant or revoke multiple roles
POST /admin/privileges/multiple_roles/dcl
Get the SQL statement for grant or revoke multiple roles
Request
Request Body
privilegesMultipleRolesChangeDclReqBody
Response
201 - The SQL statement for grant or revoke multiple roles
commands
string
400 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Grant or revoke multiple roles
PUT /admin/privileges/multiple_roles
Grant or revoke multiple roles
Request
Request Body
privilegesMultipleRolesChangeReqBody
privileges
array
stop_on_error
boolean
Response
200 - The status of grant or revoke roles
status
string
400 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Error payload
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Generate workload DDL
POST /admin/workloads/ddl
Generate workload DDL.
Request
Request Body
CreateWorkloadsReqBody
categorization
string
Type of the connection attribute.
enable_coll_act_data
boolean
Enable collect activity data or not.
Path Parameters
Query Parameters
action
Required *
string
Type of operation.
Response
200 - Return the ddl of creating workloads.
commands
string
400 - Invalid parameters or miss some parameters
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Lists workloads
GET /admin/workloads
Returns the list of workloads.
Request
Path Parameters
Query Parameters
rows_return
string
The amount of return records.
search_name
string
Workload name.
Response
200 - Return the list of workloads
default - Error payload
Drop sequences
DELETE /admin/sequences
Drop sequences
Request
Request Body
sequencesDropList
Response
200 - The status of dropping sequences
status
string
400 - Faile to drop sequences
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Drop procedures
DELETE /admin/procedures
Drop procedures
Request
Request Body
ProceduresDropReqBody
Response
200 - Delete procedure successfully
status
string
400 - Faile to drop procedures
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Retrieve parameters for procedure
GET /admin/schemas/{schema_name}/procedures/{specific_name}/parameters
Retrieve parameters for procedure.
Request
Path Parameters
schema_name
Required *
string
The schema name of the procedure
specific_name
Required *
string
The specificname of procedure
Query Parameters
Response
200 - Retrieve parameters for procedure.
400 - Error information when get procedure parameters.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Generate create procedure template
POST /admin/procedures/ddl
Request
Request Body
CreateProceduresTemplate
schema
string
The schema name of procedure.
Path Parameters
Query Parameters
action
Required *
string
Response
200 - Generate the template of creating procedure
commands
string
400 - Faile to generate create procedure template
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Drop functions
DELETE /admin/functions
Drop functions
Request
Request Body
DropFunctionsReqBody
Response
200 - Delete function successfully
status
string
400 - Faile to drop functions
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Retrieve parameters for specific udf
GET /admin/schemas/{schema_name}/functions/{specific_name}/parameters
Retrieve parameters for specific udf.
Request
Path Parameters
schema_name
Required *
string
The schema name of the function.
specific_name
Required *
string
The specific name of function.
Query Parameters
Response
200 - Retrieve parameters for specific udf.
400 - Error information when get procedure parameters
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Generate create function template
POST /admin/functions/ddl
Request
Request Body
CreateFunctionTemplateReqBody
schema
string
The schema name of function.
Path Parameters
Query Parameters
action
Required *
string
Response
200 - Generate the template of creating function.
commands
string
400 - Faile to generate create function template.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - SQLException
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Drop User-defined Types
DELETE /admin/udts
Drop User-defined Types
Request
Request Body
DropUDTArray
Response
200 - The UDTs was dropped successfully.
status
string
400 - Invalid parameters or run sql exception.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Retrieve row definition for User-defined Type object
GET /admin/schemas/{schema_name}/udts/{udt_name}/definition
Retrieve row definition for User-defined Type object
Request
Path Parameters
schema_name
Required *
string
The schema name of User-defined Type.
udt_name
Required *
string
The name of User-defined Type.
Query Parameters
Response
200 - Retrieve row definition for User-defined Type object.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Schema or alias not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Generate Create User-defined Types template
POST /admin/udts/ddl
Generate Create User-defined Types template.
Request
Request Body
UDTDDLReqBody
schema
string
Schema name of UDT.
Path Parameters
Query Parameters
action
Required *
string
Type of operation.
Response
200 - Generate Create User-defined Types template.
commands
string
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Schema or alias not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Query the list of tablespace
GET /admin/tablespaces
Query the list of tablespace.
Request
Path Parameters
Query Parameters
search_name
string
Tablespace name.
rows_return
string
The amount of return records.
Response
200 - Query the list of tablespace.
result
array
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Drop tablespaces
DELETE /admin/tablespaces
Drop tablespaces.
Request
Request Body
DropTablespaceObject
tablespaces
array
Tablespace name.
Response
200 - The tablespaces was dropped successfully.
result
array
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the I/O settings of the tablespace
GET /admin/tablespaces/{tablespace}/iosetting
Get the I/O settings of the tablespace.
Request
Path Parameters
tablespace
Required *
string
Tablespace name.
Query Parameters
Response
200 - Get the I/O settings of the tablespace.
file_caching
string
File system caching.
overhead
string
Controller overhead and disk seek and latency time, in milliseconds (average for the containers in this table space).
transfer_rate
string
Time to read one page of size PAGESIZE into the buffer (average for the containers in this table space).
data_tag
string
A tag to identify data stored in this table space.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the tablespace size
GET /admin/tablespaces/{tablespace}/size
Get the tablespace size.
Request
Path Parameters
tablespace
Required *
string
Tablespace name.
Query Parameters
Response
200 - Get the tablespace size.
file_caching
string
File system caching.
overhead
string
Controller overhead and disk seek and latency time, in milliseconds (average for the containers in this table space).
transfer_rate
string
Time to read one page of size PAGESIZE into the buffer (average for the containers in this table space).
data_tag
string
A tag to identify data stored in this table space.
403 - Not authorized.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Generates a new Aspera token
POST /aspera
Aspera is a high-speed file transfer technology that can be used to speed up file uploads to Db2 Warehouse on Cloud. This endpoint generates a new token that must be used when uploading files with Aspera.
Request
Response
201 - Aspera token
aspera_token
string
Token string that should be used when uploading files with Aspera.
userid
string
User ID associated with the Aspera token.
default - Error payload
Deletes an Aspera token
DELETE /aspera/{token}
Deletes an Aspera token. You should delete a token after the upload is complete. Optionally provide the name of a file that was uploaded using Aspera to prepare it for loading.
Request
Path Parameters
token
Required *
string
Aspera token
Query Parameters
filename
string
Name of file that was uploaded
Response
200 - Success
404 - Token or file not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns metadata of an item in the user's home storage
GET /home/{path}
Returns metadata of an item files and folders stored in the user's home storage. Only support file with suffix '.csv','.txt','dat' and 'del'.
Request
Path Parameters
path
Required *
string
Path of a file or folder
Query Parameters
Response
200 - Metadata about a file or folder
location
string
Relative URL path for this file or folder.
size
integer
Size in bytes. The size of a folder is the sum of the files directly under it, excluding subfolders.
contents
array
List of files and folders
404 - File or folder not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Deletes a file in the user's home storage
DELETE /home/{path}
Deletes a file in the user's home storage
Request
Path Parameters
path
Required *
string
File path
Query Parameters
Response
200 - File deleted
default - Error payload
Download file from user's home storage
GET /home_content/{path}
Download file from user's home storage.
Request
Path Parameters
path
Required *
string
File path
Query Parameters
Response
200 - Metadata about a file or folder
location
string
Relative URL path for this file or folder.
size
integer
Size in bytes. The size of a folder is the sum of the files directly under it, excluding subfolders.
contents
array
List of files and folders
404 - File not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Uploads a file to the user's home storage
POST /home_content/{path}
Uploads a file to a folder under the user's home storage. The target folder is automatically created if it does not exit.
Request
Path Parameters
path
Required *
string
Target folder
Query Parameters
Response
201 - Files successfully uploaded
default - Error payload
Creates a data load job, load uses external table technology
POST /load_jobs_ET
Creates a data load job
Request
Request Body
ETDataLoadJobRequest
Data load job details
load_source
Required *
string
Type of data source. It can take the values 'SERVER', 'S3', or 'IBMCloud'.
load_action
string
If set to 'INSERT' data is appended to the existing table data. If set to 'REPLACE' the table data is replaced with the data being loaded.
schema
Required *
string
Schema name where the target table is located
table
Required *
string
Table name where data should be loaded
max_row_count
integer
Maximum number of rows to be loaded. If set to zero or not specified, all rows from the source data are loaded. Not supported in multi-partitioned (MPP) Db2 Warehouse on Cloud environments.
max_warning_count
integer
Maximum number of warnings that are tolerated before failing the load operation. A warning is generated for each row that is not loaded correctly.
auto_create_table
object
When set to execute, the source data is analyzed to discover the data types of each column. Then the target table is created using the columns and data types found. Currently, this option is only allowed when load_source is set to SERVER.
execute
Required *
string
column_names
array
Optional list of column names for the target table. When not provided, the system will auto-generate the column names.
cloud_source
object
Required when load_type is set to "S3" or "SOFTLAYER". It specifies how to located the data to be loaded from a cloud storage service.
endpoint
Required *
string
URL of the cloud storage endpoint where data is located. Amazon S3 valid endpoints are "s3.amazonaws.com", "s3.us-east-2.amazonaws.com", "s3-us-west-1.amazonaws.com, "s3-us-west-2.amazonaws.com", "s3.ca-central-1.amazonaws.com", "s3.ap-south-1.amazonaws.com", "s3.ap-northeast-2.amazonaws.com", "s3-ap-southeast-1.amazonaws.com", "s3-ap-southeast-2.amazonaws.com", "s3-ap-northeast-1.amazonaws.com", "s3.eu-central-1.amazonaws.com", "s3-eu-west-1.amazonaws.com", "s3.eu-west-2.amazonaws.com", "s3-sa-east-1.amazonaws.com". SoftLayer object storage valid endpoints are "https://ams01.objectstorage.softlayer.net/auth/v1.0", "https://che01.objectstorage.softlayer.net/auth/v1.0", "https://dal05.objectstorage.softlayer.net/auth/v1.0", "https://fra02.objectstorage.softlayer.net/auth/v1.0", "https://hkg02.objectstorage.softlayer.net/auth/v1.0", "https://lon02.objectstorage.softlayer.net/auth/v1.0", "https://mel01.objectstorage.softlayer.net/auth/v1.0", "https://mex01.objectstorage.softlayer.net/auth/v1.0", "https://mil01.objectstorage.softlayer.net/auth/v1.0", "https://mon01.objectstorage.softlayer.net/auth/v1.0", "https://par01.objectstorage.softlayer.net/auth/v1.0", "https://sao01.objectstorage.softlayer.net/auth/v1.0", "https://seo01.objectstorage.softlayer.net/auth/v1.0", "https://sjc01.objectstorage.softlayer.net/auth/v1.0", "https://sng01.objectstorage.softlayer.net/auth/v1.0", "https://syd01.objectstorage.softlayer.net/auth/v1.0", "https://tok02.objectstorage.softlayer.net/auth/v1.0", "https://tor01.objectstorage.softlayer.net/auth/v1.0", "https://wdc.objectstorage.softlayer.net/auth/v1.0".
path
Required *
string
Path used to find and retrieve the data in the cloud storage service
auth_id
Required *
string
Username (SoftLayer) or Access Key (S3).
auth_secret
Required *
string
API Key (SoftLayer) or Secret Key (S3).
server_source
object
Required when load_type is set to "SERVER". It specifies how to source filein the server.
file_path
Required *
string
File path in the server relative to the user's home folder.
file_options
Required *
object
Modifies how the source data should be interpreted
encoding
string
UTF8 The file uses UTF8 encoding and contains only NCHAR or NVARCHAR data. LATIN9 The file uses LATIN9 encoding and contains only CHAR or VARCHAR data. INTERNAL The file uses a mixture of both UTF8 and LATIN9 encoding, or you are unsure which type of encoding is used. The system checks the data and encodes the data as needed. Because this checking of the data reduces overall performance, use this value only when necessary. This is the default.
code_page
string
The character encoding of the source file. Valid values are listed in <a target="_blank" href="https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/com.ibm.db2.luw.admin.nls.doc/doc/r0004565.html">Supported territory codes and code pages </a>. Default value is 1208 (corresponds to UTF-8).The code_page and ENCODING options are mutually exclusive
has_header_row
string
Specifies whether or not the source file includes column names in a header row.
column_delimiter
string
Single character used as column delimiter. Default value is comma (","). The character can also be specified using the format 0xJJ, where JJ is the hexadecimal representation of the character. Valid delimiters can be hexadecimal values from 0x00 to 0x7F, except for binary zero (0x00), line-feed (0x0A), carriage return (0x0D), space (0x20), and decimal point (0x2E).
string_delimiter
string
NO, SINGLE or DOUBLE, refer to <a target="_blank" href="http://leto.svl.ibm.com/kc/SS6NHC_next/com.ibm.swg.im.dashdb.sql.ref.doc/doc/r_create_ext_table.html">string_delimiter</a>
date_style
string
Refer to <a target="_blank" href="http://leto.svl.ibm.com/kc/SS6NHC_next/com.ibm.swg.im.dashdb.sql.ref.doc/doc/r_create_ext_table.html">date_style</a>
time_style
string
Refer to <a target="_blank" href="http://leto.svl.ibm.com/kc/SS6NHC_next/com.ibm.swg.im.dashdb.sql.ref.doc/doc/r_create_ext_table.html">time_style</a>
date_delimiter
string
Refer to <a target="_blank" href="http://leto.svl.ibm.com/kc/SS6NHC_next/com.ibm.swg.im.dashdb.sql.ref.doc/doc/r_create_ext_table.html">date_delimiter</a>
date_format
string
The format of the date field in the data file. The value can be any of the date format strings that are accepted by the <a target="_blank" href="http://leto.svl.ibm.com/kc/SS6NHC_next/com.ibm.swg.im.dashdb.sql.ref.doc/doc/r0007107.html%23r0007107">TIMESTAMP_FORMAT scalar function</a>. The default is YYYY-MM-DD. The DATE_FORMAT option and the DATEDELIM or DATESTYLE option are mutually exclusive.
time_format
string
The format of the time field in the data file. The value can be any of the time format strings that are accepted by the <a target="_blank" href="http://leto.svl.ibm.com/kc/SS6NHC_next/com.ibm.swg.im.dashdb.sql.ref.doc/doc/r0007107.html%23r0007107">TIMESTAMP_FORMAT scalar function</a>. The default is HH.MI.SS. The TIME_FORMAT option and a TIMEDELIM or TIMESTYLE option are mutually exclusive.
timestamp_format
string
The format of the timestamp field in the data file. The value can be any of the format strings that are accepted by the <a target="_blank" href="http://leto.svl.ibm.com/kc/SS6NHC_next/com.ibm.swg.im.dashdb.sql.ref.doc/doc/r0007107.html%23r0007107">TIMESTAMP_FORMAT scalar function</a>. The default is 'YYYY-MM-DD HH.MI.SS'. The TIMESTAMP_FORMAT option and the TIMEDELIM, DATEDELIM, TIMESTYLE, or DATESTYLE option are mutually exclusive.
bool_style
string
ignore_zero
string
Whether the byte value zero in a CHAR or VARCHAR field is to be ignored, TRUE or ON The byte value zero is ignored. FALSE or OFF The byte value zero is not ignored. This is the default.
require_quotes
string
Whether quotation marks are mandatory, TRUE or ON, Quotation marks are mandatory. The QUOTEDVALUE option must be set to YES, SINGLE, or DOUBLE. FALSE or OFF Quotation marks are not mandatory. This is the default.
ctrl_chars
string
Whether to allow an ASCII value 1 - 31 in a CHAR or VARCHAR field. Any NULL, CR, or LF characters must be escaped. Allowed values are, TRUE or ON An ASCII value 1 - 31 in a CHAR or VARCHAR field is allowed. FALSE or OFF An ASCII value 1 - 31 in a CHAR or VARCHAR field is not allowed. This is the default.
escape_char
string
Which character is to be regarded as an escape character. An escape character indicates that the character that follows it, which would otherwise be treated as a field-delimiter character or end-of-row sequence character, is instead treated as part of the value in the field. The escape character is ignored for graphic-string data. There is no default.
Response
201 - load jobs.
default - Error payload
Lists all data load jobs, load uses Db2 load utility technology
GET /load_jobs
Lists all data load jobs for the user.
Request
Response
200 - Data load jobs
default - Error payload
Creates a data load job
POST /load_jobs
Creates a data load job
Request
Request Body
DataLoadJobRequest
Data load job details
load_source
Required *
string
Type of data source. It can take the values 'SERVER', 'S3', or 'IBMCloud'.
load_action
string
If set to 'INSERT' data is appended to the existing table data. If set to 'REPLACE' the table data is replaced with the data being loaded.
schema
Required *
string
Schema name where the target table is located
table
Required *
string
Table name where data should be loaded
max_row_count
integer
Maximum number of rows to be loaded. If set to zero or not specified, all rows from the source data are loaded. Not supported in multi-partitioned (MPP) Db2 Warehouse on Cloud environments.
max_warning_count
integer
Maximum number of warnings that are tolerated before failing the load operation. A warning is generated for each row that is not loaded correctly.
auto_create_table
object
When set to execute, the source data is analyzed to discover the data types of each column. Then the target table is created using the columns and data types found. Currently, this option is only allowed when load_source is set to SERVER.
execute
Required *
string
column_names
array
Optional list of column names for the target table. When not provided, the system will auto-generate the column names.
cloud_source
object
Required when load_type is set to "S3" or "SOFTLAYER". It specifies how to located the data to be loaded from a cloud storage service.
endpoint
Required *
string
URL of the cloud storage endpoint where data is located. Amazon S3 valid endpoints are "s3.amazonaws.com", "s3.us-east-2.amazonaws.com", "s3-us-west-1.amazonaws.com, "s3-us-west-2.amazonaws.com", "s3.ca-central-1.amazonaws.com", "s3.ap-south-1.amazonaws.com", "s3.ap-northeast-2.amazonaws.com", "s3-ap-southeast-1.amazonaws.com", "s3-ap-southeast-2.amazonaws.com", "s3-ap-northeast-1.amazonaws.com", "s3.eu-central-1.amazonaws.com", "s3-eu-west-1.amazonaws.com", "s3.eu-west-2.amazonaws.com", "s3-sa-east-1.amazonaws.com". SoftLayer object storage valid endpoints are "https://ams01.objectstorage.softlayer.net/auth/v1.0", "https://che01.objectstorage.softlayer.net/auth/v1.0", "https://dal05.objectstorage.softlayer.net/auth/v1.0", "https://fra02.objectstorage.softlayer.net/auth/v1.0", "https://hkg02.objectstorage.softlayer.net/auth/v1.0", "https://lon02.objectstorage.softlayer.net/auth/v1.0", "https://mel01.objectstorage.softlayer.net/auth/v1.0", "https://mex01.objectstorage.softlayer.net/auth/v1.0", "https://mil01.objectstorage.softlayer.net/auth/v1.0", "https://mon01.objectstorage.softlayer.net/auth/v1.0", "https://par01.objectstorage.softlayer.net/auth/v1.0", "https://sao01.objectstorage.softlayer.net/auth/v1.0", "https://seo01.objectstorage.softlayer.net/auth/v1.0", "https://sjc01.objectstorage.softlayer.net/auth/v1.0", "https://sng01.objectstorage.softlayer.net/auth/v1.0", "https://syd01.objectstorage.softlayer.net/auth/v1.0", "https://tok02.objectstorage.softlayer.net/auth/v1.0", "https://tor01.objectstorage.softlayer.net/auth/v1.0", "https://wdc.objectstorage.softlayer.net/auth/v1.0".
path
Required *
string
Path used to find and retrieve the data in the cloud storage service
auth_id
Required *
string
Username (SoftLayer) or Access Key (S3).
auth_secret
Required *
string
API Key (SoftLayer) or Secret Key (S3).
server_source
object
Required when load_type is set to "SERVER". It specifies how to source filein the server.
file_path
Required *
string
File path in the server relative to the user's home folder.
file_options
Required *
object
Modifies how the source data should be interpreted
code_page
string
The character encoding of the source file. Valid values are listed in <a target="_blank" href="https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/com.ibm.db2.luw.admin.nls.doc/doc/r0004565.html">Supported territory codes and code pages</a>. Default value is "1208" (corresponds to UTF-8).
has_header_row
string
Specifies whether or not the source file includes column names in a header row.
column_delimiter
string
Single character used as column delimiter. Default value is comma (","). The character can also be specified using the format 0xJJ, where JJ is the hexadecimal representation of the character. Valid delimiters can be hexadecimal values from 0x00 to 0x7F, except for binary zero (0x00), line-feed (0x0A), carriage return (0x0D), space (0x20), and decimal point (0x2E).
date_format
string
A valid date format, such as "DD-MM-YY", "YYYY-MMM-DD", "DD/MM/YYY", "M/D/YYYY", "M/DD", "YYYY". For a full list of supported formats, see <a target="_blank" href="https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/com.ibm.db2.luw.admin.cmd.doc/doc/r0008305.html">Valid file type modifiers for the load utility - ASCII file formats (ASC/DEL)</a>, in the LOAD command reference.
time_format
string
A valid time format, such as "HH-MM-SS", "H:MM:SS TT", "HH:MM", "H:MM TT", "H:M", "H:M:S". For a full list of supported formats, see <a target="_blank" href="https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/com.ibm.db2.luw.admin.cmd.doc/doc/r0008305.html">Valid file type modifiers for the load utility - ASCII file formats (ASC/DEL)</a>, in the LOAD command reference.
timestamp_format
string
A valid timestamp format, such as "YYYY-MM-DD HH:MM:SS", "DD/MM/YYYY H:MM TT", "MMM DD YYYY HH:MM:SS TT". For a full list of supported formats, see <a target="_blank" href="https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/com.ibm.db2.luw.admin.cmd.doc/doc/r0008305.html">Valid file type modifiers for the load utility - ASCII file formats (ASC/DEL)</a>, in the LOAD command reference.
Response
201 - load jobs.
default - Error payload
Returns details about a load job including its progress
GET /load_jobs/{id}
Returns details about a load job including its progress.
Request
Path Parameters
id
Required *
string
Load job ID
Query Parameters
Response
200 - Data load job
id
string
Load job ID
userid
string
User ID of who requested the load
status
DataLoadJobStatus
Execution status of a data load job
request
DataLoadJobRequest
Data load request
metadata
ResourceMetadata
Meta information of an resource. Metadata is ready-only and values are auto-generated by the system.
403 - Not authorized to access load job
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Job not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Removes load job from history
DELETE /load_jobs/{id}
Removes a data load job from history. This operation has no effect on the data already loaded. In-progress jobs cannot be deleted.
Request
Path Parameters
id
Required *
string
Load job ID
Query Parameters
Response
200 - Load job deleted
403 - Not authorized to delete load job
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Job not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Dowloads log file for a data load job
GET /load_jobs/{id}/log
Downloads log file for a data load job
Request
Path Parameters
id
Required *
string
Load job ID
Query Parameters
Response
200 - Log file
403 - Not authorized to access load log
404 - Log not found
default - Error payload
Analyzes CSV data to return a list of data types of its values
POST /schema_discovery
Schema discovery analyzes data in CSV format and returns a list of suggested data types that can be used when creating a table to store the CSV data.
Request
Request Body
SchemaDiscoveryCSVRequest
Data to analyze
column_separator
Required *
string
Single character can be used as column delimiter. The character can also be specified using the format 0xJJ, where JJ is the hexadecimal representation of the character. Valid delimiters can be hexadecimal values from 0x00 to 0x7F, except for binary zero (0x00), line-feed (0x0A), carriage return (0x0D), space (0x20), and decimal point (0x2E).
includes_header
Required *
string
Accepts values 'yes' and 'no'. The value 'yes' indicates the first row is a header with the column names and should be ignored whe analyzing the data. The value 'no' indicates all rows will be considered for analysis.
data
Required *
string
The CSV data to analyze. It should be in json array string format, such as ['Title, Year, Producer','City of God,2002, Katia Lund','Rain,1292,Christine Jeffs','2001: A Space Odyssey,1969, Stanley Kubrick'].
Response
200 - Suggested table schema
columns
array
dateStyle
string
External table option.
dateDelimiter
string
External table option.
timeStyle
string
External table option.
timeDelimiter
string
External table option.
default - Error payload
Executes SQL statements
POST /sql_jobs
Executes one or more SQL statements as a background job. This endpoint returns a job ID that can be used to retrieve the results.
Request
Request Body
SQLJobCreate
SQL script and execution options
commands
Required *
string
The SQL script to be executed
limit
Required *
integer
Maximum number of rows that will be fetched for each result set.
separator
Required *
string
SQL statement terminator. A character that is used to mark the end of a SQL statement when the provided SQL script contains multiple statements.
stop_on_error
Required *
string
If 'yes', the job stops executing at the first statement that returns an error. If 'no', the job continues executing if one or more statements returns an error.
Response
201 - SQL execution job
id
string
The SQL execution job ID
commands_count
integer
Number of SQL statements to be executed
limit
integer
Maximum number of rows that will be fetched for each result set
default - Error payload
Fetches partial results of a SQL job execution
GET /sql_jobs/{id}
Returns the current status of a SQL job execution along with any results of SQL statements that have already been executed. Clients are supposed to poll this endpoint until the status returned is either 'completed', which indicates all SQL statements have completed executing, or 'failed', which indicates the job failed to execute and therefore is considered terminated. The returned list of results is not cumulative. That means, results that were fetched in a previous call will not be returned again, only new results (i.e. that were not fetched yet) will be included. For example, assuming a job with 10 SQL statements, the first call returns status "running" and 6 results, the second call returns status "running" and an empty list of results, a third call status "completed" and 4 results. Any subsequent calls would return status "completed" and an empty list of results.
Request
Path Parameters
id
Required *
string
ID of the SQL execution job
Query Parameters
Response
200 - Result of a SQL job
id
string
The SQL execution job ID
status
string
Job status
results
array
default - Error payload
Returns the results of a SQL query to CSV
POST /sql_query_export
Executes the specified SQL query and returns the data as a CSV file. The amount of data returned is limited to 100,000 rows.
Request
Request Body
SQLStatement
The SQL query to be executed
command
Required *
string
The SQL statement to execute
Response
200 - CSV file containing query results
default - Error payload
Returns overall status of system components
GET /monitor
Returns overall status of system components.
Request
Path Parameters
Query Parameters
Response
200 - System status
403 - Operation is only available to administrators
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Lists active database connections DB ADMIN ONLY
GET /monitor/connections
Returns a list of active database connections.
Request
Path Parameters
Query Parameters
Response
200 - Active connections
count
integer
Number of elements
resources
array
List of active connections
403 - Operation is only available to administrators
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Terminates a database connection DB ADMIN ONLY
DELETE /monitor/connections/{application_handle}
Terminates an active database connection.
Request
Path Parameters
application_handle
Required *
string
Application handle name
Query Parameters
Response
200 - Connection terminated
403 - Operation is only available to administrators
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns current storage usage DB ADMIN ONLY
GET /monitor/storage
Returns current storage usage.
Request
Path Parameters
Query Parameters
Response
200 - Storage usage
name
string
Describes the storage unit.
capacity_kb
integer
Total capacity, reported in kilobytes.
used_kb
integer
Storage space in use, reported in kilobytes.
available_kb
integer
Storage space available, reported in kilobytes.
collected_at
string
When the metrics were collected.
default - Error payload
Returns storage usage history DB ADMIN ONLY
GET /monitor/storage/history
Returns a list of storage usage daily stats. Currenlty the history of the last seven days is returned.
Request
Path Parameters
Query Parameters
Response
200 - Storage usage history
count
integer
Number of elements
resources
array
List of elements
default - Error payload
Storage utilization by schema DB ADMIN ONLY
GET /monitor/storage/by_schema
Returns a list where each element represents a schema and its corresponding logical and physical sizes. Physical size is the amount of storage in disk allocated to objects in the schema. Logical size is the actual object size, which might be less than the physical size (e.g. in the case of a logical table truncation).
Request
Path Parameters
Query Parameters
Response
200 - Storage usage by schema
count
integer
Number of elements
resources
array
List of schema's storage usage data
403 - Operation is only available to administrators
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Storage utilization of a schema DB ADMIN ONLY
GET /monitor/storage/by_schema/{schema_name}
Returns logical and physical sizes for one schema. Physical size is the amount of storage in disk allocated to objects in the schema. Logical size is the actual object size, which might be less than the physical size (e.g. in the case of a logical table truncation).
Request
Path Parameters
schema_name
Required *
string
Schema name
Query Parameters
Response
200 - Storage usage for a schema
403 - Operation is only available to administrators
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Schema does not exist
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Return the number of statements for a specified time frame. DB ADMIN ONLY
GET /metrics/statements_count
Return the number of statements for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the number of statements for a specified time frame.
app_act_completed_total
integer
Number of statements.
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the histogram of response time for a specified time frame. DB ADMIN ONLY
GET /metrics/response_time_histograms
Return the histogram of response time for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the histogram of response time for a specified time frame
count
integer
Counts of matrices data.
histograms
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the average response time for a specified time frame. DB ADMIN ONLY
GET /metrics/average_response_time
Return the average response time for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the average response time for a specified time frame.
coord_act_lifetime_avg_ms
integer
Coord act average lifetime.
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the list of average response time for a specified time frame. DB ADMIN ONLY
GET /metrics/response_time
Return the list of average response time for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the list of average response time for a specified time frame.
count
integer
Counts of matrices data.
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the average number of statements executed every minutes for a specified time frame. DB ADMIN ONLY
GET /metrics/average_statements_rate
Return the average number of statements executed every minutes for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the average number of statements executed every minutes for a specified time frame
sqls_per_min
number
SQL rate(sqls/min).
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return numbers of statements executed every minutes for a specified time frame. DB ADMIN ONLY
GET /metrics/statements_rate
Return numbers of statements executed every minutes for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return numbers of statements executed every minutes for a specified time frame
count
integer
Counts of matrices data.
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the average number of rows read(rows/min) for a specified time frame. DB ADMIN ONLY
GET /metrics/average_rows_read
Return the average number of rows read(rows/min) for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the average number of rows read(rows/min) for a specified time frame.
rows_read_per_min
number
Rows read(rows/min).
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the numbers of rows read(rows/min) for a specified time frame. DB ADMIN ONLY
GET /metrics/rows_read
Return the numbers of rows read(rows/min) for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the numbers of rows read(rows/min) for a specified time frame.
count
integer
Counts of matrices data.
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the maximum number of concurrent connections for a specified time frame DB ADMIN ONLY
GET /metrics/max_connections_count
Return the maximum number of concurrent connections for a specified time frame
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the maximum number of concurrent connections for a specified time frame end
connections
integer
The maximum connections count.
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return maximum numbers of concurrent connections for a specified time frame. DB ADMIN ONLY
GET /metrics/connections_count
Return maximum numbers of concurrent connections for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return maximum numbers of concurrent connections for a specified time frame.
count
integer
Counts of matrices data.
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the maximum lockwaits per minute for a specified time frame. DB ADMIN ONLY
GET /metrics/max_lockwaits_rate
Return the maximum lockwaits per minute for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the maximum lockwaits per minute for a specified time frame
lock_waits_per_min
number
The maximum lockwaits rate(lockwaits/min).
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the maximum lockwaits per minute for a specified time frame. DB ADMIN ONLY
GET /metrics/lockwaits_rate
Return the maximum lockwaits per minute for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the maximum lockwaits per minute for a specified time frame.
count
integer
Lockwaits rate(lockwaits/min).
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the maximum usage percentage of logs for a specified time frame. DB ADMIN ONLY
GET /metrics/max_log_space
Return the maximum usage percentage of logs for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the maximum usage percentage of logs for a specified time frame.
total_log_used_percent
number
Percentage of used size of log space.
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the maximum usage percentages of logs for a specified time frame. DB ADMIN ONLY
GET /metrics/log_space
Return the maximum usage percentages of logs for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the maximum usage percentages of logs in for a specified time frame.
count
integer
Counts of matrices data.
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the maximum percent of node CPU usage for a specified time frame. DB ADMIN ONLY
GET /metrics/max_cpu
Return the maximum percent of node CPU usage for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the maximum percent of node CPU usage for a specified time frame.
cpu_used_percent
number
The percent of CPU usage.
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the percent of node CPU usage for a specified time frame. DB ADMIN ONLY
GET /metrics/cpu_summary
Return the percent of node CPU usage for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the percent of node CPU usage for a specified time frame.
count
integer
Counts of CPU.
issinglenode
boolean
Single node or not.
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the maximum percent of node memory usage for a specified time frame. DB ADMIN ONLY
GET /metrics/max_memory
Return the maximum percent of node memory usage for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the maximum percent of node memory usage for a specified time frame.
memory_used_percent
integer
The percent of memory usage.
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the percent of node memory usage for a specified time frame. DB ADMIN ONLY
GET /metrics/memory_summary
Return the percent of node memory usage for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the percent of memory usage in each node for a specified time frame.
count
integer
Counts of Memory.
issinglenode
boolean
Single node or not.
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the maximum usage percent of storage for a specified time frame. DB ADMIN ONLY
GET /metrics/max_storage
Return the maximum usage percent of storage for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the maximum usage percent of storage for a specified time frame.
fs_total_size_gb
integer
Total size of storage.
fs_used_size_gb
integer
Used size size of storage.
fs_used_percent
number
Percentage of used size of storage.
403 - Operation is only available to administrators.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the usage percent of storage for a specified time frame. DB ADMIN ONLY
GET /metrics/storage
Return the usage percent of storage for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the usage percent of storage for a specified time frame.
count
integer
Counts of matrices data.
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return the time spent in each operation for a specified time frame. DB ADMIN ONLY
GET /metrics/timespent
Return the time spent in each operation for a specified time frame.
Request
Path Parameters
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Return the time spent in each operation for a specified time frame.
count
integer
Number of time spent.
metadata
TimespentMeta
Timespent meta data.
timeseries
array
404 - Database profile not found.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload.
Return a table storage usage in a time range DB ADMIN ONLY
GET /metrics/schemas/{tabschema}/tables/{tabname}/storage/timeseries
Return a table storage usage in a time range.
Request
Path Parameters
tabname
Required *
string
Tabname
tabschema
Required *
string
Tabschema
Query Parameters
end
integer
end
start
integer
start
Response
200 - OK
403 - Current user does not have permission to access this database
404 - Database profile not found
default - Error payload
Returns a list for tables storage DB ADMIN ONLY
GET /metrics/tables/storage
Returns a list for tables storage. Only returns the last collected data between start and end.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if includes system tables in the return list
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
limit
integer
The amount of return records. Limit and offset should be set together.
offset
integer
The starting position of return records. Limit and offset should be set together
tabschema
string
Used to filter by schema
tabname
string
Used to filter by tabname
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns a list for tables storage
count
integer
Number of tables collected
resources
array
A list of tables storage data.
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns a table storage DB ADMIN ONLY
GET /metrics/schemas/{tabschema}/tables/{tabname}/storage
Returns a table storage. Only returns the last collected data between start and end.
Request
Path Parameters
tabschema
Required *
string
Used to filter by schema
tabname
Required *
string
Used to filter by tabname
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns the list for tables storage
count
integer
Number of schemas collected
resources
array
A list of schemas storage data.
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns a list for schemas storage DB ADMIN ONLY
GET /metrics/storage/schemas
Returns a list for schemas storage. Only returns the last collected data between start and end.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if includes system schemas in the return list
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
limit
integer
The amount of return records. Limit and offset should be set together.
offset
integer
The starting position of return records. Limit and offset should be set together
tabschema
string
Used to filter by schema
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns a list for schemas storage
count
integer
Number of schemas collected
resources
array
A list of schemas storage data.
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Return a schema used storage in a time range DB ADMIN ONLY
GET /metrics/storage/schemas/{tabschema}/timeseries
Return a schema used storage in a time range.
Request
Path Parameters
tabschema
Required *
string
Used to filter by schema
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - OK
403 - Current user does not have permission to access this database
404 - Database profile not found
default - Error payload
Returns a schema storage DB ADMIN ONLY
GET /metrics/storage/schemas/{tabschema}
Returns a schema storage. Only returns the last collected data between start and end.
Request
Path Parameters
tabschema
Required *
string
Used to filter by schema
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns the list for schema storage
collected
integer
count
integer
isCache
boolean
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Runs a tables storage collection DB ADMIN ONLY
POST /metrics/tables/storage/collector
Runs asynchronously a tables storage collection. Only allow one thread to run at the same time. If there is already a thread running, the new request will not kick off a new one. The returned handle will be the already running one. If there is no thread running, a new handle will be returned.
Request
Path Parameters
Query Parameters
Response
202 - Runs a tables storage collection
handle
string
Tracer of the job handler.
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns a list of inflight executions
GET /metrics/statements/inflight_executions
Returns a list of inflight executions.Only returns the same statement once and the last collected one between start and end.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system statements in the return list
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
limit
integer
The amount of return records. Limit and offset should be set together.
offset
integer
The starting position of return records. Limit and offset should be set together
client_ipaddr
string
Used to filter by IP address
stmt_text
string
Used to filter by statement text
application_name
string
Used to filter by application_name
session_auth_id
string
Used to filter by session_auth_id
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns a list of inflight executions name
count
integer
Number of statements.
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns a list of current inflight executions
GET /metrics/statements/inflight_executions/current/list
Returns a list of current inflight executions
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system statements in the return list
limit
integer
The amount of return records. Limit and offset should be set together.
offset
integer
The starting position of return records. Limit and offset should be set together
client_ipaddr
string
Used to filter by IP address
stmt_text
string
Used to filter by statement text
application_name
string
Used to filter by application_name
session_auth_id
string
Used to filter by session_auth_id
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns a list of current inflight executions
count
integer
Number of statements.
iscache
boolean
from cache or not. If it's slow to get data from target database, then this API will retreve data from cache and get the last one. iscache identifies it is directly returned from db or from cache. true means from cache, false means from target database.
collected
integer
the collected timestamp from target database. This collected value can be used to set start and end for a history retrieval to get the same list later.
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns a infight execution detail
GET /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}
Returns a infight execution detail. Only returns the last one between start and end
Request
Path Parameters
application_handle
Required *
integer
A system-wide unique ID for the application.
uow_id
Required *
integer
The unit of work identifier.
activity_id
Required *
integer
Counter which uniquely identifies an activity for an application within a given unit of work.
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns a infight execution detail
application_handle
integer
Application handle
uow_id
integer
Unit of work ID
activity_id
integer
Activity ID
coord_member
integer
Coordinator member
entry_time
integer
Entry time
local_start_time
integer
Local start time
total_time_ms
integer
Total time
queue_time_ms
integer
Queue time
idle_time_ms
integer
Idle time
exec_time_ms
integer
Exec time
thresh_violations
integer
Number of threshold violations
wlm_queue_assignments_total
integer
Workload manager total queue assignments
executable_id
string
Executable ID
effective_isolation
string
Effective isolation
effective_query_degree
integer
Effective query degree
query_actual_degree
integer
Actual runtime degree of intrapartition parallelism
adm_bypassed
integer
Reserved for future use
adm_resource_actuals
integer
Reserved for future use
query_cost_estimate_timerons
integer
Query cost estimate
estimated_runtime_ms
integer
Reserved for future use
stmt_text
string
SQL statement text
activity_state
string
Activity state
activity_type
string
Activity type
application_id
string
Application ID
client_ipaddr
string
Client IP address
application_name
string
Application name
system_auth_id
string
System authorization identifier
session_auth_id
string
Session authorization ID
client_applname
string
Client application name
client_wrkstnname
string
Client workstation name
client_acctng
string
Client accounting string
client_userid
string
Client user ID
client_hostname
string
Client hostname
client_pid
integer
Client process ID
client_platform
string
Client platform
client_prdid
string
Client product and version ID
client_port_number
integer
Client port number
workload_name
string
Workload name
appl_id
string
Application ID
service_superclass_name
string
Service superclass name
service_subclass_name
string
Service subclass name
total_cpu_time_ms
integer
Total CPU time
total_routine_invocations
integer
Total routine invocations
fcm_recvs_total
integer
FCM receives total
fcm_sends_total
integer
FCM sends total
complex_operations
integer
Complex operations
all_overflows
integer
All overflows
agents_top
integer
Maximum number of agents that were used
num_agents
integer
Number of concurrent agents
total_sorts
integer
Total Sorts
sort_overflows
integer
Sort overflows
sort_shrheap_allocated_pages
integer
Sort Share Heap Currently Allocated
max_shrheap_allocated_per_part_percent
number
Max Share Heap Allocated Per Part Percent
estimated_sort_shrheap_top_pages
integer
Reserved for future use
max_estimated_shrheap_per_part_percent
number
Max estimated Share Heap Per Part Percent
sort_shrheap_top_pages
integer
Sort share heap high watermark
max_shrheap_peak_per_part_percent
number
Max Share Heap Peak Per Part Percent
hash_join_overflows
integer
Hash Join Overflows
olap_func_overflows
integer
OLAP Function Overflows
hash_grpby_overflows
integer
Hash group by overflows
post_threshold_sorts
integer
Post threshold sorts
post_threshold_hash_joins
integer
Hash Join Threshold
post_threshold_olap_funcs
integer
OLAP function threshold
post_threshold_hash_grpbys
integer
Hash group by threshold
col_vector_consumer_overflows
integer
Columnar vector consumer overflows
post_threshold_col_vector_consumers
integer
Post threshold columnar_vector consumers
rows_read
integer
Rows read
rows_modified
integer
Rows modified
rows_returned
integer
Rows returned
lock_waits
integer
Lock waits
lock_waits_global
integer
Lock waits global
lock_escals
integer
Number of lock escalations
lock_escals_global
integer
Number of global lock escalations
deadlocks
integer
Deadlocks detected
lock_timeouts
integer
Number of lock timeouts
lock_timeouts_global
integer
Lock timeouts global
cf_waits
integer
Number of cluster caching facility waits
log_disk_waits_total
integer
Total log disk waits monitor element
num_log_buffer_full
integer
Number of times full log buffer caused agents to wait
uow_log_space_used_kb
number
Unit of Work Log Space Used
direct_reads
integer
Direct reads from database
direct_writes
integer
Direct writes to database
fcm_volume_kb
number
FCM volume
bp_hit_ratio
number
Buffer pool hit ratio
data_hit_ratio
number
Buffer pool data hit ratio
index_hit_ratio
number
Buffer pool index hit ratio
xda_hit_ratio
number
Buffer pool XDA hit ratio
col_hit_ratio
number
Buffer pool column hit ratio
temp_hit_ratio
number
Buffer pool temp hit ratio
pool_temp_l_reads
number
Buffer pool temp logical reads
pool_temp_p_reads
number
Buffer pool temp physical reads
pool_l_reads
integer
Buffer pool logical reads
pool_p_reads
integer
Buffer pool physical reads
pool_writes
integer
Buffer pool writes
fed_rows_deleted
integer
Rows deleted by a federation system
fed_rows_inserted
integer
Rows inserted by a federation system
fed_rows_updated
integer
Rows updated by a federation system
fed_rows_read
integer
Rows read by a federation system
fed_waits_total
integer
Total number of execution times for a federation server
ext_table_read_volume_kb
number
Total data read by external table readers
ext_table_write_volume_kb
number
Total data written by external table writers
ext_table_send_volume_kb
number
Total data sent to external table writers
ext_table_recv_volume_kb
number
Total data received from external table readers
wlm_queue_time_total_percent
number
Workload manager total queue time
stmt_exec_time_percent
integer
Statement execution time
total_section_proc_time_percent
number
Total section processing time
total_section_sort_proc_time_percent
number
Total section sort processing time
total_col_proc_time_percent
number
Total column-organized processing time
other_section_proc_time_percent
number
Other section processing time
total_routine_user_code_proc_time_percent
number
Total routine user code processing time
total_act_wait_time_percent
number
Total activity wait time
lock_wait_time_global_percent
number
Lock wait time global
lock_wait_time_local_percent
number
Lock wait time local
log_buffer_wait_time_percent
number
Log buffer wait time
log_disk_wait_time_percent
number
Log disk wait time
fcm_wait_time_percent
number
FCM wait time
cf_wait_time_percent
number
cluster caching facility wait time
fed_wait_time_percent
number
Time spent by a federation server
ext_table_wait_time_percent
number
Total agent wait time for external table
total_extended_latch_wait_time_percent
number
Total extended latch wait time
pool_read_time_percent
number
Total buffer pool physical read time
pool_read_time_ms
integer
Total buffer pool physical read time
pool_write_time_percent
number
Total buffer pool physical write time
pool_write_time_ms
integer
Total buffer pool physical write time
direct_read_time_percent
number
Direct Read Time
direct_write_time_percent
number
Direct write time
prefetch_wait_time_percent
number
Time waited for prefetch
prefetch_wait_time_ms
integer
Time waited for prefetch
other_wait_time_percent
number
Other wait time
other_proc_time_percent
number
Other processing time
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Terminates a statement DB ADMIN ONLY
DELETE /metrics/applications/{application_handle}/uow/{uow_id}/inflight_executions/{activity_id}
Terminates a statement
Request
Path Parameters
application_handle
Required *
integer
A system-wide unique ID for the application.
uow_id
Required *
integer
The unit of work identifier.
activity_id
Required *
integer
Counter which uniquely identifies an activity for an application within a given unit of work.
Query Parameters
Response
200 - Connection terminated
403 - Operation is only available to administrators
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns a list of connections
GET /metrics/applications/connections
Returns a list of connections. Each connection represents a row. If there are multiple collections. They'll been aggregated averagely.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system statements in the return list
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
limit
integer
The amount of return records. Limit and offset should be set together.
offset
integer
The starting position of return records. Limit and offset should be set together
client_ipaddr
string
Used to filter by IP address
application_name
string
Used to filter by application_name
session_auth_id
string
Used to filter by session_auth_id
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns Connections with the specific profile name
count
integer
counts of connections
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns a list of current connections
GET /metrics/applications/connections/current/list
Returns a list of current connections. Only return the last collected connections. The values are calculated based on the last collected and privious collection rows to get rate like values.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system statements in the return list
limit
integer
The amount of return records. Limit and offset should be set together.
offset
integer
The starting position of return records. Limit and offset should be set together
client_ipaddr
string
Used to filter by IP address
application_name
string
Used to filter by application_name
session_auth_id
string
Used to filter by session_auth_id
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns Connections with the specific profile name
count
integer
counts of connections
iscache
boolean
from cache or not. If it's slow to get data from target database, then this API will retreve data from cache and get the last one. iscache identifies it is directly returned from db or from cache. true means from cache, false means from target database.
collected
integer
the collected timestamp from target database. This collected value can be used to set start and end for a history retrieval to get the same list later.
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns a connection detail
GET /metrics/applications/connections/{application_handle}
Returns a connection detail
Request
Path Parameters
application_handle
Required *
integer
A system-wide unique ID for the application.
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns connection details with the specific profile name and specific application handle
application_handle
integer
Application handle
coord_member
integer
Coordinating member
connection_start_time
integer
Connection start time
uow_start_time
integer
Unit of work start timestamp
idle_time_ms
integer
Idle time (in milliseconds)
workload_occurrence_state
string
Workload occurrence state
workload_name
string
Workload name
thresh_violations_per_min
integer
Number of threshold violations
wlm_queue_assignments_total_per_min
integer
Workload manager total queue assignments
memory_pool_used_kb
integer
Memory pool used
rejected_rate
number
Rejected rate
application_id
string
Application ID
client_ipaddr
string
Client IP address
application_name
string
Application name
system_auth_id
string
System authorization identifier
session_auth_id
string
Session authorization ID
client_applname
string
Client application name
client_wrkstnname
string
Client workstation name
client_acctng
string
Client accounting string
client_userid
string
Client user ID
client_hostname
string
Client hostname
client_pid
integer
Client process ID
client_platform
string
Client platform
client_prdid
string
Client product and version ID
client_port_number
integer
Client port number
service_superclass_name
string
Service superclass name
total_cpu_time_ms_per_min
integer
Total CPU time
total_routine_invocations_per_min
integer
Total routine invocations
total_compilations_per_min
integer
Total compilations
fcm_recvs_total_per_min
integer
FCM recvs total
fcm_sends_total_per_min
integer
FCM sends total
total_loads_per_min
integer
Total loads
total_reorgs_per_min
integer
Total reorganizations
total_runstats_per_min
integer
Total runtime statistics
complex_operations_per_min
integer
Complex operations
all_overflows_per_min
integer
All overflows
total_sorts_per_min
integer
Total Sorts
sort_overflows_per_min
integer
Sort overflows
sort_shrheap_allocated_pages
integer
Sort Share Heap Currently Allocated
max_shrheap_allocated_per_part_percent
number
Max Share Heap Allocated Per Part Percent
estimated_sort_shrheap_top_pages
integer
Estimated sort Share Heap top
max_estimated_shrheap_per_part_percent
number
Max estimated Share Heap Per Part Percent
sort_shrheap_top_pages
integer
sort_shrheap_top_pages
max_shrheap_peak_per_part_percent
number
max_shrheap_peak_per_part_percent
total_app_commits_per_min
integer
Total application commits
total_app_rollbacks_per_min
integer
Total application rollbacks
act_completed_total_per_min
integer
Total completed activities
act_aborted_total_per_min
integer
Total aborted activities
act_rejected_total_per_min
integer
Total rejected activities
dynamic_sql_stmts_per_min
integer
Dynamic SQL Statements Attempted
static_sql_stmts_per_min
integer
Static SQL Statements Attempted
failed_sql_stmts_per_min
integer
Failed SQL Statements Attempted
select_sql_stmts_per_min
integer
Select SQL Statements Attempted
uid_sql_stmts_per_min
integer
UID SQL Statements Attempted
ddl_sql_stmts_per_min
integer
DDL SQL Statements Attempted
other_stmts_per_min
integer
Other SQL Statements Attempted
rows_read_per_min
integer
Rows read
rows_modified_per_min
integer
Rows modified
rows_returned_per_min
integer
Rows returned
lock_waits_per_min
integer
Lock waits
lock_waits_global_per_min
integer
Lock waits global
lock_escals_per_min
integer
Number of lock escalations
lock_escals_global_per_min
integer
Number of global lock escalations
deadlocks_per_min
integer
Deadlocks detected
lock_timeouts_per_min
integer
Number of lock timeouts
lock_timeouts_global_per_min
integer
Lock timeouts global
num_locks_held
integer
Locks held
cf_waits_per_min
integer
Number of cluster caching facility waits
log_disk_waits_total_per_min
integer
Log disk waits total
num_log_buffer_full_per_min
integer
Number of full log buffers
uow_log_space_used_kb
number
Unit of Work Log Space Used
direct_reads_per_min
integer
Direct reads from database
direct_writes_per_min
integer
Direct writes to database
fcm_volume_kb_per_min
number
FCM volume
bp_hit_ratio
number
Buffer pool hit ratio
data_hit_ratio
number
Buffer pool data hit ratio
index_hit_ratio
number
Buffer pool index hit ratio
xda_hit_ratio
number
Buffer pool XDA hit ratio
col_hit_ratio
number
Buffer pool column hit ratio
temp_hit_ratio
number
Buffer pool temp hit ratio
pool_temp_l_reads_per_min
number
Buffer pool temp logical reads
pool_temp_p_reads_per_min
number
Buffer pool temp physical reads
pool_l_reads_per_min
integer
Buffer pool logical reads
pool_p_reads_per_min
integer
Buffer pool physical reads
pool_writes_per_min
integer
Buffer pool writes
fed_rows_deleted_per_min
integer
Rows deleted by a federation system
fed_rows_inserted_per_min
integer
Rows inserted by a federation system
fed_rows_updated_per_min
integer
Rows updated by a federation system
fed_rows_read_per_min
integer
Rows read by a federation system
fed_waits_total_per_min
integer
Total number of execution times for a federation server
ext_table_read_volume_kb_per_min
number
Total data read by external table readers
ext_table_write_volume_kb_per_min
number
Total data written by external table writers
ext_table_send_volume_kb_per_min
number
Total data sent to external table writers
ext_table_recv_volume_kb_per_min
number
Total data received from external table readers
client_idle_wait_time_percent
number
Client idle wait time
total_rqst_time_percent
number
Total request time
total_compile_proc_time_percent
number
Total compile processing time
total_section_proc_time_percent
number
Total section processing time
total_section_sort_proc_time_percent
number
Total section sort processing time
total_col_proc_time_percent
number
Total column-organized processing time
other_section_proc_time_percent
number
Other section processing time
total_commit_proc_time_percent
number
Total commits processing time
total_rollback_proc_time_percent
number
Total rollback processing time
total_runstats_proc_time_percent
number
Total runtime statistics processing time
total_reorg_proc_time_percent
number
Total reorganization processing time
total_load_proc_time_percent
number
Total load processing time
total_wait_time_percent
number
Total wait time
agent_wait_time_percent
number
Agent wait time
wlm_queue_time_total_percent
number
Workload manager total queue time
lock_wait_time_global_percent
number
Lock wait time global
lock_wait_time_local_percent
number
Lock wait time local
log_buffer_wait_time_percent
number
Log buffer wait time
log_disk_wait_time_percent
number
Log disk wait time
tcpip_wait_time_percent
number
TCP/IP wait time
fcm_wait_time_percent
number
FCM wait time
cf_wait_time_percent
number
cluster caching facility wait time
fed_wait_time_percent
number
Time spent by a federation server
ext_table_wait_time_percent
number
Total agent wait time for external table
total_extended_latch_wait_time_percent
number
Total extended latch wait time
pool_read_time_percent
number
Total buffer pool physical read time
pool_write_time_percent
number
Total buffer pool physical write time
direct_read_time_percent
number
Direct Read Time
direct_write_time_percent
number
Direct write time
prefetch_wait_time_percent
number
Time waited for prefetch
other_wait_time_percent
number
Other wait time
other_proc_time_percent
number
Other processing time
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Terminates a database connection DB ADMIN ONLY
DELETE /metrics/applications/connections/{application_handle}
Terminates an active database connection.
Request
Path Parameters
application_handle
Required *
integer
Application handle name
Query Parameters
Response
200 - Connection terminated
403 - Operation is only available to administrators
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns a list of timeseries of a connection
GET /metrics/applications/connections/{application_handle}/timeseries
Returns a list of timeseries of a connection. The values are calculated based on the last collected and privious collection rows to get rate like values.
Request
Path Parameters
application_handle
Required *
integer
A system-wide unique ID for the application.
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns connection details of timeseries with the specific profile name and specific application handle
count
integer
counts of connections
timeseries
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance metrics for schemas DB ADMIN ONLY
GET /metrics/schemas
Returns performance metrics for schemas. If there are multiple collections. They’ll been aggregated averagely.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system schemas in the return list
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
limit
string
Field to set the amount of return records
offset
string
Field to set the starting position of return records.
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - returns performance of schemas
count
integer
counts of statements
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance metrics for schemas DB ADMIN ONLY
GET /metrics/schemas/current/list
Returns current performance metrics for schemas.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system schemas in the return list
limit
string
Field to set the amount of return records
offset
string
Field to set the starting position of return records.
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - returns performance of schemas
count
integer
counts of statements
iscache
boolean
from cache or not. If it's slow to get data from target database, then this API will retreve data from cache and get the last one. iscache identifies it is directly returned from db or from cache. true means from cache, false means from target database.
collected
integer
the collected timestamp from target database. This collected value can be used to set start and end for a history retrieval to get the same list later.
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance metrics for one schema DB ADMIN ONLY
GET /metrics/schemas/{schema_name}
Returns performance metrics for one schema. If there are multiple collections. They’ll been aggregated averagely.
Request
Path Parameters
schema_name
Required *
string
Schema name
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns performance metrics for one schema
tabschema
string
Table schema name
table_scans_per_min
integer
Table scans
rows_read_per_min
integer
Rows read
rows_inserted_per_min
integer
Rows inserted
rows_updated_per_min
integer
Rows updated
rows_deleted_per_min
integer
Rows deleted
logical_reads_per_min
integer
Logical reads
physical_reads_per_min
integer
Physical reads
hit_ratio
number
Buffer pool hit ratio
rows_read_versus_accessed_per_min
number
Rows read versus accessed
data_object_l_pages_per_min
integer
Logical data object pages
index_object_l_pages_per_min
integer
Logical index object pages
xda_object_l_pages_per_min
integer
Logical XDA object pages
lob_object_l_pages_per_min
integer
Logical LOB object pages
long_object_l_pages_per_min
integer
Logical Long object pages
accesses_min
integer
Access per minute
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance metrics on all members for one schema DB ADMIN ONLY
GET /metrics/schemas/{schema_name}/members
Returns performance metrics on all members for one schema. If there are multiple collections. They’ll been aggregated averagely.
Request
Path Parameters
schema_name
Required *
string
Schema name
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns performance metrics on all members for one schema
count
integer
Schema Perf list
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance metrics timeseries for one schema DB ADMIN ONLY
GET /metrics/schemas/{schema_name}/timeseries
Returns performance metrics timeseries for one schema.
Request
Path Parameters
schema_name
Required *
string
Schema name
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns performance metrics timeseries for one schema
count
integer
Schema Perf list
timeseries
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance of tables DB ADMIN ONLY
GET /metrics/tables
Returns performance of tables. If there are multiple collections. They’ll been aggregated averagely.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system tables in the return list
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
limit
string
Field to set the amount of return records
offset
string
Field to set the starting position of return records.
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns performance of tables
count
integer
A list of tables
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns current performance of tables DB ADMIN ONLY
GET /metrics/tables/current/list
Returns current performance of tables.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system tables in the return list
limit
string
Field to set the amount of return records
offset
string
Field to set the starting position of return records.
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns performance of tables
count
integer
A list of tables
iscache
boolean
from cache or not. If it's slow to get data from target database, then this API will retreve data from cache and get the last one. iscache identifies it is directly returned from db or from cache. true means from cache, false means from target database.
collected
integer
the collected timestamp from target database. This collected value can be used to set start and end for a history retrieval to get the same list later.
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance of one table DB ADMIN ONLY
GET /metrics/schemas/{schema_name}/tables/{table_name}
Returns performance of one table. If there are multiple collections. They’ll been aggregated averagely.
Request
Path Parameters
schema_name
Required *
string
Schema name
table_name
Required *
string
Table name
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns performance of one table
tabschema
string
Table schema name
tabname
string
Table name
tab_type
string
Table type
tbsp_name
string
Tablespace name
table_scans_per_min
integer
Table scans
rows_read_per_min
integer
Rows read
rows_inserted_per_min
integer
Rows inserted
rows_updated_per_min
integer
Rows updated
rows_deleted_per_min
integer
Rows deleted
logical_reads_per_min
integer
Logical reads
physical_reads_per_min
integer
Physical reads
hit_ratio
number
Buffer pool hit ratio
rows_read_versus_accessed_per_min
number
Rows read versus accessed
data_object_l_pages_per_min
integer
Logical data object pages
index_object_l_pages_per_min
integer
Logical index object pages
xda_object_l_pages_per_min
integer
Logical XDA object pages
lob_object_l_pages_per_min
integer
Logical LOB object pages
long_object_l_pages_per_min
integer
Logical Long object pages
accesses_min
integer
Access per minute
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance on all members for one table DB ADMIN ONLY
GET /metrics/schemas/{schema_name}/tables/{table_name}/members
Returns performance on all members for one table. If there are multiple collections. They’ll been aggregated averagely.
Request
Path Parameters
schema_name
Required *
string
Schema name
table_name
Required *
string
Table name
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns performance on all members for one table
count
integer
Table performance list
resources
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance timeseries for one table DB ADMIN ONLY
GET /metrics/schemas/{schema_name}/tables/{table_name}/timeseries
Returns performance timeseries for one table.
Request
Path Parameters
schema_name
Required *
string
Schema name
table_name
Required *
string
Table name
Query Parameters
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
Response
200 - Returns performance timeseries for one table
count
integer
Table performance list
timeseries
array
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns performance of tables and schemas DB ADMIN ONLY
GET /metrics/tableperformance
Returns performance of tables and schemas. If there are multiple collections. They’ll been aggregated averagely.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system tables in the return list
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
limit
string
Field to set the amount of return records
offset
string
Field to set the starting position of return records.
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns performance of tables
schema
schemaPerfList
a list of Sechmas
table
tablePerfList
A list of tables
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns current performance of tables and schemas DB ADMIN ONLY
GET /metrics/tableperformance/current/list
Returns current performance of tables and schemas. If there are multiple collections. They’ll been aggregated averagely.
Request
Path Parameters
Query Parameters
include_sys
string
Field to set if include system tables in the return list
start
Required *
integer
Start timestamp.
end
Required *
integer
End timestamp.
limit
string
Field to set the amount of return records
offset
string
Field to set the starting position of return records.
sort
string
Used to sort by the given field. The name of given field can be found from the response. Plus + or - before the given filed to denote by ASC or DESC. By default if not specified it's by ASC. Note: only support one field each time.
Response
200 - Returns performance of tables
schema
currentSchemaPerfList
a list of Sechmas
table
currentTablePerfList
A list of tables
403 - Current user does not have permission to access this database
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - Database profile not found
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Returns the system's current settings
GET /settings
Returns the system's current settings.
Request
Response
200 - System settings
product_name
string
Product name
database_host
string
Host name or IP address of the database server
database_port
integer
Port number for non-secured database connections
database_port_ssl
integer
Port number for secured database connections
database_ssl_connections_enforced
string
Accepts values 'yes' and 'no'. When set to 'yes' clients can only connect to the database server using secured connections
console_url
string
URL to access the web console
nodes_count
integer
Number of physical nodes in the database cluster
subscription_plan
string
Subscription plan
environment
object
The environment where the service is running
default - Error payload
PUT /settings
The only setting that can be modified is `database_ssl_connections_enforced`. By setting `database_ssl_connections_enforced` to `true` database connection requests must be secured. If set to `false` both secured and unsecured database connections are accepted.
This operation is only available to system administrators.
Request
Request Body
SystemSettingsUpdate
System settings
database_ssl_connections_enforced
Required *
string
Accepts values 'yes' and 'no'. When set to 'yes' clients can only connect to the database server using secured connections
Response
200 - System settings
product_name
string
Product name
database_host
string
Host name or IP address of the database server
database_port
integer
Port number for non-secured database connections
database_port_ssl
integer
Port number for secured database connections
database_ssl_connections_enforced
string
Accepts values 'yes' and 'no'. When set to 'yes' clients can only connect to the database server using secured connections
console_url
string
URL to access the web console
nodes_count
integer
Number of physical nodes in the database cluster
subscription_plan
string
Subscription plan
environment
object
The environment where the service is running
default - Error payload
Returns the list of users
GET /users
Administrators can retrieve the list of all users in the system. Regular users will receive a list containing only their own user profile.
Request
Response
200 - List of users
count
integer
Number of elements
resources
array
List of users
default - Error payload
POST /users
Creates a new user.
This operation is only available to system administrators.
Request
Request Body
User
User information
id
Required *
string
The user's ID. It must be between 1 and 128 characters and may only contain letters a-z (lower-case), numbers 0-9, and the special characters '_', '-' or '.'. It can not start with special characters. It may not be "guests", "admins", "users", "local", "idax", "public", "ibm", "dsweb", "sqlj", "root" or "gopher". It cannot begin with "bluadmin", "db2inst1", "nullid", "ibm", "sql" or "sys". Those limits don't apply to IBMid (when "iam" is set to true).
iam
boolean
Indicate if this user is an IBMid User. When set to true, only "id", "ibmid", "role" and "locked" are needed. The default value is false.
ibmid
string
If iam sets to true, ibmid is required. It's the IBMid which will associate with the user id in the Console.
name
string
The user's full name. Not needed for IBMid and will be ignored if set.
password
Required *
string
The user's password. It must have a minimum of 15 characters. It must contain at least one each of upper-case letters, lower-case letters, numbers, and special characters. Do not use common words in password. For IBMid, password should be absent since the credential is managed by IBMid but not the Console.
role
Required *
string
The user's role. Administrators have the `bluadmin` role. Regular users have the `bluuser` role.
string
The user's email address. Not needed for IBMid and will be ignored if set.
locked
string
If set to 'yes', it indicates the user account is locked, which disallows the user from logging into the system
authentication
object
method
Required *
string
The authentication method to be used when the user logs in. Currently only 'internal' is allowed. Not needed for IBMid and will be ignored if set.
policy_id
Required *
string
The authentication policy ID for this user account. Only valid when type is set to 'internal'. Not needed for IBMid and will be ignored if set.
Response
201 - User response
id
string
The user's ID. It must be between 1 and 128 characters and may only contain letters a-z (lower-case), numbers 0-9, and the special characters '_', '-' or '.'. It can not start with special characters. It may not be "guests", "admins", "users", "local", "idax", "public", "ibm", "dsweb", "sqlj", "root" or "gopher". It cannot begin with "bluadmin", "db2inst1", "nullid", "ibm", "sql" or "sys". Those limits don't apply to IBMid (when "iam" is set to true).
iam
boolean
Indicate if this user is an IBMid User. When set to true, only "id", "ibmid", "role" and "locked" are needed. The default value is false.
ibmid
string
If iam sets to true, ibmid is required. It's the IBMid which will associate with the user id in the Console.
name
string
The user's full name. Not needed for IBMid and will be ignored if set.
password
string
The user's password. It must have a minimum of 15 characters. It must contain at least one each of upper-case letters, lower-case letters, numbers, and special characters. Do not use common words in password. For IBMid, password should be absent since the credential is managed by IBMid but not the Console.
role
string
The user's role. Administrators have the `bluadmin` role. Regular users have the `bluuser` role.
string
The user's email address. Not needed for IBMid and will be ignored if set.
locked
string
If set to 'yes', it indicates the user account is locked, which disallows the user from logging into the system
authentication
object
400 - Invalid parameters or user already exists
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Operation is only available to administrators
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
GET /users/{id}
Get a specific user by ID.
System administrators may retrieve user information for any user. Regular users may only retrieve themselves.
Request
Path Parameters
id
Required *
string
ID of the user to be fetched
Query Parameters
Response
200 - User response
id
string
The user's ID. It must be between 1 and 128 characters and may only contain letters a-z (lower-case), numbers 0-9, and the special characters '_', '-' or '.'. It can not start with special characters. It may not be "guests", "admins", "users", "local", "idax", "public", "ibm", "dsweb", "sqlj", "root" or "gopher". It cannot begin with "bluadmin", "db2inst1", "nullid", "ibm", "sql" or "sys". Those limits don't apply to IBMid (when "iam" is set to true).
iam
boolean
Indicate if this user is an IBMid User. When set to true, only "id", "ibmid", "role" and "locked" are needed. The default value is false.
ibmid
string
If iam sets to true, ibmid is required. It's the IBMid which will associate with the user id in the Console.
name
string
The user's full name. Not needed for IBMid and will be ignored if set.
password
string
The user's password. It must have a minimum of 15 characters. It must contain at least one each of upper-case letters, lower-case letters, numbers, and special characters. Do not use common words in password. For IBMid, password should be absent since the credential is managed by IBMid but not the Console.
role
string
The user's role. Administrators have the `bluadmin` role. Regular users have the `bluuser` role.
string
The user's email address. Not needed for IBMid and will be ignored if set.
locked
string
If set to 'yes', it indicates the user account is locked, which disallows the user from logging into the system
authentication
object
403 - Access to this user is not allowed
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - The user does not exist
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
PUT /users/{id}
Updates an existing user. Attribute 'iam' can not be updated. That means no conversion between IBMid users and normal users.
System administrators may update user information for any user. Regular users may only update themselves.
Request
Request Body
UserUpdate
User information
id
Required *
string
The user's ID
ibmid
string
ibmid is only valid for IBMid users. It's the IBMid which will associate with the user id in the Console.
name
string
The user's full name
old_password
string
Current password must be provided when user updates his own profile.
new_password
string
New password
role
string
The user's role. Administrators have the `bluadmin` role. Regular users have the `bluuser` role.
string
The user's email address
locked
string
If set to 'yes', it indicates the user account is locked, which disallows the user from logging into the system
authentication
object
method
Required *
string
The authentication method to be used when the user logs in. Currently only 'internal' is allowed. Not needed for IBMid and will be ignored if set.
policy_id
Required *
string
The authentication policy ID for this user account. Only valid when type is set to 'internal'. Not needed for IBMid and will be ignored if set.
Path Parameters
id
Required *
string
ID of the user to be updated
Query Parameters
Response
200 - User response
id
string
The user's ID. It must be between 1 and 128 characters and may only contain letters a-z (lower-case), numbers 0-9, and the special characters '_', '-' or '.'. It can not start with special characters. It may not be "guests", "admins", "users", "local", "idax", "public", "ibm", "dsweb", "sqlj", "root" or "gopher". It cannot begin with "bluadmin", "db2inst1", "nullid", "ibm", "sql" or "sys". Those limits don't apply to IBMid (when "iam" is set to true).
iam
boolean
Indicate if this user is an IBMid User. When set to true, only "id", "ibmid", "role" and "locked" are needed. The default value is false.
ibmid
string
If iam sets to true, ibmid is required. It's the IBMid which will associate with the user id in the Console.
name
string
The user's full name. Not needed for IBMid and will be ignored if set.
password
string
The user's password. It must have a minimum of 15 characters. It must contain at least one each of upper-case letters, lower-case letters, numbers, and special characters. Do not use common words in password. For IBMid, password should be absent since the credential is managed by IBMid but not the Console.
role
string
The user's role. Administrators have the `bluadmin` role. Regular users have the `bluuser` role.
string
The user's email address. Not needed for IBMid and will be ignored if set.
locked
string
If set to 'yes', it indicates the user account is locked, which disallows the user from logging into the system
authentication
object
403 - Access to this user is not allowed
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - The user does not exist
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
DELETE /users/{id}
Deletes an existing user.
Only administratos can delete users.
Request
Path Parameters
id
Required *
string
ID of the user to be deleted.
Query Parameters
Response
200 - User deleted
403 - Removal of this user is not allowed
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - The user does not exist
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Locks a user account indefinitely. ADMIN ONLY
PUT /users/{id}/lock
Admin users can unlock users' accounts which have been locked out following repeated failed authentication attempts.
Request
Path Parameters
id
Required *
string
ID of the user who will be locked
Query Parameters
Response
200 - User response
id
string
The user's ID. It must be between 1 and 128 characters and may only contain letters a-z (lower-case), numbers 0-9, and the special characters '_', '-' or '.'. It can not start with special characters. It may not be "guests", "admins", "users", "local", "idax", "public", "ibm", "dsweb", "sqlj", "root" or "gopher". It cannot begin with "bluadmin", "db2inst1", "nullid", "ibm", "sql" or "sys". Those limits don't apply to IBMid (when "iam" is set to true).
iam
boolean
Indicate if this user is an IBMid User. When set to true, only "id", "ibmid", "role" and "locked" are needed. The default value is false.
ibmid
string
If iam sets to true, ibmid is required. It's the IBMid which will associate with the user id in the Console.
name
string
The user's full name. Not needed for IBMid and will be ignored if set.
password
string
The user's password. It must have a minimum of 15 characters. It must contain at least one each of upper-case letters, lower-case letters, numbers, and special characters. Do not use common words in password. For IBMid, password should be absent since the credential is managed by IBMid but not the Console.
role
string
The user's role. Administrators have the `bluadmin` role. Regular users have the `bluuser` role.
string
The user's email address. Not needed for IBMid and will be ignored if set.
locked
string
If set to 'yes', it indicates the user account is locked, which disallows the user from logging into the system
authentication
object
403 - Cannot edit this user
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - The user does not exist
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Unlocks a user account ADMIN ONLY
PUT /users/{id}/unlock
Admin users can unlock users' accounts which have been locked out following repeated failed authentication attempts.
Request
Path Parameters
id
Required *
string
ID of the user who will be unlocked
Query Parameters
Response
200 - User response
id
string
The user's ID. It must be between 1 and 128 characters and may only contain letters a-z (lower-case), numbers 0-9, and the special characters '_', '-' or '.'. It can not start with special characters. It may not be "guests", "admins", "users", "local", "idax", "public", "ibm", "dsweb", "sqlj", "root" or "gopher". It cannot begin with "bluadmin", "db2inst1", "nullid", "ibm", "sql" or "sys". Those limits don't apply to IBMid (when "iam" is set to true).
iam
boolean
Indicate if this user is an IBMid User. When set to true, only "id", "ibmid", "role" and "locked" are needed. The default value is false.
ibmid
string
If iam sets to true, ibmid is required. It's the IBMid which will associate with the user id in the Console.
name
string
The user's full name. Not needed for IBMid and will be ignored if set.
password
string
The user's password. It must have a minimum of 15 characters. It must contain at least one each of upper-case letters, lower-case letters, numbers, and special characters. Do not use common words in password. For IBMid, password should be absent since the credential is managed by IBMid but not the Console.
role
string
The user's role. Administrators have the `bluadmin` role. Regular users have the `bluuser` role.
string
The user's email address. Not needed for IBMid and will be ignored if set.
locked
string
If set to 'yes', it indicates the user account is locked, which disallows the user from logging into the system
authentication
object
403 - Cannot edit this user
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - The user does not exist
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
GET /users/{id}/connection_privileges
Get a specific user's connection privileges.
If restricted is set to 'yes', the user will only be allowed to make database connections from IP addresses or hostnames in the authorized_hosts list.
System administrators may retrieve connection privilege information for any user. Regular users may only retrieve their own connection privileges.
Request
Path Parameters
id
Required *
string
ID of the user who's information is to be fetched
Query Parameters
Response
200 - User's connection privileges
userid
string
The user's ID
restricted
string
If 'yes', database connections will only be allowed from the list of authorized hosts. If 'no', database connections will be allowed from anywhere.
authorized_hosts
array
A list of IP addresses or hostnames in which the user can connect from.
403 - Access to this user's connection privileges is not allowed
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - The user does not exist
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
PUT /users/{id}/connection_privileges
Updates an existing user's connection privileges.
If restricted is set to 'yes', the user will only be allowed to make database connections from IP addresses or hostnames in the authorized_hosts list.
This operation is only available to system administrators. An administrator may set the privileges of all users other than themself.
Request
Request Body
UserConnectionPrivileges
Connection privilege information
userid
Required *
string
The user's ID
restricted
Required *
string
If 'yes', database connections will only be allowed from the list of authorized hosts. If 'no', database connections will be allowed from anywhere.
authorized_hosts
array
A list of IP addresses or hostnames in which the user can connect from.
Path Parameters
id
Required *
string
ID of the user who's information is to be updated
Query Parameters
Response
200 - Updated user connection privileges
userid
string
The user's ID
restricted
string
If 'yes', database connections will only be allowed from the list of authorized hosts. If 'no', database connections will be allowed from anywhere.
authorized_hosts
array
A list of IP addresses or hostnames in which the user can connect from.
403 - Access to this user's connection privileges is not allowed
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
404 - The user does not exist
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Retrieves current configuration
GET /platform-keys/configurations
Returns current encryption key information.
Request
Path Parameters
Query Parameters
db2_crn
Required *
string
Cloud Resource Name (CRN) for db2 instance.
Response
200 - Platform key current configuration
keystoreType
string
Type of key store
kpInstance
object
Key Protect instance
kpKey
object
Key Protect key
isMigratable
boolean
If true migration is allowed
migrationStatus
string
targetKeyStore
TargetKeyStore
400 - Bad request
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
401 - Unauthorized
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Forbidden, Db2 does not have access to the migrated key.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
500 - Internal Server Error
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
Migrate key
POST /platform-keys/configurations
Migrate existing key, from local key to Key Proect key or from one Key Protect key to another
Request
Request Body
MigrateKey
key information
kpInstance
object
kpInstanceID
string
ID of Key Protect instance
kpInstanceName
string
Name of Key Protect instance
kpRegion
string
Region of Key Protect instance
kpKey
object
kpKeyID
string
ID of Key Protect key
kpKeyName
string
Name of Key Protect key
db2CRN
string
Cloud resource name of Db2 instance
Response
200 - Key migrated
keystoreType
string
Type of key store
kpInstance
object
Key Protect instance
kpKey
object
Key Protect key
isMigratable
boolean
If true migration is allowed
migrationStatus
string
targetKeyStore
TargetKeyStore
400 - Bad request
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
401 - Unauthorized
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Forbidden, user has no permission for this API.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
500 - Internal Server Error
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
Returns Key Protect instance information
GET /platform-keys/instances
Returns Key Protect instance information.
Request
Path Parameters
Query Parameters
db2_crn
Required *
string
Cloud Resource Name (CRN) for db2 instance.
Response
200 - KP instance information
metadata
Metadata
instances
array
400 - Bad request
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
401 - Unauthorized
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Forbidden, user has no permission for this API.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
500 - Internal Server Error
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
Returns keys for given Key Protect instance
GET /platform-keys/instances/{instance_id}/region/{region_id}/keys
Returns keys for given Key Protect instance
Request
Path Parameters
instance_id
Required *
string
Key Protect instance id
region_id
Required *
string
Key Protect region id
Query Parameters
db2_crn
Required *
string
Cloud Resource Name (CRN) for db2 instance.
Response
200 - Keys for KP instance
metadata
Metadata
keys
array
400 - Bad request
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
401 - Unauthorized
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
403 - Forbidden, user has no permission for this API.
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
500 - Internal Server Error
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
Generate visual explain model for a given sql
POST /explain/explain_model
Generate visual explain model for a given sql.
Request
Request Body
ExplainSQL
The SQL query to be explained.
schema
Required *
string
The query's schema.
sql
Required *
string
The SQL query to be explained.
profileName
string
The connection profile name, it must be specified for multiple db model.
showRecomm
boolean
Show recommendations for smart alert in visual explain, default is false.
Response
201 - return visual explain session id
code
integer
Return code
output
string
session id
400 - Invalid parameters or invalid content type
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get visual explain nodes information
GET /explain/explain_model/{sessionId}/diagram/nodes
Get visual explain nodes including id and label information.
Request
Path Parameters
sessionId
Required *
string
The session id that used to generate the basic node information of visual explain.
Query Parameters
Response
200 - Return the ids and labels in visual explain
hint
string
The information for creating optimization profile, just used for Enterprise
ids
array
List of node id
label1s
array
List of node labels in visual explain.
label2s
array
List of node cost labels or schema labels in visual explain.
sessionId
string
Session id that used to generate the visual explain.
400 - Invalid parameters or invalid content type
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Generate visual explain layout
POST /explain/explain_model/{sessionId}/diagram/layout
Generate visual explain laytout.
Request
Request Body
ExplainLayoutInput
The ids and labels and their height and width of font that used to generate the layout of visual explain.
containerWidth
Required *
integer
The width of view port which the graph is displayed inside.
idFontHeight
Required *
integer
The height of id label
ids
Required *
array
The skeleton of visual explain
label1FontHeight
Required *
integer
The height of label
label1s
Required *
array
List of node labels in visual explain.
label2s
Required *
array
List of node cost labels or schema labels and the text width in visual explain.
Path Parameters
sessionId
Required *
string
The session id that used to generate the basic node information of visual explain.
Query Parameters
Response
201 - Return the layout information in visual explain
advancedSearchCriterias
array
The advanced search criterias
dbplatform
string
The platform of Db2
dbversion
string
The version for Db2
diagnostic
string
The explain warning message
diagrams
array
List of diagram information in visual explain.
explainOptions
string
The explain options
explainTime
string
The explain time
miniplans
object
The PLAN_TABLE data
recommendationAnchors
array
The recommendation advisor with the related node
recommendations
array
The recommendation advisor with the related node
sessionId
string
Session id that is used to generate the visual explain.
sql
object
The sql to be explained
tabularPlan
object
The tabular data
treePlan
object
The data of the tree view
400 - Invalid parameters or invalid content type
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Get the data of the selected node
GET /explain/explain_model/{sessionId}/diagram/nodes/{nodeId}/description
Get the data of the selected node
Request
Path Parameters
sessionId
Required *
string
The session id that used to get the node description of visual explain.
nodeId
Required *
string
The node id that used to get the node description of visual explain.
Query Parameters
Response
200 - Return the description of the selected node
pods
array
All group data of pods
400 - Invalid parameters or invalid content type
trace
string
Unique ID assigned by the server that identifies the request that generated the error
errors
array
List of errors
default - Error payload
Search node based on the key word and predefined rule
GET /explain/explain_model/search/{sessionId}/{namePattern}
Search node based on the key word and predefined rule
Request
Path Parameters
sessionId
Required *
string
The session id that used to get the node description of visual explain.
namePattern
Required *
string
The key word to search node.
Query Parameters
Response
200 - Return the list of nodes
costType
string
The total cost type
entries
array
todo
default - Error payload
Search node based on the key word and predefined rule
POST /explain/explain_model/search/{sessionId}
Search node based on the key word and predefined rule
Request
Request Body
ExplainSearchNodesInput
The key word and predefined rule to search node
advanacedSearchRequests
Required *
array
The advanced search predefined rule
namePattern
Required *
string
The key word to search node
Path Parameters
sessionId
Required *
string
The session id that used to get the node description of visual explain.
Query Parameters
Response
201 - Return the list of nodes
costType
string
The total cost type
entries
array
todo
default - Error payload
Create a scaling request
PUT /manage/scaling/add
Scale the instance with desired amount of storage and cpu value.
Request
Request Body
Contains the number of cores and the amount of storage to scale.
total_cores
integer
The number of cores to scale
total_storage
integer
The amount of storage to scale. If scaling only cores, then set total_storage to its current value. Do not set as zero or unspecified.
trigger_time_unix_ms
integer
Unix timestamp in milliseconds when the scale will be triggered. If this value is not specified , scale will be trigged right away
Response
200 - Send scaling request successfully.
scaling_id
string
the task ID for scaling operation
400 - Bad request
401 - Unauthorized
500 - Internal server error
message
string
error message
code
integer
error status code
Cancel a pending scaling request
DELETE /manage/scaling/cancel/{id}
Cancel a pending scaling request based on request ID
Request
Path Parameters
id
Required *
string
Request ID to be cancelled. This can be obtained from API /manage/scaling/list
Query Parameters
Response
200 - OK
instance_id
string
message
string
request_id
string
400 - Bad request
message
string
error message
code
integer
error status code
401 - Unauthorized
message
string
error message
code
integer
error status code
404 - Not Found
message
string
error message
code
integer
error status code
500 - Unauthorized
message
string
error message
code
integer
error status code
Get the last scaling request status
GET /manage/scaling/last_status
Get the status from the last scaling request
Request
Response
200 - OK
id
string
status
string
progress_percent
integer
time_created
string
requested_cores
integer
requested_storage
integer
request_id
string
trigger_time
integer
400 - Bad request
message
string
error message
code
integer
error status code
401 - Unauthorized
message
string
error message
code
integer
error status code
404 - Not Found
message
string
error message
code
integer
error status code
500 - Unauthorized
message
string
error message
code
integer
error status code
Get the complete list of scaling requests
GET /manage/scaling/list
Get the complete list of scaling requests performed on this instance
Request
Response
200 - OK
list
array
400 - Bad request
message
string
error message
code
integer
error status code
401 - Unauthorized
message
string
error message
code
integer
error status code
404 - Not Found
message
string
error message
code
integer
error status code
500 - Unauthorized
message
string
error message
code
integer
error status code
Get supported scaling ranges and current allocated resources
GET /manage/scaling/resources
Get allocated storage and cpu at the time of request. Also, it returns the supported scaling ranges for this IBM Cloud Db2 service.
Request
Response
200 - Details for supported scaling ranges and current allocated resources.
plan
string
storage
object
current allocated storage and supported storage ranges for scaling
compute
object
current allocated cpu and supported cpu ranges for scaling
schedule
object
Configuration of scheduled scaling
400 - Bad request
401 - Unauthorized
500 - Unexpected error
message
string
error message
code
integer
error status code
View scaling history saved in console
GET /manage/scaling/history
View the scaling history data showing in console
Request
Path Parameters
Query Parameters
start
integer
end
integer
search
string
sort_column
string
sort_order
string
activity_type
string
Response
200 - View scaling history
list
array
List of scaling history
400 - Bad request
401 - Unauthorized
500 - Internal server error
message
string
error message
code
integer
error status code
Get a list of backups
GET /backups
Get a list of backups from current instance.
Request
Response
200 - The list of backups
backups
array
400 - Bad request
401 - Unauthorized
500 - Internal server error
message
string
error message
code
integer
error status code
Restore
POST /backups/restore
Restore to a particular backup.
Request
Request Body
backup_id
string
backup ID
Response
200 - Task detail of the restore job
task
object
400 - Bad request
401 - Unauthorized
500 - Internal server error
message
string
error message
code
integer
error status code
Create a backup
POST /backups/backup
Create a backup
Request
Response
200 - OK
task
object
400 - Bad request
401 - Unauthorized
500 - Unexpected error
message
string
error message
code
integer
error status code
Delete a backup
DELETE /backups/{id}
Delete a backup
Request
Path Parameters
id
Required *
string
Query Parameters
Response
200 - OK
task
object
400 - Bad request
401 - Unauthorized
500 - Unexpected error
message
string
error message
code
integer
error status code
Get backup setting
GET /backups/setting
Get backup setting for scheduled time and retention policy
Request
Response
200 - OK
setting
object
400 - Bad request
401 - Unauthorized
500 - Unexpected error
message
string
error message
code
integer
error status code
Update backup setting
POST /backups/setting
update backup setting for scheduled backup time or retention policy
Request
Request Body
backup_time
string
retention
integer
Response
200 - OK
setting
object
400 - Bad request
401 - Unauthorized
500 - Unexpected error
message
string
error message
code
integer
error status code
Get tasks status
GET /tasks/status
Request
Response
200 - contain tasks status for scaling ,restore etc.
tasks
array
400 - Bad request
401 - Unauthorized
500 - Error
message
string
error message
code
integer
error status code