qua_data_api_instances#

Provides a detailed list of all configured DataApi instances.

Column name

Data type

Nullable?

Description

instance_id

int

false

Internal id of the DataApi instance.

name

sysname

false

User-friendly name of the instance.

port

int

false

Port number the instance is bound to.

state

sysname

false

Current state of the process hosting the instance (Started or Stopped).

auto_start

bit

false

Indicates weather the instance should auto start. 1 indicates that instance should auto start, 0 otherwise.

authentication_type

sysname

false

Required authentication type for end-users.

host_type

sysname

false

Hosting type. Development enables Swagger and extended logging, Production forces settings optimized for production environment.

comment

nvarchar(2048)

true

User-friendly comment.

pid

int

true

Current or last known OS process id handling the instance.

last_error

nvarchar(2048)

true

Error message from last error that ocurred during instance startup.

rest_path

nvarchar(128)

false

Path to the REST API.

user_id

int

false

Id of the user account used to access tables and views by the REST API.

user_name

sysname

true

Login name of the user used to access tables and views by the REST API.

Example#

Select all stopped DataApi instances:

select *
  from sys.qua_data_api_instances
 where state = 'Stopped'