|
Service Name and Purpose
|
Input Parameters
|
Result
|
||
|---|---|---|---|---|
|
Parameter Name
|
Base Type
|
Description
|
||
|
CreateDeploymentInfo — Creates information that is used in deployment for a provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
host
|
String
|
Specifies the host name.
|
||
|
platform
|
String
|
This property is for future use.
|
||
|
inputParams
|
Infotable
|
Specifies the input parameters that might be required for any particular deployer.
|
||
|
CreateProviderToDeployerMapping — Maps which deployer should deploy agents for a provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
If the service is executed successfully, it returns the name of the provider. Otherwise, it returns an exception.
|
|
deployerProviderName
|
String
|
Specifies the name of the provider that is created for the deployer.
|
||
|
deployerModelName
|
String
|
Specifies the name of the model for the deployer provider.
|
||
|
CreateQOSRule — Creates the Quality of Service rule.
|
name
|
String
|
Specifies the name of the Quality of Service rule.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
description
|
String
|
Specifies the description of the Quality of Service rule.
|
||
|
providerName
|
String
|
Specifies the name of the provider.
|
||
|
activityType
|
String
|
Specifies the type of activity as one of the following:
• Background
• Interactive
• Stateful
By default, this is set to Background.
|
||
|
metric
|
String
|
Depending on the value of activityType, specifies the value as one of the following out-of-the-box metrics:
• ExecutionTime
• WaitingTime
• WaitingJobs
• InteractiveSessionDurationLastHour
• ActiveSessions
If you have built customized metrics and added them to a constraint, you can specify its value here.
|
||
|
sythesizingFunction
|
String
|
Depending on the metric, specifies the value as one of the following out-of-the-box synthesizing functions:
• Average
• Count
• Sum
If you have built customized synthesizing functions and added them to a constraint, you can specify its value here.
|
||
|
addResourceMarginOperator
|
String
|
Specifies the margin operator to configure the rule to request for additional resources as one of the following:
• +
• -
• *
• /
|
||
|
addResourceMargin
|
Number
|
Specifies the numeric value that is used to operate on the metric value and compared against the threshold.
|
||
|
addResourceMarginType
|
String
|
Specifies the margin type value to configure the rule to request for additional resources as one of the following:
• Absolute
• Percent
By default, this is set to Percent.
|
||
|
addResourceThresholdOperator
|
String
|
Specifies one of the following out-of-the-box comparison operators:
• GreaterThan
• LessThan
If you have added the following threshold operators to a constraint, you can specify that here:
• =
• ≠
• ≤
• ≥
|
||
|
addResourceThreshold
|
Number
|
Specifies the threshold value.
|
||
|
addResourceThresholdParam
|
String
|
Specifies the threshold parameter based on the constraint that has been defined. The following out-of the box threshold parameters are available:
• AvailableDurationPerHour
• ActiveInstances
If you have built customized threshold parameters and added them to a constraint, you can specify its value here.
|
||
|
addResourceFrequency
|
Integer
|
Specifies the number of times that the rule must be consecutively met before firing a capacity increase request.
|
||
|
reduceResourceMarginOperator
|
String
|
Specifies the margin operator to configure the rule to request for reduction in resources as one of the following:
• +
• -
• *
• /
|
||
|
reduceResourceMargin
|
Number
|
Specifies the numeric value that is used to operate on the metric value and compared against the threshold.
|
||
|
reduceResourceMarginType
|
String
|
Specifies the margin type value to configure the rule to request for reduction in resources as one of the following:
• Absolute
• Percent
By default, this is set to Percent.
|
||
|
reduceResourceThresholdOperator
|
String
|
Specifies one of the following out-of-the-box comparison operators:
• GreaterThan
• LessThan
If you have added the following threshold operators to a constraint, you can specify that here:
• =
• ≠
• ≤
• ≥
|
||
|
reduceResourceThreshold
|
Number
|
Specifies the threshold value.
|
||
|
reduceResourceThresholdParam
|
String
|
Specifies the threshold parameter based on the constraint that has been defined. The following out-of the box threshold parameters are available:
• AvailableDurationPerHour
• ActiveInstances
If you have built customized threshold parameters and added them to a constraint, you can specify its value here.
|
||
|
reduceResourceFrequency
|
Integer
|
Specifies the number of times that the rule must be consecutively met before firing a capacity decrease request.
|
||
|
DeleteDeploymentInfo — Deletes the deployment information that was created for a particular provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
DeleteProviderToDeployerMapping — Deletes the provider to deployer mapping for the specified provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns a boolean value of true if the provider to deployer mapping is deleted for the specified provider.
|
|
DeleteQOSRule — Deletes the Quality of Service rule.
|
name
|
String
|
Specifies the name of the Quality of Service rule.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
Deploy — Deploys an agent for the specified provider by starting up an existing installation or deploying a new installation.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns a boolean value of true that indicates that the deployment is successfully completed.
|
|
GetCurrentSessions — Provides a list of all the currents active sessions in the system. The sessions can be either of the following:
• Background
• Stateful
• Interactive
|
—
|
—
|
—
|
Returns information about the current active sessions in the system in the form of an infotable that has the TW.AnalysisServices.SLADataShape data shape.
|
|
GetSessionHistory — Provides a list of active sessions between the specified duration. The sessions can be either of the following:
• Background
• Stateful
• Interactive
|
startTime
|
Datetime
|
Specifies the start time.
|
Returns information about the active sessions in the system in the specified time duration in the form of an infotable that has the TW.AnalysisServices.SLADataShape data shape.
|
|
endTime
|
Datetime
|
Specifies the end time.
|
||
|
maxCount
|
Number
|
Specifies the number of sessions that you want information for.
|
||
|
IsDeployable — Checks if a provider to deployer mapping exists for the specified provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns a boolean value of true if the provider to deployer mapping exists for that particular provider.
|
|
LoadQoSInitialData — Loads the set of out-of-the-box activity types, metrics, and, synthesizing functions. For more information, see Load Quality of Service Initial Data.
|
—
|
—
|
—
|
—
|
|
QueryDeploymentInfo — Returns deployment information that matches the query and the provider name.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns deployment information in the form of an infotable that has the TW.AnalysisServices.ProviderToDeployerMappingDatashape data shape.
|
|
query
|
Query
|
Specifies the query that includes what information is required about a particular provider.
|
||
|
QueryProviderToDeployerMapping — Returns provider to deployment mapping information that matches the query and the provider name.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns provider to deployer mapping information in the form of an infotable that has the TW.AnalysisServices.ProviderToDeployerMappingDatashape data shape.
|
|
query
|
Query
|
Specifies the query that includes what information is required about a particular provider to deployer mapping.
|
||
|
QueryQOSRules — Returns information about the Quality of Service rule that matches the query and the provider name.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns information about the Quality of Service rule in the form of an infotable that has the TW.AnalysisServices.SLADataShape data shape.
|
|
query
|
Query
|
Specifies the query that includes what information is required about a particular Quality of Service rule.
|
||
|
UpdateDeploymentInfo — Updates the information that is used in deployment for a provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
host
|
String
|
Specifies the host name.
|
||
|
platform
|
String
|
This property is for future use.
|
||
|
inputParams
|
Infotable
|
Specifies the input parameters that might be required for any particular deployer.
|
||
|
UpdateProviderToDeployerMapping — Updates information that is specified while creating a provider to deployer mapping.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
deployerProviderName
|
String
|
Specifies the name of the provider that is created for the deployer.
|
||
|
deployerModelName
|
String
|
Specifies the name of the model for the deployer provider.
|
||
|
UpdateQOSRule — Updates the Quality of Service rule.
|
name
|
String
|
Specifies the name of the Quality of Service rule.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
|
description
|
String
|
Specifies the description of the Quality of Service rule.
|
||
|
providerName
|
String
|
Specifies the name of the provider.
|
||
|
activityType
|
String
|
Specifies the type of activity as one of the following:
• Background
• Interactive
• Stateful
By default, this is set to Background.
|
||
|
metric
|
String
|
Depending on the value of activityType, specifies the value as one of the following out-of-the-box metrics:
• ExecutionTime
• WaitingTime
• WaitingJobs
• InteractiveSessionDurationLastHour
• ActiveSessions
If you have built customized metrics and added them to a constraint, you can specify its value here.
|
||
|
sythesizingFunction
|
String
|
Depending on the metric, specifies the value as one of the following out-of-the-box synthesizing functions:
• Average
• Count
• Sum
If you have built customized synthesizing functions and added them to a constraint, you can specify its value here.
|
||
|
addResourceMarginOperator
|
String
|
Specifies the margin operator to configure the rule to request for additional resources as one of the following:
• +
• -
• *
• /
|
||
|
addResourceMargin
|
Number
|
Specifies the numeric value that is used to operate on the metric value and compared against the threshold.
|
||
|
addResourceMarginType
|
String
|
Specifies the margin type value to configure the rule to request for additional resources as one of the following:
• Absolute
• Percent
By default, this is set to Percent.
|
||
|
addResourceThresholdOperator
|
String
|
Specifies one of the following out-of-the-box comparison operators:
• GreaterThan
• LessThan
If you have added the following threshold operators to a constraint, you can specify that here:
• =
• ≠
• ≤
• ≥
|
||
|
addResourceThreshold
|
Number
|
Specifies the threshold value.
|
||
|
addResourceThresholdParam
|
String
|
Specifies the threshold parameter based on the constraint that has been defined. The following out-of the box threshold parameters are available:
• AvailableDurationPerHour
• ActiveInstances
If you have built customized threshold parameters and added them to a constraint, you can specify its value here.
|
||
|
addResourceFrequency
|
Integer
|
Specifies the number of times that the rule must be consecutively met before firing a capacity increase request.
|
||
|
reduceResourceMarginOperator
|
String
|
Specifies the margin operator to configure the rule to request for reduction in resources as one of the following:
• +
• -
• *
• /
|
||
|
reduceResourceMargin
|
Number
|
Specifies the numeric value that is used to operate on the metric value and compared against the threshold.
|
||
|
reduceResourceMarginType
|
String
|
Specifies the margin type value to configure the rule to request for reduction in resources as one of the following:
• Absolute
• Percent
By default, this is set to Percent.
|
||
|
reduceResourceThresholdOperator
|
String
|
Specifies one of the following out-of-the-box comparison operators:
• GreaterThan
• LessThan
If you have added the following threshold operators to a constraint, you can specify that here:
• =
• ≠
• ≤
• ≥
|
||
|
reduceResourceThreshold
|
Number
|
Specifies the threshold value.
|
||
|
reduceResourceThresholdParam
|
String
|
Specifies the threshold parameter based on the constraint that has been defined. The following out-of the box threshold parameters are available:
• AvailableDurationPerHour
• ActiveInstances
If you have built customized threshold parameters and added them to a constraint, you can specify its value here.
|
||
|
reduceResourceFrequency
|
Integer
|
Specifies the number of times that the rule must be consecutively met before firing a capacity decrease request.
|
||