Manual Control and Customization APIs | VantageCloud Lake - Manual Control and Customization APIs - Teradata Vantage

Teradata® VantageCloud Lake
Deployment
VantageCloud
Edition
Lake
Product
Teradata Vantage
Published
January 2023
ft:locale
en-US
ft:lastEdition
2024-12-11
dita:mapPath
phg1621910019905.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
phg1621910019905

The APIs documented in this section allow DBA experts to review and approve statistic recommendations on AUTODBA objects that were previously marked for semi-autonomous control using the WITH CHECK syntax option. Additional APIs allow for customization on how statistics are analyzed or prepared for collection. Lastly, an AuditTrail API assists DBAs or Teradata Support personnel in investigating performance issues that may have resulted from an individual applied tuning action.

General API Usage

Semi-autonomous APIs are in the form of stored procedures residing within owning database TDStats, each with a single JSON input parameter that support an extensible set of name-value pairs.
  • APIs that display recommendations return output in the form of relational dynamic row results similar to Dashboard Reporting APIs.
  • APIs performing actions such as approve or disapprove will return a JSON output parameter that confirms the action performed.
REPLACE PROCEDURE TDStats.<ReportAPI> (
   IN jIn JSON(2000) CHARACTER SET UNICODE)
   DYNAMIC RESULT SETS 1 

REPLACE PROCEDURE TDStats.<ActionAPI> (
   IN jIn JSON(3000) CHARACTER SET UNICODE,
   OUT jOut JSON(3000) CHARACTER SET UNICODE)