ModifySiteMonitor_云监控_API调试

云监控

2019-01-01

获取元数据获取 SDK 服务区域

找不到 API ? 点击反馈吧

参数配置

高级配置

输入参数

只看必填

Address监控任务的URL或IP地址

TaskId监控任务ID

TaskName监控任务名称

Interval监控频率

IspCities探针信息

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

AlertIds报警规则ID

IntervalUnit监控指标的单位

CustomSchedule自定义探测周期

文档

调用结果

SDK 示例

CLI示例

相关示例

调用历史

错误码

流控

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

请求参数

字段名称	字段详情
Addressstring	监控任务的 URL 或 IP 地址。示例值:http://www.aliyun.com
TaskIdstring	监控任务 ID。示例值:2c8dbdf9-a3ab-46a1-85a4-f094965e****
TaskNamestring	监控任务名称。长度 4~100 个字符，取值可包含英文字母、数字、下划线（_）和汉字。示例值:HanZhou_ECS2
Intervalstring	监控频率。取值：1、5、15。单位：分钟。默认值：1。示例值:1
IspCitiesstring	探针信息。格式为 JSONArray，例如：`[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`，`city`分别对应北京、杭州和青岛。展开详情示例值:[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJsonstring	监控任务对应协议类型的高级扩展选项。不同监控任务的协议类型对应不同的扩展选项。示例值:{"time_out":5000}
AlertIdsstring	报警规则 ID。云监控中已存在的报警规则 ID，可通过 DescribeMetricRuleList 接口查询，请参见 DescribeMetricRuleList 。示例值:49f7c317-7645-4cc9-94fd-ea42e122****
IntervalUnitstring	监控指标的单位。展开详情示例值:ms
CustomSchedulestring	自定义探测周期。只能选择周一至周日的某个时间段进行探测。示例值:{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}

请求说明

站点监控支持以下 8 种任务类型，每种任务类型对应的扩展参数（OptionsJson）如下表所示。

HTTP

名称	类型	描述
http_method	String	HTTP 请求方式，支持三种：GET、POST、HEAD。默认值：GET。
header	String	换行符（\n）分隔的自定义 HTTP header。每行 header 格式需符合 HTTP 协议（使用英文冒号分隔的键值）。
cookie	String	cookie 和 HTTP 请求标准的写法一致。
request_content	String	请求内容。支持两种格式：JSON 和表单。不提供时，请求中不含正文。
response_content	String	期望的响应内容。探测时会在 HTTP 服务器返回的前 64 个字节进行检查。
match_rule	String	0：响应中不含 response_content 时，探测成功。 1：响应中含 response_content 时，探测成功。
username	String	如果提供 username，则会在 HTTP 请求中携带 BasicAuth header。
password	String	HTTP 请求验证密码。
time_out	int	超时时间。单位：毫秒。默认值：5 。
max_redirect	int	大跳转次数。ECS 探针默认 5 次，运营商探针默认 2 次。如果需要禁止跳转，则将该参数设置为：0。取值范围：0~50 。

PING

名称	类型	描述
failure_rate	int	当 PING 失败率超过该参数时，探测失败，返回 610（PingAllFail）或 615（PingPartialFail）。默认值：0.1。
ping_num	int	PING 次数，默认值：20。取值范围：1~100。

DNS

名称	类型	描述
dns_server	string	DNS 服务器地址，可以为域名或 IP 地址。
dns_type	string	DNS 查询类型。取值：A、NS、CNAME、MX、TXT、ANY。
expect_value	string	英文空白符分隔的期望值列表。
match_rule	string	期望值列表与 DNS 列表的关系，当不满足指定关系时，探测失败。空字符串或 IN_DNS：期望值列表是 DNS 列表的子集。 DNS_IN：DNS 列表是期望值列表的子集。 EQUAL：DNS 列表与期望值列表相等。 ANY：DNS 列表与期望值列表有交集（交集不为空）。

FTP

名称	类型	描述
port	int	FTP 服务器端口号。如果不提供，则使用默认值。FTP 默认值：21，FTPs 默认值：990。
username	string	FTP 用户名。如果未提供，则匿名登录。
password	string	FTP 密码。

POP3/SMTP

名称	类型	描述
port	int	POP3 服务器端口号。POP3 默认值：110，POP3s 默认值：995。
username	string	POP3/SMTP 的用户名。
password	string	POP3/SMTP 的密码。

TCP/UDP

名称	类型	描述
port	int	TCP/UDP 服务器的端口。
request_content	string	请求内容。当 request_format 为 hex 时，request_content 内容为十六进制紧凑格式。
request_format	string	当 request_format 为其他值时，request_content 作为普通字符串发送给 TCP/UDP 服务器。
response_content	string	响应内容。当 TCP/UDP 服务器返回的内容中不含 response_content 时，探测失败。当 response_format 为 hex 时，response_content 中的内容为十六进制紧凑格式。当 response_content 为其他值时，response_content 为普通字符串。

返回参数

字段名称	字段详情
Codestring	状态码。展开详情示例值:200
Messagestring	返回信息。示例值:successful
RequestIdstring	请求 ID。示例值:68192f5d-0d45-4b98-9724-892813f86c71
Successstring	操作是否成功。取值：展开详情示例值:true
Dataobject	修改任务结果详情。

变更历史

	变更时间	变更内容概要	操作
	2025-04-01	变更错误码403 新增错误码404
	2025-02-13	变更错误码400
	2025-02-12	变更错误码500
	2023-08-04	新增请求参数CustomSchedule
	2023-06-19	变更错误码403

1
2
10 条/页