全部产品
Search
文档中心

资源编排:ALIYUN::CMS::SiteMonitor

更新时间:Jul 26, 2024

ALIYUN::CMS::SiteMonitor类型用于创建站点监控的监控任务。

语法

{
  "Type": "ALIYUN::CMS::SiteMonitor",
  "Properties": {
    "Address": String,
    "OptionsJson": String,
    "TaskName": String,
    "TaskType": String,
    "IspCities": List,
    "Interval": Integer,
    "AlertIds": List
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

Address

String

监控任务的URL或IP地址。

TaskName

String

监控任务名称。

长度为4~100个字符,可包含英文字母、汉字、数字和下划线(_)。

TaskType

String

监控任务类型。

取值:

  • HTTP(s)

  • PING

  • TCP

  • UDP

  • DNS

  • SMTP

  • POP3

  • FTP

AlertIds

List

报警规则ID。

您可以调用DescribeMetricRuleList接口查询云监控中已存在的报警规则ID。

Interval

Integer

监控频率。

取值:

  • 1(默认值)

  • 5

  • 15

单位:分钟。

IspCities

List

探针信息。

如果该参数取值为空,则系统随机选择3个探测点。

更多信息,请参见IspCities属性

OptionsJson

String

监控任务对应协议类型的高级扩展选项。不同监控任务的协议类型对应不同的扩展选项。

IspCities语法

"IspCities": [
  {
    "Isp": String,
    "City": String
  }
]

IspCities属性

属性名称

类型

必须

允许更新

描述

约束

City

String

探测的城市名称或ID。城市名称支持模糊查询。

Isp

String

探测的运营商名称或ID。运营商名称支持模糊查询。

更多信息,请参见DescribeSiteMonitorISPCityList

返回值

Fn::GetAtt

TaskId:监控任务ID。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  SiteMonitor:
    Type: ALIYUN::CMS::SiteMonitor
    Properties:
      Address: aliyun.com
      TaskName: DemoTask
      TaskType: http
Outputs:
  TaskId:
    Description: The ID of the site monitoring task.
    Value:
      Fn::GetAtt:
        - SiteMonitor
        - TaskId            

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "SiteMonitor": {
      "Type": "ALIYUN::CMS::SiteMonitor",
      "Properties": {
        "Address": "aliyun.com",
        "TaskName": "DemoTask",
        "TaskType": "http"
      }
    }
  },
  "Outputs": {
    "TaskId": {
      "Description": "The ID of the site monitoring task.",
      "Value": {
        "Fn::GetAtt": [
          "SiteMonitor",
          "TaskId"
        ]
      }
    }
  }
}