調用CreateSiteMonitor介面建立網站監控任務-CloudMonitor-阿里雲

建立網站監控任務

介面說明

本文將提供一個樣本，建立一個網站監控任務HanZhou_ECS1，該監控任務的監控地址為https://www.aliyun.com、監控類型為HTTPS。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:CreateSiteMonitor

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Address	string	是	監控任務的 URL 或 IP 位址。	https://www.aliyun.com
TaskType	string	是	監控任務的監控類型。目前網站監控任務的類型包括：HTTP（S）、PING、TCP、UDP、DNS、SMTP、POP3、FTP、WEBSOCKET。	HTTP
TaskName	string	是	監控任務的名稱。長度 4~100 個字元，取值可包含英文字母、數字、底線（_）和漢字。	HanZhou_ECS1
Interval	string	否	監控頻率。取值：1 分鐘、5 分鐘、15 分鐘、30 分鐘和 60 分鐘。預設值：1 分鐘。	1
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}
AlertIds	string	否	警示規則 ID。關於如何擷取CloudMonitor中已存在的警示規則 ID，請參見 DescribeMetricRuleList 。	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
AgentGroup	string	否	撥測任務使用的撥測點組。不同的選項對應不同的探測點類型。PC 對應 PC 端，MOBIEL 對應移動端，FC 對應 VPC 內網探測。不設定的話預設為 PC。	PC
CustomSchedule	string	否	自訂探測周期。只能選擇周一至周日的某個時間段進行探測。	{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}
VpcConfig	string	否	建立 vpc 內網撥測任務時需要提供的網路資訊。需要提供一個 JSON，裡邊必須包含 vpcId，vswitchId，securityGroupId 和 region 四個欄位。	{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}

TaskType 中 HTTP（S）、PING、TCP、UDP、DNS、WEBSOCKET、SMTP、POP3 和 FTP 的進階參數的設定方法如下表所示。

HTTP（S）

參數	類型	描述
http_method	String	HTTP 或 HTTPS 請求方式。支援三種請求方式：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 或 HTTPS 請求驗證密碼。
time_out	int	逾時時間。單位：毫秒。預設值：5 。
max_redirect	int	最大跳轉次數。ECS 探針預設 5 次，電訊廠商探針預設 2 次。如果需要禁止跳轉，則將該參數設定為：0。取值範圍：0~50 。

PING

參數	類型	描述
failure_rate	文本	當 PING 失敗率超過該參數時，探測失敗，返回 610（PingAllFail）或 615（PingPartialFail）。預設值：0.1。
ping_num	int	PING 次數，預設值：10。取值範圍：1~100。

參數	類型	描述
dns_server	string	DNS 伺服器地址，可以為網域名稱或 IP 位址。
dns_type	string	DNS 查詢類型。取值：A、NS、CNAME、MX、TXT、ANY、AAAA。
expect_value	string	英文空白符分隔的期望值列表。
match_rule	string	期望值列表與 DNS 列表的關係，當不滿足指定關係時，探測失敗。 Null 字元串或 IN_DNS：期望值列表是 DNS 列表的子集。 DNS_IN：DNS 列表是期望值列表的子集。 EQUAL：DNS 列表與期望值列表相等。 ANY：DNS 列表與期望值列表有交集（交集不為空白）。

參數	類型	描述
port	int	FTP 伺服器連接埠號碼。如果不提供，則使用預設值。FTP 預設值：21，FTPS 預設值：990。
username	string	FTP 使用者名稱。如果未提供，則匿名登入。
password	string	FTP 密碼。

POP3 或 SMTP

參數	類型	描述
port	int	POP3 或 SMTP 伺服器的連接埠號碼。POP3 預設值：110，POP3S 預設值：995，SMTP 預設值：25。
username	string	POP3 或 SMTP 的使用者名稱。POP3 或 SMTP 的使用者名稱和密碼必填。
password	string	POP3 或 SMTP 的密碼。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 為一般字元串。

WEBSOCKET

參數	類型	描述
request_content	string	訊息內容。
empty_message	boolean	允許服務端不返回訊息或返回Null 字元串。

返回參數

名稱	類型	描述	樣本值
	object
Code	string	狀態代碼。說明 200 表示成功。	200
Message	string	返回資訊。	Successful
RequestId	string	請求 ID。	68192f5d-0d45-4b98-9724-892813f86c71
Success	string	操作是否成功。取值： true：成功。 false：失敗。	true
Data	object	監控任務的結果詳情。
AttachAlertResult	object
Contact	array<object>	關聯已有警示規則的結果。
	object	關聯已有警示規則的結果。
Code	string	關聯警示規則的狀態代碼。說明 200 表示成功。	200
Message	string	關聯警示規則的返回資訊。	successful
RequestId	string	關聯警示規則的請求 ID。	5dd33455-4f65-4b0c-9200-33d66f3f340b
Success	string	關聯警示規則是否成功。取值： true：成功。 false：失敗。	true
RuleId	string	關聯警示規則的 ID。	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
CreateResultList	object
CreateResultList	array<object>	返回結果。當建立監控任務成功時，有返回結果；當建立監控任務失敗時，無返回結果。
	object	返回結果。當建立監控任務成功時，有返回結果；當建立監控任務失敗時，無返回結果。
TaskId	string	監控任務 ID。	2c8dbdf9-a3ab-46a1-85a4-f094965e****
TaskName	string	監控任務名稱。	HanZhou_ECS1

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "68192f5d-0d45-4b98-9724-892813f86c71",
  "Success": "true",
  "Data": {
    "AttachAlertResult": {
      "Contact": [
        {
          "Code": "200",
          "Message": "successful",
          "RequestId": "5dd33455-4f65-4b0c-9200-33d66f3f340b",
          "Success": "true",
          "RuleId": "SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent"
        }
      ]
    }
  },
  "CreateResultList": {
    "CreateResultList": [
      {
        "TaskId": "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
        "TaskName": "HanZhou_ECS1"
      }
    ]
  }
}

錯誤碼

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	NameRepeat	Task name repeat
400	CreateAlarmError	Create alarm error
400	NameNotExists	Task name not exists
400	OperatorCityInvalid	Invalid Isp.	電訊廠商無效
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	%s
403	RestrictedUser	The user's operation is restricted, please register NAAM product code
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	任務數量超出限額
409	%s	%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。