调用BatchCreateInstantSiteMonitor接口批量创建站点监控任务。
本文将提供一个示例,创建一个站点监控任务HangZhou_ECS1
,该任务的监控地址为https://www.aliyun.com
,监控类型为HTTP
。返回结果显示,创建站点监控任务成功,该站点监控任务的名称为HangZhou_ECS1
,ID为679fbe4f-b80b-4706-91b2-5427b43e****
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | BatchCreateInstantSiteMonitor | 要执行的操作,取值:BatchCreateInstantSiteMonitor。 |
TaskList.N.Address | String | 否 | https://www.aliyun.com | 站点监控任务的URL或IP地址。
说明 至少需要创建一条站点监控任务,且
Address 、
TaskName 和
TaskType 必须设置。
|
TaskList.N.IspCities | String | 否 | [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] | 探测点信息。如果该参数取值为空,则系统随机选择3个探测点。 格式为 关于如何获取探测点信息,请参见DescribeSiteMonitorISPCityList。 |
TaskList.N.OptionsJson | String | 否 | {"time_out":5000} | 站点监控任务对应协议类型的高级扩展选项。不同探测任务的协议类型对应不同的扩展选项。 |
TaskList.N.TaskName | String | 否 | HangZhou_ECS1 | 站点监控任务的名称。 长度4~100个字符,取值可包含英文字母、数字和短划线(_)。
说明 至少需要创建一条站点监控任务,且
Address 、
TaskName 和
TaskType 必须设置。
|
TaskList.N.TaskType | String | 否 | HTTP | 监控任务的监控类型。 目前站点监控任务的类型包括:HTTP、PING、TCP、UDP、DNS、SMTP、POP3、FTP。
说明 至少需要创建一条站点监控任务,且
Address 、
TaskName 和
TaskType 必须设置。
|
关于公共请求参数的详情,请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 7AE72720-2C96-5446-9F2B-308C7CEDFF1A | 请求ID。 |
Message | String | successful | 返回信息。 |
Success | Boolean | true | 操作是否成功。取值:
|
Data | Array of Data | 站点监控任务信息。 |
|
TaskName | String | HangZhou_ECS1 | 站点监控任务名称。 |
TaskId | String | 679fbe4f-b80b-4706-91b2-5427b43e**** | 站点监控任务ID。 |
Code | String | 200 | 状态码。
说明 200表示成功。
|
示例
请求示例
http(s)://[Endpoint]/?Action=BatchCreateInstantSiteMonitor
&TaskList=[{"Address":"https://www.aliyun.com","TaskName":"HangZhou_ECS1","TaskType":"HTTP"}]
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<BatchCreateInstantSiteMonitorResponse>
<RequestId>7AE72720-2C96-5446-9F2B-308C7CEDFF1A</RequestId>
<Message>successful</Message>
<Data>
<taskName>HangZhou_ECS1</taskName>
<taskId>679fbe4f-b80b-4706-91b2-5427b43e****</taskId>
</Data>
<Code>200</Code>
<Success>true</Success>
</BatchCreateInstantSiteMonitorResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "7AE72720-2C96-5446-9F2B-308C7CEDFF1A",
"Message" : "successful",
"Data" : [ {
"taskName" : "HangZhou_ECS1",
"taskId" : "679fbe4f-b80b-4706-91b2-5427b43e****"
} ],
"Code" : "200",
"Success" : true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ParameterInvalid | The parameter is missing or invalid. %s | 参数缺失或者参数无效。 |
404 | ResourceNotFound | The specified resource is not found. | 未找到指定资源。 |
429 | ResourceOverLimit | The resource has exceeded the limit. %s | 超过数量限制。 |
访问错误中心查看更多错误码。