擷取定時撥測工作清單。
介面說明
雲撥測目前僅在杭州 region 提供服務，使用 SDK 或 OpenAPI 時請選擇杭州 region 對應的服務存取點。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
否 |
地區 ID。 |
cn-hangzhou |
| Search |
object |
否 |
搜尋索引鍵 |
|
| TaskTypes |
array |
否 |
查詢的任務類型列表。 |
|
|
integer |
否 |
任務類型：1：ICMP 2：TCP 3：DNS 4：HTTP 5：網站測速 6：檔案下載。 |
1 |
|
| TaskIds |
array |
否 |
任務 ID 列表。 |
|
|
string |
否 |
任務 ID。 |
181248 |
|
| Name |
string |
否 |
任務名稱。 |
撥測 |
| Status |
string |
否 |
CREATING：任務建立中， RUNNING：任務運行中， PARTIAL_RUNNING：任務部分運行中， STOP：任務停止， LIMIT_STOP：任務由於限額停止， EXCEPTION：任務異常， DELETE：任務刪除， DELETE_EXCEPTION： 刪除異常。 |
CREATING |
| OrderField |
string |
否 |
排序欄位，支援按照 gmtCreate、gmtModified、status 和 monitorCount 其中之一排序。 |
status |
| Order |
integer |
否 |
1:升序 -1:降序 |
1 |
| Page |
integer |
否 |
頁碼，必填。 |
1 |
| PageSize |
integer |
否 |
每頁數量，必填。 |
10 |
| ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-acfmxyexli2**** |
| Tags |
array<object> |
否 |
標籤 |
|
|
object |
否 |
標籤 |
||
| Key |
string |
否 |
標籤的鍵(key)。 |
mark |
| Value |
string |
否 |
標籤的值（value）。 |
value1111 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
730E90FE-996A-5638-99F3-4F0F9038CC6C |
| Code |
integer |
狀態代碼。200 表示成功。 |
200 |
| Message |
string |
返回資訊。 |
success |
| Data |
object |
返回結構體。 |
|
| Items |
array<object> |
任務資訊列表。 |
|
|
array<object> |
任務資訊。 |
||
| TaskId |
string |
雲撥測任務 ID。 |
5308a2691f59422c8c3b7aeccec9cd3b |
| RegionId |
string |
地區 ID。 |
cn-hangzhou |
| Name |
string |
任務名稱。 |
撥測任務 |
| TaskType |
integer |
任務類型： 1：ICMP 2：TCP 3：DNS 4：HTTP 5：網站測速 6：檔案下載。 |
1 |
| Url |
string |
撥測地址。 |
https://www.example.com |
| MonitorCategory |
integer |
監測點類型，PC 端 1，移動端 2。 |
1 |
| Frequency |
string |
撥測頻率，可選範圍：1m,5m,10m,15m,20m,30m,1h,2h,3h,4h,6h,8h,12h,24h。 |
1m |
| MonitorNum |
string |
撥測點個數。 |
10 |
| Status |
string |
CREATING：任務建立中， RUNNING：任務運行中， PARTIAL_RUNNING：任務部分運行中， STOP：任務停止， LIMIT_STOP：任務由於限額停止， EXCEPTION：任務異常， DELETE：任務刪除， DELETE_EXCEPTION： 刪除異常。 |
RUNNING |
| GmtCreate |
string |
建立時間。 |
1671454758000 |
| GmtModified |
string |
修改時間。 |
1673085633000 |
| ResourceGroupId |
string |
資源群組 ID。 |
rg-aekzgwtq5vxxxxx |
| CommonSetting |
object |
通用設定。 |
|
| CustomHost |
object |
自訂 host |
|
| Hosts |
array<object> |
自訂 host。 |
|
|
object |
自訂 host。 |
||
| Domain |
string |
網域名稱。 |
www.aliyun.com |
| IpType |
integer |
IP 類型：
|
0 |
| Ips |
array |
IP 位址。 |
|
|
string |
IP。 |
39.104.85.210 |
|
| SelectType |
integer |
選擇方式：
|
0 |
| IpType |
integer |
IP 類型：
|
0 |
| MonitorSamples |
integer |
是否均勻分配監測樣本 ：
|
0 |
| IsOpenTrace |
boolean |
是否開啟鏈路追蹤。 |
false |
| TraceClientType |
integer |
鏈路追蹤用戶端類型：
|
1 |
| XtraceRegion |
string |
鏈路資料上報 region。 |
cn-hangzhou |
| CustomVPCSetting |
object |
使用者 VPC 資訊，如果撥測的是阿里雲內網地址，需要配置 VPC 資訊。 |
|
| RegionId |
string |
地區 ID。 |
cn-zhangjiakou |
| VpcId |
string |
VPC ID. |
vpc-2zehbd4dfzahxxxxxxx |
| VSwitchId |
string |
交換器 ID。 |
vsw-bp1bcmj81kxxxxxxx |
| SecureGroupId |
string |
安全性群組 ID，此安全性群組是撥測用戶端所在的安全性群組，安全性群組限定了撥測用戶端在 VPC 中的出入站規則。需要設定您的 VPC 所在安全性群組的入站規則為允許撥測用戶端所在的安全性群組訪問。否則，撥測用戶端無法順暢地訪問您的 VPC 內資源。 |
sg-xxxxxxxxxxxxxx |
| CustomPrometheusSetting |
object |
保留欄位。 |
|
| PrometheusLabels |
object |
保留欄位。 |
|
|
string |
保留欄位。 |
保留欄位。 |
|
| PrometheusClusterId |
string |
保留欄位。 |
保留欄位。 |
| PrometheusClusterRegion |
string |
保留欄位。 |
保留欄位。 |
| Tags |
array<object> |
標籤。 |
|
|
object |
標籤。 |
||
| Key |
string |
標籤鍵。 |
key |
| Value |
string |
標籤的值。 |
value |
| Total |
integer |
返回結果的總任務數量。 |
100 |
| Page |
integer |
當前頁數。 |
1 |
| PageSize |
integer |
每頁數量。 |
10 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "730E90FE-996A-5638-99F3-4F0F9038CC6C",
"Code": 200,
"Message": "success",
"Data": {
"Items": [
{
"TaskId": "5308a2691f59422c8c3b7aeccec9cd3b",
"RegionId": "cn-hangzhou",
"Name": "撥測任務",
"TaskType": 1,
"Url": "https://www.example.com",
"MonitorCategory": 1,
"Frequency": "1m",
"MonitorNum": "10",
"Status": "RUNNING",
"GmtCreate": "1671454758000",
"GmtModified": "1673085633000",
"ResourceGroupId": "rg-aekzgwtq5vxxxxx",
"CommonSetting": {
"CustomHost": {
"Hosts": [
{
"Domain": "www.aliyun.com",
"IpType": 0,
"Ips": [
"39.104.85.210"
]
}
],
"SelectType": 0
},
"IpType": 0,
"MonitorSamples": 0,
"IsOpenTrace": false,
"TraceClientType": 1,
"XtraceRegion": "cn-hangzhou",
"CustomVPCSetting": {
"RegionId": "cn-zhangjiakou",
"VpcId": "vpc-2zehbd4dfzahxxxxxxx",
"VSwitchId": "vsw-bp1bcmj81kxxxxxxx",
"SecureGroupId": "sg-xxxxxxxxxxxxxx"
},
"CustomPrometheusSetting": {
"PrometheusLabels": {
"key": "保留欄位。\n"
},
"PrometheusClusterId": "保留欄位。\n",
"PrometheusClusterRegion": "保留欄位。"
}
},
"Tags": [
{
"Key": "key",
"Value": "value"
}
]
}
],
"Total": 100,
"Page": 1,
"PageSize": 10
}
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | ParameterMissing | %s | |
| 400 | ParameterIllegal | %s | |
| 400 | TaskQuotaLimit | %s | |
| 400 | ParameterRegionIllegal | %s | |
| 400 | DuplicateTagKey | Param tagKey is duplicate. | |
| 400 | TagNumOUT | the number of tag is out . | |
| 400 | NoPermissionUSER | user no permission | |
| 403 | RAMNotAuthorize | %s | |
| 403 | STSNotAuthorize | %s | |
| 403 | IllegalUserAccess | %s | |
| 403 | APINotAuthorize | %s | |
| 403 | CommercialStatusException | %s | |
| 403 | SyntheticTrailExpired | %s | |
| 403 | SyntheticInDebt | %s | |
| 403 | SyntheticDailyTimesExhausted | %s | |
| 403 | SyntheticDailyLimit | %s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。