SiteMonitor

This resource provides a site monitor resource and it can be used to monitor public endpoints and websites. Details at https://www.alibabacloud.com/help/doc-detail/67907.htm

Available in 1.72.0+

Create a SiteMonitor Resource

new SiteMonitor(name: string, args: SiteMonitorArgs, opts?: CustomResourceOptions);

def SiteMonitor(resource_name, opts=None, address=None, alert_ids=None, interval=None, isp_cities=None, options_json=None, task_name=None, task_type=None, __props__=None);

func NewSiteMonitor(ctx *Context, name string, args SiteMonitorArgs, opts ...ResourceOption) (*SiteMonitor, error)

public SiteMonitor(string name, SiteMonitorArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args SiteMonitorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SiteMonitorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SiteMonitorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

SiteMonitor Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The SiteMonitor resource accepts the following input properties:

Address string: The URL or IP address monitored by the site monitoring task.
TaskName string: The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
TaskType string: The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
AlertIds List<string>: The IDs of existing alert rules to be associated with the site monitoring task.
Interval int: The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
IspCities List<Pulumi.AliCloud.Cms.Inputs.SiteMonitorIspCityArgs>: The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
OptionsJson string: The extended options of the protocol of the site monitoring task. The options vary according to the protocol.

Address string: The URL or IP address monitored by the site monitoring task.
TaskName string: The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
TaskType string: The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
AlertIds []string: The IDs of existing alert rules to be associated with the site monitoring task.
Interval int: The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
IspCities []SiteMonitorIspCity: The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
OptionsJson string: The extended options of the protocol of the site monitoring task. The options vary according to the protocol.

address string: The URL or IP address monitored by the site monitoring task.
taskName string: The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
taskType string: The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
alertIds string[]: The IDs of existing alert rules to be associated with the site monitoring task.
interval number: The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
ispCities SiteMonitorIspCity[]: The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
optionsJson string: The extended options of the protocol of the site monitoring task. The options vary according to the protocol.

address str: The URL or IP address monitored by the site monitoring task.
task_name str: The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
task_type str: The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
alert_ids List[str]: The IDs of existing alert rules to be associated with the site monitoring task.
interval float: The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
isp_cities List[SiteMonitorIspCity]: The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
options_json str: The extended options of the protocol of the site monitoring task. The options vary according to the protocol.

Outputs

All input properties are implicitly available as output properties. Additionally, the SiteMonitor resource produces the following output properties:

CreateTime string
Id string: The provider-assigned unique ID for this managed resource.
TaskState string
UpdateTime string

CreateTime string
Id string: The provider-assigned unique ID for this managed resource.
TaskState string
UpdateTime string

createTime string
id string: The provider-assigned unique ID for this managed resource.
taskState string
updateTime string

create_time str
id str: The provider-assigned unique ID for this managed resource.
task_state str
update_time str

Look up an Existing SiteMonitor Resource

Get an existing SiteMonitor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SiteMonitorState, opts?: CustomResourceOptions): SiteMonitor

static get(resource_name, id, opts=None, address=None, alert_ids=None, create_time=None, interval=None, isp_cities=None, options_json=None, task_name=None, task_state=None, task_type=None, update_time=None, __props__=None);

func GetSiteMonitor(ctx *Context, name string, id IDInput, state *SiteMonitorState, opts ...ResourceOption) (*SiteMonitor, error)

public static SiteMonitor Get(string name, Input<string> id, SiteMonitorState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Address string: The URL or IP address monitored by the site monitoring task.
AlertIds List<string>: The IDs of existing alert rules to be associated with the site monitoring task.
CreateTime string
Interval int: The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
IspCities List<Pulumi.AliCloud.Cms.Inputs.SiteMonitorIspCityArgs>: The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
OptionsJson string: The extended options of the protocol of the site monitoring task. The options vary according to the protocol.
TaskName string: The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
TaskState string
TaskType string: The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
UpdateTime string

Address string: The URL or IP address monitored by the site monitoring task.
AlertIds []string: The IDs of existing alert rules to be associated with the site monitoring task.
CreateTime string
Interval int: The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
IspCities []SiteMonitorIspCity: The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
OptionsJson string: The extended options of the protocol of the site monitoring task. The options vary according to the protocol.
TaskName string: The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
TaskState string
TaskType string: The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
UpdateTime string

address string: The URL or IP address monitored by the site monitoring task.
alertIds string[]: The IDs of existing alert rules to be associated with the site monitoring task.
createTime string
interval number: The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
ispCities SiteMonitorIspCity[]: The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
optionsJson string: The extended options of the protocol of the site monitoring task. The options vary according to the protocol.
taskName string: The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
taskState string
taskType string: The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
updateTime string

address str: The URL or IP address monitored by the site monitoring task.
alert_ids List[str]: The IDs of existing alert rules to be associated with the site monitoring task.
create_time str
interval float: The monitoring interval of the site monitoring task. Unit: minutes. Valid values: 1, 5, and 15. Default value: 1.
isp_cities List[SiteMonitorIspCity]: The detection points in a JSON array. For example, [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] indicates the detection points in Beijing, Hangzhou, and Qingdao respectively. You can call the DescribeSiteMonitorISPCityList operation to query detection point information. If this parameter is not specified, three detection points will be chosen randomly for monitoring.
options_json str: The extended options of the protocol of the site monitoring task. The options vary according to the protocol.
task_name str: The name of the site monitoring task. The name must be 4 to 100 characters in length. The name can contain the following types of characters: letters, digits, and underscores.
task_state str
task_type str: The protocol of the site monitoring task. Currently, site monitoring supports the following protocols: HTTP, Ping, TCP, UDP, DNS, SMTP, POP3, and FTP.
update_time str

Supporting Types

SiteMonitorIspCity

See the input and output API doc for this type.

City string
Isp string

City string
Isp string

city string
isp string

city str
isp str

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud