调用CreateSiteMonitor接口创建一次性探测任务。
接口说明
仅开通网络分析与监控的阿里云账号，才能创建一次性探测任务。
本文将提供一个示例，创建一次性探测任务，该探测任务的名称为task1，探测地址为http://www.aliyun.com，探测类型为HTTP，探测点数量为1。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cms:CreateInstantSiteMonitor | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Address | string | 是 | 探测任务的 URL 或 IP 地址。 | http://www.aliyun.com |
| TaskType | string | 是 | 探测任务的类型。 目前探测任务的类型包括：HTTP、PING、TCP、UDP 和 DNS。 | HTTP |
| TaskName | string | 是 | 探测任务的名称。 长度 4~100 个字符，取值可包含英文字母、数字、下划线（_）和汉字。 | task1 |
| IspCities | string | 否 | 探测点信息。如果该参数取值为空，则系统随机选择 3 个探测点。 格式为 关于如何获取探测点信息，请参见 DescribeSiteMonitorISPCityList 。 说明
IspCities和RandomIspCity必须二选一。
| [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] |
| OptionsJson | string | 否 | 探测任务对应协议类型的高级扩展选项。不同探测任务的协议类型对应不同的扩展选项。 | {"time_out":5000} |
| RandomIspCity | integer | 否 | 探测点的数量。 说明
IspCities和RandomIspCity必须二选一。- 如果您设置了参数RandomIspCity，参数IspCities自动失效。 | 1 |
TaskType 的高级参数说明
TaskType中 HTTP、PING、TCP、UDP 和 DNS 的高级参数的设置方法如下表所示。
- 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 | 如果提供用户名，则会在 HTTP 请求中携带 BasicAuth header。 |
| password | String | HTTP 请求验证密码。 |
| time_out | int | 超时时间。单位：毫秒。默认值：30000。 |
| 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。 |
- 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 为普通字符串。 |
- 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 列表与期望值列表有交集（交集不为空）。 |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "68192f5d-0d45-4b98-9724-892813f86c71",
"Success": "true",
"CreateResultList": [
{
"TaskId": "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
"TaskName": "task1"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | InvalidQueryParameter | %s |
| 400 | IllegalAddress | Illegal HTTP address |
| 400 | OperationError | Operation failed |
| 400 | TaskNotExists | Task does not exist |
| 400 | OperatorInvalid | Operator invalid |
| 400 | OperatorCityInvalid | Operator City invalid |
| 400 | NameRepeat | Task name repeat |
| 400 | CreateAlarmError | Create alarm error |
| 400 | NameNotExists | Task name not exists |
| 400 | IllegalAddress | Probe address not allowed |
| 401 | AccessDeniedException | You donot have sufficient access to perform this action. |
| 402 | LimitExceeded | The quota for this customer had been reached. |
| 403 | %s | %s |
| 403 | Forbidden | %s |
| 406 | ExceedingQuota | Exceeding quota limits. |
| 500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-06-22 | OpenAPI 错误码发生变更 | 查看变更详情 |