1. 接口描述
接口请求域名: igtm.tencentcloudapi.com 。
新增监控器
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateMonitor。 |
Version | 是 | String | 公共参数,本接口取值:2023-10-24。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
MonitorName | 是 | String | 监控器名称 示例值:监控器1 |
CheckProtocol | 是 | String | 探测协议,可选值 PING TCP HTTP HTTPS 示例值:PING |
CheckInterval | 是 | Integer | 检查间隔(秒),可选值有15 60 120 300 示例值:60 |
Timeout | 是 | Integer | 超时时间,单位秒,可选值为2 3 5 10 示例值:5 |
FailTimes | 是 | Integer | 重试次数,可选值为 0,1,2 示例值:1 |
FailRate | 是 | Integer | 失败比例,取值为 20 30 40 50 60 70 80 100,默认值50 示例值:50 |
DetectorStyle | 是 | String | 监控节点类型,可选值有AUTO INTERNAL OVERSEAS IPV6 ALL 示例值:AUTO |
DetectorGroupIds.N | 是 | Array of Integer | 探测器组id列表以,分隔 示例值:[5,6,7] |
PingNum | 否 | Integer | PING 包数目,当CheckProtocol=ping时必填,可选值有20 50 100 示例值:20 |
TcpPort | 否 | Integer | 检查端口,可选值在1-65535之间 示例值:80 |
Host | 否 | String | Host 设置,默认为业务域名 示例值:www.dnspod.com |
Path | 否 | String | URL 路径,默认为“/” 示例值:/index.html |
ReturnCodeThreshold | 否 | Integer | 返回错误码阈值, 可选值为 400 和 500, 默认值500 示例值:500 |
EnableRedirect | 否 | String | 跟随 3XX 重定向 ,不开启为 DISABLED, 开启为 ENABLED,默认不开启 示例值:DISABLED |
EnableSni | 否 | String | 启用 SNI,不开启为 DISABLED, 开启为 ENABLED,默认不开启 示例值:DISABLED |
PacketLossRate | 否 | Integer | 丢包率告警阈值,当CheckProtocol=ping时必填取值为10 30 50 80 90 100 示例值:50 |
ContinuePeriod | 否 | Integer | 持续周期数,可选值1-5 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MonitorId | Integer | 监控器id 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 tcp监控
tcp监控
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMonitor
<公共请求参数>
{
"MonitorName": "监控tcp",
"CheckProtocol": "TCP",
"CheckInterval": 60,
"Timeout": 2,
"FailTimes": 0,
"FailRate": 50,
"DetectorStyle": "AUTO",
"DetectorGroupIds": [
1
],
"TcpPort": 80
}
输出示例
{
"Response": {
"MonitorId": 92,
"RequestId": "ea6eaf52-428b-4d1d-b7d7-1712cf508124"
}
}
示例2 http监控
http监控
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMonitor
<公共请求参数>
{
"MonitorName": "监控http",
"CheckProtocol": "HTTP",
"CheckInterval": 60,
"Timeout": 2,
"FailTimes": 0,
"FailRate": 50,
"DetectorStyle": "AUTO",
"DetectorGroupIds": [
1
],
"TcpPort": 80,
"ReturnCodeThreshold": 400,
"EnableRedirect": "DISABLED",
"EnableSni": "DISABLED"
}
输出示例
{
"Response": {
"MonitorId": 93,
"RequestId": "506ffb0f-a5d4-4b8e-8ce8-14e512ec731e"
}
}
示例3 新增监控器
新增监控器
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMonitor
<公共请求参数>
{
"MonitorName": "监控器1",
"DetectorGroupIds": [
5,
6,
7
],
"CheckInterval": 60,
"PacketLossRate": 20,
"CheckProtocol": "HTTP",
"FailRate": 20,
"TcpPort": 80,
"EnableSni": "DISABLED",
"PingNum": 10,
"ReturnCodeThreshold": 500,
"Host": "test.com",
"Timeout": 50,
"Path": "/index.html",
"FailTimes": 2,
"DetectorStyle": "AUTO"
}
输出示例
{
"Response": {
"MonitorId": 1,
"RequestId": "ea6eaf52-428b-4d1d-b7d7-1712cf508124"
}
}
示例4 监控器ping协议
监控器ping协议
输入示例
POST / HTTP/1.1
Host: igtm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMonitor
<公共请求参数>
{
"MonitorName": "监控ping",
"CheckProtocol": "PING",
"CheckInterval": 60,
"Timeout": 2,
"FailTimes": 0,
"FailRate": 50,
"DetectorStyle": "AUTO",
"DetectorGroupIds": [
1
],
"PingNum": 20,
"PacketLossRate": 10
}
输出示例
{
"Response": {
"MonitorId": 91,
"RequestId": "93ba54c1-a533-42bb-aab5-458aef4b1666"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.CreateError | 创建失败。 |
FailedOperation.CreateMonitorFailed | 创建监控器失败 |
FailedOperation.ExceededLimit | 超出限额。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.UnauthorizedError | 资源未授权。 |
UnsupportedOperation.UserNotFound | 用户未登录,缺少Uin参数。 |