DATASOURCE::DTS::JobMonitorRules

0.0.201

DATASOURCE::DTS::JobMonitorRules is used to query the alert rules of Data Transmission Service (DTS) tasks.

Syntax

{
  "Type": "DATASOURCE::DTS::JobMonitorRules",
  "Properties": {
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint

Property

Type

Required

Editable

Description

Constraint

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return value

Fn::GetAtt

JobMonitorRules: the alert rules of the data migration, data synchronization, or change tracking tasks.
DtsJobIds: the IDs of the data migration, data synchronization, or change tracking tasks.

Property	Type	Description	Constraint

Property	Type	Description	Constraint
DtsJobIds	List	The IDs of the data migration, data synchronization, or change tracking tasks.	None.
JobMonitorRules	List	The alert rules of the data migration, data synchronization, or change tracking tasks.	None.
Type	String	The type of the alert rule.	Valid values: delay: If the latency of the task exceeds the specified threshold, an alert is triggered. error: If an exception occurs, an alert is triggered. full_timeout: If the duration of the full data migration or synchronization module exceeds the specified threshold, an alert is triggered. warn: If the task is complete but the result is not as expected, an alert is triggered.
JobType	String	The task type of the DTS instance.	Valid values: normal: data migration or data synchronization task. full_check: associated full data verification task. etl_check: associated incremental data verification task.
State	String	Specifies whether to enable the alert rule.	Return value: Y: enables the alert rule. N: disables the alert rule.
Phone	String	The mobile number that receives alert notifications when the alert is triggered.	None.
Times	String	The number of statistical periods of the incremental data verification task.	None.
Period	String	The statistical period of the incremental data verification task. Unit: minutes.	None.
NoticeValue	String	The alert threshold.	None.
DelayRuleTime	String	The threshold for triggering latency alerts. Unit: seconds.	None.
JobId	String	The ID of the task.	None.

Examples

YAML

JSON

YAML

            
            
          
ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DTS::JobMonitorRules
    Properties: {}
Outputs:
  JobMonitorRules:
    Description: The list of job monitor rules.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - JobMonitorRules
  DtsJobIds:
    Description: The list of dts job IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DtsJobIds

JSON

            
            
          
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DTS::JobMonitorRules",
      "Properties": {
      }
    }
  },
  "Outputs": {
    "JobMonitorRules": {
      "Description": "The list of job monitor rules.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "JobMonitorRules"
        ]
      }
    },
    "DtsJobIds": {
      "Description": "The list of dts job IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DtsJobIds"
        ]
      }
    }
  }
}
                        