創建站點監控任務
接口說明
本文將提供一個示例,創建一個站點監控任務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,例如: 關于如何獲取探測點信息,請參見 DescribeSiteMonitorISPCityList 。 | [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] |
OptionsJson | string | 否 | 監控任務對應協議類型的高級擴展選項。不同監控任務的協議類型對應不同的擴展選項。 | {"time_out":5000} |
AlertIds | string | 否 | 報警規則 ID。 關于如何獲取云監控中已存在的報警規則 ID,請參見 DescribeMetricRuleList 。 | SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent |
CustomSchedule | string | 否 | 自定義探測周期。只能選擇周一至周日的某個時間段進行探測。 | {"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"} |
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
參數 | 類型 | 描述 |
---|---|---|
dns_server | string | DNS 服務器地址,可以為域名或 IP 地址。 |
dns_type | string | DNS 查詢類型。取值:A、NS、CNAME、MX、TXT、ANY、AAAA。 |
expect_value | string | 英文空白符分隔的期望值列表。 |
match_rule | string | 期望值列表與 DNS 列表的關系,當不滿足指定關系時,探測失敗。 空字符串或 IN_DNS:期望值列表是 DNS 列表的子集。 DNS_IN:DNS 列表是期望值列表的子集。 EQUAL:DNS 列表與期望值列表相等。 ANY:DNS 列表與期望值列表有交集(交集不為空)。 |
- FTP
參數 | 類型 | 描述 |
---|---|---|
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 | 允許服務端不返回消息或返回空字符串。 |
返回參數
示例
正常返回示例
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 | OperatorCityInvalid | Operator City invalid |
400 | OperatorCityInvalid | %s |
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 | Forbidden | %s |
403 | RestrictedUser | The user's operation is restricted, please register NAAM product code |
406 | ExceedingQuota | Exceeding quota limits. |
409 | %s | %s |
500 | InternalError | The request processing has failed due to some unknown error. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-08-04 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-06-19 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-06-22 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |