Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetColumnStatisticsTaskSettings

Gets settings for a column statistics task.

Request Syntax


{
   "DatabaseName": "string",
   "TableName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DatabaseName

The name of the database where the table resides.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

TableName

The name of the table for which to retrieve column statistics.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax


{
   "ColumnStatisticsTaskSettings": { 
      "CatalogID": "string",
      "ColumnNameList": [ "string" ],
      "DatabaseName": "string",
      "LastExecutionAttempt": { 
         "ColumnStatisticsTaskRunId": "string",
         "ErrorMessage": "string",
         "ExecutionTimestamp": number,
         "Status": "string"
      },
      "Role": "string",
      "SampleSize": number,
      "Schedule": { 
         "ScheduleExpression": "string",
         "State": "string"
      },
      "ScheduleType": "string",
      "SecurityConfiguration": "string",
      "SettingSource": "string",
      "TableName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ColumnStatisticsTaskSettings

A ColumnStatisticsTaskSettings object representing the settings for the column statistics task.

Type: ColumnStatisticsTaskSettings object

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400