调用BatchCreateInstantSiteMonitor批量创建站点监控任务-云监控-阿里云

调用BatchCreateInstantSiteMonitor接口批量创建站点监控任务。

接口说明

本文将提供一个示例，创建一个站点监控任务HangZhou_ECS1，该任务的监控地址为https://www.aliyun.com，监控类型为HTTP。返回结果显示，创建站点监控任务成功，该站点监控任务的名称为HangZhou_ECS1，ID 为679fbe4f-b80b-4706-91b2-5427b43e****。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cms:BatchCreateInstantSiteMonitor	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
TaskList	array<object>	是	站点监控任务列表。说明至少需要创建一条站点监控任务，且`Address`、`TaskName`和`TaskType`必须设置。
	object	是	站点监控任务列表。
Address	string	否	站点监控任务的 URL 或 IP 地址。说明至少需要创建一条站点监控任务，且`Address`、`TaskName`和`TaskType`必须设置。	https://www.aliyun.com
IspCities	string	否	探测点信息。如果该参数取值为空，则系统随机选择 3 个探测点。格式为`JSONArray`，例如：`[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`，分别对应北京、杭州、青岛。关于如何获取探测点信息，请参见 DescribeSiteMonitorISPCityList 。	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJson	string	否	站点监控任务对应协议类型的高级扩展选项。不同探测任务的协议类型对应不同的扩展选项。	{"time_out":5000}
TaskName	string	否	站点监控任务的名称。长度 4~100 个字符，取值可包含英文字母、数字、短划线（_）和汉字。说明至少需要创建一条站点监控任务，且`Address`、`TaskName`和`TaskType`必须设置。	HangZhou_ECS1
TaskType	string	否	监控任务的监控类型。目前站点监控任务的类型包括：HTTP、PING、TCP、UDP、DNS、SMTP、POP3、FTP。说明至少需要创建一条站点监控任务，且`Address`、`TaskName`和`TaskType`必须设置。	HTTP

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object	无。
RequestId	string	请求 ID。	7AE72720-2C96-5446-9F2B-308C7CEDFF1A
Message	string	返回信息。	successful
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
Data	array<object>	站点监控任务信息。	[{"taskName": "HangZhou_ECS1", "taskId": "679fbe4f-b80b-4706-91b2-5427b43e****"}]
Data	object	站点监控任务信息。
TaskName	string	站点监控任务名称。	HangZhou_ECS1
TaskId	string	站点监控任务 ID。	679fbe4f-b80b-4706-91b2-5427b43e****
Code	string	状态码。说明 200 表示成功。	200

示例

正常返回示例

JSON格式

{
  "RequestId": "7AE72720-2C96-5446-9F2B-308C7CEDFF1A",
  "Message": "successful",
  "Success": true,
  "Data": [
    {
      "TaskName": "HangZhou_ECS1",
      "TaskId": "679fbe4f-b80b-4706-91b2-5427b43e****"
    }
  ],
  "Code": 200
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameterValue	Illegal parameters.	参数错误。
400	ParameterInvalid	The parameter is missing or invalid. %s	参数缺失或者参数无效。
403	InvalidAuthorization	%s	-
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。
429	ResourceOverLimit	The resource has exceeded the limit. %s	超过数量限制。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2022-07-21	新增 OpenAPI	查看变更详情