All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::DNS::MonitorConfig

Last Updated:Apr 09, 2026

The ALIYUN::DNS::MonitorConfig resource creates a health check.

Syntax

{
  "Type": "ALIYUN::DNS::MonitorConfig",
  "Properties": {
    "AddrPoolId": String,
    "EvaluationCount": Integer,
    "IspCityNode": List,
    "Interval": Integer,
    "MonitorExtendInfo": Map,
    "ProtocolType": String,
    "Timeout": Integer
  }
}

Properties

Parameter

Type

Required

Updatable

Description

Constraints

AddrPoolId

String

Yes

No

The ID of the address pool.

None

EvaluationCount

Integer

Yes

Yes

The evaluation count for the health check.

Valid range: 1 to 3.

Interval

Integer

Yes

Yes

The interval between health checks, in seconds.

Valid range: 1 to 60.

IspCityNode

List

Yes

Yes

A list of ISP city nodes.

Maximum length: 50. For more information, see IspCityNode properties.

MonitorExtendInfo

Map

Yes

Yes

The extended information for the health check.

None

ProtocolType

String

Yes

Yes

The protocol for the health check.

None

Timeout

Integer

Yes

Yes

The timeout for the health check, in milliseconds.

Valid range: 1 to 10,000.

IspCityNode syntax

"IspCityNode": [
  {
    "CityCode": String,
    "IspCode": String
  }
]

IspCityNode properties

Parameter

Type

Required

Updatable

Description

Constraints

CityCode

String

No

Yes

The city code.

None

IspCode

String

No

Yes

The ISP code.

None

Return values

Fn::GetAtt

MonitorConfigId: The ID of the health check configuration.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  IspCityNode:
    AssociationPropertyMetadata:
      Parameters:
        CityCode:
          Type: String
          Description: The city code.
          Required: false
        IspCode:
          Type: String
          Description: The ISP code.
          Required: false
    AssociationProperty: List[Parameters]
    Type: Json
    Description: A list of ISP city nodes.
    Required: true
    MaxLength: 50
  Timeout:
    Type: Number
    Description: The timeout for the health check, in milliseconds.
    Required: true
    MinValue: 1
    MaxValue: 10000
  ProtocolType:
    Type: String
    Description: The protocol for the health check.
    Required: true
  AddrPoolId:
    Type: String
    Description: The ID of the address pool.
    Required: true
  EvaluationCount:
    Type: Number
    Description: The evaluation count for the health check.
    Required: true
    MinValue: 1
    MaxValue: 3
  MonitorExtendInfo:
    Type: Json
    Description: The extended information for the health check.
    Required: true
  Interval:
    Type: Number
    Description: The interval between health checks, in seconds.
    Required: true
    MinValue: 1
    MaxValue: 60
Resources:
  MonitorConfig:
    Type: ALIYUN::DNS::MonitorConfig
    Properties:
      IspCityNode:
        Ref: IspCityNode
      Timeout:
        Ref: Timeout
      ProtocolType:
        Ref: ProtocolType
      AddrPoolId:
        Ref: AddrPoolId
      EvaluationCount:
        Ref: EvaluationCount
      MonitorExtendInfo:
        Ref: MonitorExtendInfo
      Interval:
        Ref: Interval
Outputs:
  MonitorConfigId:
    Description: The ID of the health check configuration.
    Value:
      Fn::GetAtt:
        - MonitorConfig
        - MonitorConfigId
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "IspCityNode": {
      "AssociationPropertyMetadata": {
        "Parameters": {
          "CityCode": {
            "Type": "String",
            "Description": "The city code.",
            "Required": false
          },
          "IspCode": {
            "Type": "String",
            "Description": "The ISP code.",
            "Required": false
          }
        }
      },
      "AssociationProperty": "List[Parameters]",
      "Type": "Json",
      "Description": "A list of ISP city nodes.",
      "Required": true,
      "MaxLength": 50
    },
    "Timeout": {
      "Type": "Number",
      "Description": "The timeout for the health check, in milliseconds.",
      "Required": true,
      "MinValue": 1,
      "MaxValue": 10000
    },
    "ProtocolType": {
      "Type": "String",
      "Description": "The protocol for the health check.",
      "Required": true
    },
    "AddrPoolId": {
      "Type": "String",
      "Description": "The ID of the address pool.",
      "Required": true
    },
    "EvaluationCount": {
      "Type": "Number",
      "Description": "The evaluation count for the health check.",
      "Required": true,
      "MinValue": 1,
      "MaxValue": 3
    },
    "MonitorExtendInfo": {
      "Type": "Json",
      "Description": "The extended information for the health check.",
      "Required": true
    },
    "Interval": {
      "Type": "Number",
      "Description": "The interval between health checks, in seconds.",
      "Required": true,
      "MinValue": 1,
      "MaxValue": 60
    }
  },
  "Resources": {
    "MonitorConfig": {
      "Type": "ALIYUN::DNS::MonitorConfig",
      "Properties": {
        "IspCityNode": {
          "Ref": "IspCityNode"
        },
        "Timeout": {
          "Ref": "Timeout"
        },
        "ProtocolType": {
          "Ref": "ProtocolType"
        },
        "AddrPoolId": {
          "Ref": "AddrPoolId"
        },
        "EvaluationCount": {
          "Ref": "EvaluationCount"
        },
        "MonitorExtendInfo": {
          "Ref": "MonitorExtendInfo"
        },
        "Interval": {
          "Ref": "Interval"
        }
      }
    }
  },
  "Outputs": {
    "MonitorConfigId": {
      "Description": "The ID of the health check configuration.",
      "Value": {
        "Fn::GetAtt": [
          "MonitorConfig",
          "MonitorConfigId"
        ]
      }
    }
  }
}