調(diào)用CreateSiteMonitor接口創(chuàng)建一次性探測(cè)任務(wù)。
接口說(shuō)明
僅開(kāi)通網(wǎng)絡(luò)分析與監(jiān)控的阿里云賬號(hào)，才能創(chuàng)建一次性探測(cè)任務(wù)。
本文將提供一個(gè)示例，創(chuàng)建一次性探測(cè)任務(wù)，該探測(cè)任務(wù)的名稱為task1，探測(cè)地址為http://www.aliyun.com，探測(cè)類(lèi)型為HTTP，探測(cè)點(diǎn)數(shù)量為1。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀取（Read）或列出（List）。
- 資源類(lèi)型：是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下：
- 對(duì)于必選的資源類(lèi)型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| cms:CreateInstantSiteMonitor | create | *全部資源 * |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類(lèi)型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Address | string | 是 | 探測(cè)任務(wù)的 URL 或 IP 地址。 | http://www.aliyun.com |
| TaskType | string | 是 | 探測(cè)任務(wù)的類(lèi)型。 目前探測(cè)任務(wù)的類(lèi)型包括：HTTP、PING、TCP、UDP 和 DNS。 | HTTP |
| TaskName | string | 是 | 探測(cè)任務(wù)的名稱。 長(zhǎng)度 4~100 個(gè)字符，取值可包含英文字母、數(shù)字、下劃線（_）和漢字。 | task1 |
| IspCities | string | 否 | 探測(cè)點(diǎn)信息。如果該參數(shù)取值為空，則系統(tǒng)隨機(jī)選擇 3 個(gè)探測(cè)點(diǎn)。 格式為 關(guān)于如何獲取探測(cè)點(diǎn)信息，請(qǐng)參見(jiàn) DescribeSiteMonitorISPCityList 。 說(shuō)明
IspCities和RandomIspCity必須二選一。
| [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}] |
| OptionsJson | string | 否 | 探測(cè)任務(wù)對(duì)應(yīng)協(xié)議類(lèi)型的高級(jí)擴(kuò)展選項(xiàng)。不同探測(cè)任務(wù)的協(xié)議類(lèi)型對(duì)應(yīng)不同的擴(kuò)展選項(xiàng)。 | {"time_out":5000} |
| RandomIspCity | integer | 否 | 探測(cè)點(diǎn)的數(shù)量。 說(shuō)明
IspCities和RandomIspCity必須二選一。- 如果您設(shè)置了參數(shù)RandomIspCity，參數(shù)IspCities自動(dòng)失效。 | 1 |
TaskType 的高級(jí)參數(shù)說(shuō)明
TaskType中 HTTP、PING、TCP、UDP 和 DNS 的高級(jí)參數(shù)的設(shè)置方法如下表所示。
- HTTP
| 參數(shù) | 類(lèi)型 | 描述 |
|---|---|---|
| http_method | String | HTTP 請(qǐng)求方式。支持三種請(qǐng)求方式：GET、POST、HEAD。默認(rèn)值：GET。 |
| header | String | 換行符（\n）分隔的自定義 HTTP header。 每行 Header 格式需符合 HTTP 協(xié)議（使用半角冒號(hào)分隔的鍵值）。 |
| cookie | String | Cookie 和 HTTP 請(qǐng)求標(biāo)準(zhǔn)的寫(xiě)法一致。 |
| request_content | String | 請(qǐng)求內(nèi)容。支持兩種格式：JSON 和表單。不提供時(shí)，請(qǐng)求中不含正文。 |
| response_content | String | 期望的回應(yīng)內(nèi)容。探測(cè)時(shí)會(huì)檢查 HTTP 服務(wù)器返回的前 64 個(gè)字節(jié)。 |
| match_rule | String | 0：回應(yīng)中不含 response_content 時(shí)，探測(cè)成功。 1：回應(yīng)中含 response_content 時(shí)，探測(cè)成功。 |
| username | String | 如果提供用戶名，則會(huì)在 HTTP 請(qǐng)求中攜帶 BasicAuth header。 |
| password | String | HTTP 請(qǐng)求驗(yàn)證密碼。 |
| time_out | int | 超時(shí)時(shí)間。單位：毫秒。默認(rèn)值：30000。 |
| max_redirect | int | 最大跳轉(zhuǎn)次數(shù)。ECS 探針默認(rèn) 5 次，運(yùn)營(yíng)商探針默認(rèn) 2 次。 如果需要禁止跳轉(zhuǎn)，則將該參數(shù)設(shè)置為 0。 取值范圍：0~50 。 |
- PING
| 參數(shù) | 類(lèi)型 | 描述 |
|---|---|---|
| failure_rate | int | 當(dāng) PING 失敗率超過(guò)該參數(shù)時(shí)，探測(cè)失敗，返回 610（PingAllFail）或 615（PingPartialFail）。 默認(rèn)值：0.1。 |
| ping_num | int | PING 次數(shù)，默認(rèn)值：20。 取值范圍：1~100。 |
- TCP 或 UDP
| 參數(shù) | 類(lèi)型 | 描述 |
|---|---|---|
| port | int | TCP 或 UDP 服務(wù)器的端口。 |
| request_content | string | 請(qǐng)求內(nèi)容。當(dāng) request_format 為 hex 時(shí)，request_content 內(nèi)容為十六進(jìn)制緊湊格式。 |
| request_format | string | 當(dāng) request_format 為其他值時(shí)，request_content 作為普通字符串發(fā)送給 TCP 或 UDP 服務(wù)器。 |
| response_content | string | 回應(yīng)內(nèi)容。當(dāng) TCP 或 UDP 服務(wù)器返回的內(nèi)容中不含 response_content 時(shí)，探測(cè)失敗。 當(dāng) response_format 為 hex 時(shí)，response_content 中的內(nèi)容為十六進(jìn)制緊湊格式。 當(dāng) response_content 為其他值時(shí)，response_content 為普通字符串。 |
- DNS
| 參數(shù) | 類(lèi)型 | 描述 |
|---|---|---|
| dns_server | string | DNS 服務(wù)器地址，可以為域名或 IP 地址。 |
| dns_type | string | DNS 查詢類(lèi)型。取值：A、NS、CNAME、MX、TXT、ANY。 |
| expect_value | string | 英文空白符分隔的期望值列表。 |
| match_rule | string | 期望值列表與 DNS 列表的關(guān)系，當(dāng)不滿足指定關(guān)系時(shí)，探測(cè)失敗。 空字符串或 IN_DNS：期望值列表是 DNS 列表的子集。 DNS_IN：DNS 列表是期望值列表的子集。 EQUAL：DNS 列表與期望值列表相等。 ANY：DNS 列表與期望值列表有交集（交集不為空）。 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "successful",
"RequestId": "68192f5d-0d45-4b98-9724-892813f86c71",
"Success": "true",
"CreateResultList": [
{
"TaskId": "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
"TaskName": "task1"
}
]
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 |
|---|---|---|
| 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 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2022-06-22 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |