REST API Parameters for Teradata Database Configuration | Teradata Query Service - Parameters for REST API for Teradata Database Configuration - Teradata Query Service

Teradata® Query Service Installation, Configuration, and Usage Guide for Customers - 4.01.03.01, 4.01.07.00

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Teradata Query Service
Release Number
4.01.03.01, 4.01.07.00
Published
September 2023
Language
English (United States)
Last Update
2024-02-16
dita:mapPath
qla1666844235399.ditamap
dita:ditavalPath
ft:empty
dita:id
enn1467244092237
Product Category
Analytical Ecosystem

Sessions Parameters

Parameter Description
System Alias of the Teradata Database system in the REST API for Teradata Database configuration.
User Name of the Teradata Database user who submitted the query.
Session ID Teradata Database session ID or blank if not logged in.
Internal Session ID Internal REST API for Teradata Database service ID for the database session.
State Current database session state. States can be any of the following:
LOGINON No query. In the process of logging in.
READY No query, but logged on and ready to accept work.
QUEUED Query on the task queue, waiting to run.
ACTIVE Query executing or a query response is spooling.
ABORTING Query being aborted.
LOGGINGOFF No query. In the process of logging out.
Create Mode Implicit or Explicit. Implicit database sessions are those created and used by the REST API for Teradata Database service for requests not specifying an explicit session. An explicit database session is one created by client applications for sole use by that application.
Close Close the database session.

Queries Parameters

Parameter Description
System Alias of the Teradata Database system in the REST API for Teradata Database configuration.
User Name of the Teradata Database user who submitted the query.
Client ID Teradata Database ID specified by the client when the query was submitted.
Int Session ID REST API for Teradata Database service internal session ID (Implicit or ID #).
State Query state, which can be PENDING, SUBMITTED, or RESPONDING.
Queue Order Order of the request in the queue: 0 equals the active request for the database session.
In Queue Number of milliseconds the query was queued by the REST API for Teradata Database service before being submitted to the database.
Running Number of milliseconds since the REST API for Teradata Database service submitted the request. Blank if not running yet.
Abort Cancel a query.