GetTimingSyntheticTask - 擷取撥測任務詳情 - Application Real-Time Monitoring Service

擷取任務詳情。

介面說明

雲撥測目前僅在杭州 region 提供服務，使用 SDK 或 OpenAPI 時請選擇杭州 region 對應的服務存取點。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	地區 ID。	cn-hangzhou
TaskId	string	否	雲撥測任務 ID。	856566a9cb2a4cafa05aa95ed0*******

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 id	E13430A6-57A9-56E9-9D8D-28FE8DEBCA40
Code	integer	狀態代碼。說明 200 表示成功。	200
Message	string	返回資訊。	success
Data	object	返回結構體。
TaskId	string	雲撥測任務 ID。	5308a2691f59422c8c3b7aeccec9cd3b
RegionId	string	地區 ID	cn-hangzhou
Name	string	撥測任務名稱	撥測任務
TaskType	integer	任務類型： 1：ICMP 2：TCP 3：DNS 4：HTTP 5：網站測速 6：檔案下載	5
MonitorConf	object	任務配置
NetICMP	object	ICMP 撥測配置參數。當 TaskType 為 1 時必填。
TargetUrl	string	撥測目標地址（主機）。只能是網域名稱或者 IP 位址。	www.aliyun.com
Interval	integer	建立 TCP 串連的時間間隔。單位為毫秒（ms），最小值為 200，最大值為 10000，預設為 200。	200
PackageNum	integer	發送 ICMP（Ping）資料包的數量。最小值為 1，最大值為 50，預設為 4。	4
PackageSize	integer	發送 ICMP（Ping）資料包的大小。單位為 byte，允許設定為 32, 64, 128, 256, 512, 1024。	1024
SplitPackage	boolean	是否拆分 ICMP（Ping）資料包。預設為 true。	true
Timeout	integer	逾時時間，單位 ms，預設 20000，範圍 1000~300000。	2000
TracertEnable	boolean	是否開啟 tracert。預設為 true。	true
TracertNumMax	integer	tracert 的最大躍點數。最小值為 1，最大值為 128，預設為 64。	64
TracertTimeout	integer	tracert 的逾時時間。單位為毫秒（ms），最小值為 1000，最大值為 300000，預設為 60000。	60000
NetTCP	object	TCP 撥測的配置參數。當 TaskType 為 2 時必填。
TargetUrl	string	撥測目標地址。	127.0.0.1:8888
ConnectTimes	integer	單次撥測建立串連的次數，1~16 之間，預設 4。	4
Interval	integer	建立 TCP 串連的時間間隔。單位為毫秒（ms），最小值為 200，最大值為 10000，預設為 200。	200
Timeout	integer	TCP 撥測逾時時間。單位為毫秒（ms），最小值為 1000，最大值為 300000，預設為 20000。	20000
TracertEnable	boolean	是否開啟 tracert。預設為 true。	true
TracertNumMax	integer	tracert 的最大躍點數。最小值為 1，最大值為 128，預設為 20。	20
TracertTimeout	integer	tracert 的逾時時間。單位為毫秒（ms），最小值為 1000，最大值為 300000，預設為 60000。	60000
NetDNS	object	DNS 撥測的配置參數。當 TaskType 為 3 時必填。
TargetUrl	string	撥測網域名稱。	www.aliyun.com
DnsServerIpType	integer	DNS 伺服器 IP 類型。 0（預設）：ipv4 1：ipv6 2: 自動	0
NsServer	string	NS 伺服器 IP，預設 114.114.114.114。	114.114.114.114
QueryMethod	integer	DNS 查詢方式，0: 遞迴， 1：迭代。	0
Timeout	integer	DNS 撥測逾時時間。單位為毫秒（ms），最小值為 1000，最大值為 45000，預設為 5000。	5000
ApiHTTP	object	HTTP(S)類型任務配置資訊。
TargetUrl	string	撥測地址。	http://127.0.0.1:8090/api/list
Method	string	要求方法。 POST GET	POST
RequestHeaders	object	HTTP 要求頭。
	string	JSON Map 類型字串。	{ "key1": "value1", "key2": "value2" }
RequestBody	object	HTTP 要求體。
Content	string	請求體內容，為 JSON 字串格式。當 type 為 text/plain，application/json，application/xml，text/html，content 內容轉為 JSON 字串即可。	text/plain
Type	string	請求體類型，支援：text/plain、application/json、application/x-www-form-urlencoded、multipart/form-data、application/xml、text/html。	multipart/form-data
ConnectTimeout	integer	連線逾時, ms，預設 5000，範圍為 1000~300000ms。	5000
Timeout	integer	逾時時間，ms，預設 10000，範圍為 1000~300000ms。	10000
CheckCert	boolean	是否校正認證，預設為否。	false
ProtocolAlpnProtocol	integer	ALPN 協議版本（wap 移動端並且是 HTTPS 任務時可配置）： 0-default 系統預設行為 1-http/1.1 2-h2 3-off 關閉,不啟用 alpn_protocol	1
FileDownload	object	檔案下載類型任務配置。
TargetUrl	string	下載連結。	https://********
DownloadKernel	integer	下載核心。 1：curl 0：WinInet	0
QuickProtocol	integer	Quick 協議 1：http1 2：http2 3：http3	1
ConnectionTimeout	integer	連線逾時。檔案下載的連線逾時必須在 1000~120000ms 之間，預設 5000。	5000
CustomHeaderContent	object	自訂要求標頭內容，JSON Map。
	string	JSON Map。	{ "key1": "value1", "key2": "value2" }
IgnoreCertificateStatusError	integer	認證狀態錯誤忽略。 0：不忽略 1（預設）：忽略	0
IgnoreCertificateUntrustworthyError	integer	認證不可信忽略。 0：不忽略 1（預設）：忽略	0
IgnoreInvalidHostError	integer	主機無效錯誤忽略。 0：不忽略 1（預設）：忽略	0
MonitorTimeout	integer	監測逾時時間，ms，預設 60000，範圍 1000~120000ms 之間。	6000
Redirection	integer	是否支援重新導向。 0：不支援 1（預設）：支援	0
TransmissionSize	integer	傳輸大小，KB，預設 2048KB，檔案下載的傳輸大小必須在 1~20480KB 之間。	2048
IgnoreCertificateCanceledError	integer	忽略認證撤銷錯誤。 0：不忽略 1（預設）：忽略	0
IgnoreCertificateAuthError	integer	忽略 CA 憑證授權錯誤。 0：不忽略 1（預設）：忽略	0
IgnoreCertificateOutOfDateError	integer	忽略認證到期錯誤。 0：不忽略 1（預設）：忽略	0
IgnoreCertificateUsingError	integer	忽略認證使用錯誤。 0：不忽略 1（預設）：忽略	0
VerifyWay	integer	驗證方式。 0：不驗證 1：驗證字串 2：MD5 驗證	0
ValidateKeywords	string	驗證關鍵詞。	success
WhiteList	string	DNS 劫持白名單。匹配規則支援 IP、IP 萬用字元、子網路遮罩和 CNAME，可以填寫多個匹配規則，多個匹配規則以豎線（\|）隔開。例如：`www.aliyun.com:203.0.3.55\|203.3.44.67`，表示 www.aliyun.com 網域名稱下除 203.0.3.55 和 203.3.44.67 之外的其他 IP 都是被劫持的。	www.aliyun.com:203.0.3.55\|203.3.44.67
Website	object	網站測速類型任務配置。
TargetUrl	string	目標網址。	http://www.aliyun.com
AutomaticScrolling	integer	是否支援自動滾動螢幕，載入頁面。0-否，1-是，預設為 0。	0
CustomHeader	integer	自訂 header。 0：關（預設） 1：修改第一包 2：修改全部包	0
CustomHeaderContent	object	自訂 header，JSON Map 格式。
	string	JSON Map	{ "key1": "value1", "key2": "value2" }
DisableCache	integer	是否禁用緩衝。 0：不禁用 1（預設）：禁用	1
DisableCompression	integer	通過 Accept-Encoding 欄位判斷是否接受壓縮檔，0-不禁用，1-禁用，預設為 0。	0
FilterInvalidIP	integer	是否過濾非有效 IP。 1：不過濾 0：過濾	0
IgnoreCertificateError	integer	是否忽略在 SSL 握手中認證校正過程中的認證錯誤而繼續瀏覽。 0：不忽略 1（預設）：忽略	0
MonitorTimeout	integer	監測逾時，單位為 ms。非必填，預設 20000。範圍為 5000~300000ms。	20000
Redirection	integer	當出現重新導向後，是否要繼續瀏覽。 0：否 1（預設）：是	1
SlowElementThreshold	integer	慢元素閾值，單位為 ms，預設 5000，範圍為 1~300000ms。	5000
WaitCompletionTime	integer	最大等待完成時間，單位為 ms，預設 5000，範圍為 5000~300000ms。	5000
VerifyStringBlacklist	string	驗證字串即監測頁面原始碼中的某個任一字元串。若用戶端返回的源碼中包含任一黑名單中的字串則報 650 驗證字串失敗的錯誤。多個字串以豎線（\|）隔開。	error
VerifyStringWhitelist	string	驗證字串即監測頁面原始碼中的某個任一字元串。用戶端返回的源碼必須包含所有白名單中的字串，否則報 650 驗證字串失敗的錯誤。多個字串以豎線（\|）隔開。	success
ElementBlacklist	string	在頁面載入過程中如果出現元素黑名單中配置的元素，不會請求載入該元素。	www.example.com/a.jpg
DNSHijackWhitelist	string	網域名稱（例如 www.aliyun.com）解析時，解析出的 IP 位址或者 CNAME 不在 DNS 劫持白名單內，使用者就會訪問失敗或者返回一個非 Aliyun 的目標 IP；若解析結果中的 IP 或者 CNAME 在 DNS 白名單內，則會被認定為沒有發生 DNS 劫持。填寫格式：`網域名稱:匹配規則`。匹配規則支援 IP、IP 萬用字元、子網路遮罩和 CNAME，可以填寫多個匹配規則，多個匹配規則以豎線（\|）隔開。例如：`www.aliyun.com:203.0.3.55\|203.3.44.67`，表示 www.aliyun.com 網域名稱下除 203.0.3.55 和 203.3.44.67 之外的其他 IP 都是被劫持的。	www.aliyun.com:203.0.3.55\|203.3.44.67
PageTamper	string	監測頁面出現了網域名稱設定之外的元素都屬於頁面被篡改。常見的表現形式為彈出廣告、浮動廣告、跳轉等。填寫格式：`網域名稱:元素`。元素支援填寫萬用字元，可以填寫多個元素，多個元素以豎線（\|）隔開。例如：`www.aliyun.com:\|/cc/bb/a.gif\|/vv/bb/cc.jpg`，表示 www.aliyun.com 網域名稱下除基礎文檔、/cc/bb/a.gif 和/vv/bb/cc.jpg 之外的其他元素都屬於頁面被篡改。	www.aliyun.com:\|/cc/bb/a.gif\|/vv/bb/cc.jpg
FlowHijackJumpTimes	integer	識別元素：設定瀏覽頁面元素總個數。	0
FlowHijackLogo	string	劫持標識：設定匹配的關鍵資訊。填寫劫持判斷關鍵字或關鍵元素，允許帶星號（*）。	aliyun
Stream	object	流媒體撥測配置。
TargetUrl	string	流媒體資源地址。	http://www.aliyun.com/stream/test.mp4
StreamType	integer	音視頻標誌： 0：視頻 1：音頻	0
StreamMonitorTimeout	integer	監測時間長度，單位秒，最長支援 60s，不傳預設 60。	30
StreamAddressType	integer	資源地址類型： 1：資源地址。 0：頁面地址。不傳預設 0。	0
PlayerType	integer	播放器，不傳預設 12。 12：VLC 2：FlashPlayer	12
CustomHeaderContent	object	自訂 header，JSON Map 格式。
	string	自訂 header，JSON Map 格式。	{ "key1": "value1", "key2": "value2" }
WhiteList	string	DNS 劫持白名單。匹配規則支援 IP、IP 萬用字元、子網路遮罩和 CNAME，可以填寫多個匹配規則，多個匹配規則以豎線（\|）隔開。例如：`www.aliyun.com:203.0.3.55\|203.3.44.67`，表示 www.aliyun.com 網域名稱下除 203.0.3.55 和 203.3.44.67 之外的其他 IP 都是被劫持的。	www.aliyun.com:203.0.3.55\|203.3.44.67
MonitorCategory	integer	監測點類型： 1：PC 端 2：移動端	1
Monitors	array<object>	監測點列表。
	object	監測點列表。
CityCode	string	城市編碼。	110100
OperatorCode	string	電訊廠商編碼。	1
ClientType	integer	撥測點用戶端類型： 1：IDC 2：網民 3：移動端 4：雲主機	1
Frequency	string	撥測頻率，可選範圍：1m、5m、10m、15m、20m、30m、1h、2h、3h、4h、6h、8h、12h、24h。	5m
CustomPeriod	object	自訂周期
EndHour	integer	結束小時，0-24。	22
StartHour	integer	開始小時，0-24。	14
CommonSetting	object	通用設定。
CustomHost	object	自訂 host。
Hosts	array<object>	host 列表。
	object	自訂 host。
Domain	string	網域名稱。	www.aliyun.com
IpType	integer	IP 類型： 0：自動 1：IPv4 2：IPpv6	0
Ips	array	IP 列表。
	string	對應的 IP。	10.0.114.17
SelectType	integer	選擇方式： 0：隨機 1：輪詢	0
IpType	integer	IP 類型： 0：自動 1：IPv4 2：IPpv6	0
MonitorSamples	integer	是否均勻分配監測樣本： 0：否 1：是	0
IsOpenTrace	boolean	是否開啟鏈路追蹤。	true
TraceClientType	integer	鏈路追蹤用戶端類型： 0：ARMS Agent 1：OpenTelemetry 2：Jaeger	1
XtraceRegion	string	鏈路資料上報 region。	cn-hangzhou
CustomVPCSetting	object	使用者 VPC 資訊，如果撥測的是阿里雲內網地址，需要配置 VPC 資訊。
RegionId	string	地區 ID。	cn-hangzhou
VpcId	string	VPC ID.	vpc-2zexy5nae9q2otaxxxx
VSwitchId	string	交換器 ID。	vsw-bp1i0xezblf1yrz4xxxxx
SecureGroupId	string	安全性群組 ID，此安全性群組是撥測用戶端所在的安全性群組，安全性群組限定了撥測用戶端在 VPC 中的出入站規則。需要設定您的 VPC 所在安全性群組的入站規則為允許撥測用戶端所在的安全性群組訪問。否則，撥測用戶端無法順暢地訪問您的 VPC 內資源。	sg-xxxxxxx
CustomPrometheusSetting	object	保留欄位。
PrometheusLabels	object	保留欄位。
	string	保留欄位。	保留欄位。
PrometheusClusterId	string	保留欄位。	保留欄位。
PrometheusClusterRegion	string	保留欄位。	保留欄位。
AvailableAssertions	array<object>	斷言列表。
	object	斷言列表。
Type	string	斷言類型，包括：HttpResCode、HttpResHead、HttpResBody、HttpResBodyJson、HttpResponseTime、IcmpPackLoss（丟包率）、IcmpPackMaxLatency（最大包延時 ms）、IcmpPackAvgLatency（平均延時）、TraceRouteHops（躍點數目）、DnsARecord（A 記錄）、DnsCName（Cname）、websiteTTFB（首包時間）、websiteTTLB（尾包時間）、websiteFST（首屏時間）、websiteFFST（首屏完全渲染時間）、websiteOnload（完全載入時間），具體使用見下文補充說明。	websiteTTLB
Target	string	檢查目標，當為 HttpResCode 與 HttpResBody、HttpResponseTime 時，target 不需要填，當為 HttpResHead 時，需指定 header 中的 key，當為 HttpResBodyJson 時，使用 jsonPath。	key
Operator	string	條件： gt：大於 gte：大於等於 lt：小於 te：小於或等於 eq：等於 neq：不等於 ctn：包含 nctn：不包含 exist：存在 n_exist：不存在 belong：屬於 n_belong：不屬於 reg_match：正則匹配	gt
Expect	string	期望值。	100
Status	string	CREATING：任務建立中 RUNNING：任務運行中 PARTIAL_RUNNING：任務部分運行中 STOP：任務停止 LIMIT_STOP：任務由於限額停止 EXCEPTION：任務異常 DELETE：任務刪除 DELETE_EXCEPTION：刪除異常	RUNNING
ResourceGroupId	string	資源群組 ID。	default
Tags	array<object>	標籤。
	object	標籤。
Key	string	Tag 的鍵。	user1
Value	string	Tag 的值	p_營運

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E13430A6-57A9-56E9-9D8D-28FE8DEBCA40",
  "Code": 200,
  "Message": "success",
  "Data": {
    "TaskId": "5308a2691f59422c8c3b7aeccec9cd3b",
    "RegionId": "cn-hangzhou",
    "Name": "撥測任務",
    "TaskType": 5,
    "MonitorConf": {
      "NetICMP": {
        "TargetUrl": "www.aliyun.com",
        "Interval": 200,
        "PackageNum": 4,
        "PackageSize": 1024,
        "SplitPackage": true,
        "Timeout": 2000,
        "TracertEnable": true,
        "TracertNumMax": 64,
        "TracertTimeout": 60000
      },
      "NetTCP": {
        "TargetUrl": "127.0.0.1:8888",
        "ConnectTimes": 4,
        "Interval": 200,
        "Timeout": 20000,
        "TracertEnable": true,
        "TracertNumMax": 20,
        "TracertTimeout": 60000
      },
      "NetDNS": {
        "TargetUrl": "www.aliyun.com",
        "DnsServerIpType": 0,
        "NsServer": "114.114.114.114",
        "QueryMethod": 0,
        "Timeout": 5000
      },
      "ApiHTTP": {
        "TargetUrl": "http://127.0.0.1:8090/api/list",
        "Method": "POST",
        "RequestHeaders": {
          "key": "{\n      \"key1\": \"value1\",\n      \"key2\": \"value2\"\n}"
        },
        "RequestBody": {
          "Content": "text/plain",
          "Type": "multipart/form-data"
        },
        "ConnectTimeout": 5000,
        "Timeout": 10000,
        "CheckCert": false,
        "ProtocolAlpnProtocol": 1
      },
      "FileDownload": {
        "TargetUrl": "https://********",
        "DownloadKernel": 0,
        "QuickProtocol": 1,
        "ConnectionTimeout": 5000,
        "CustomHeaderContent": {
          "key": "{\n      \"key1\": \"value1\",\n      \"key2\": \"value2\"\n}"
        },
        "IgnoreCertificateStatusError": 0,
        "IgnoreCertificateUntrustworthyError": 0,
        "IgnoreInvalidHostError": 0,
        "MonitorTimeout": 6000,
        "Redirection": 0,
        "TransmissionSize": 2048,
        "IgnoreCertificateCanceledError": 0,
        "IgnoreCertificateAuthError": 0,
        "IgnoreCertificateOutOfDateError": 0,
        "IgnoreCertificateUsingError": 0,
        "VerifyWay": 0,
        "ValidateKeywords": "success",
        "WhiteList": "www.aliyun.com:203.0.3.55|203.3.44.67"
      },
      "Website": {
        "TargetUrl": "http://www.aliyun.com",
        "AutomaticScrolling": 0,
        "CustomHeader": 0,
        "CustomHeaderContent": {
          "key": "{\n      \"key1\": \"value1\",\n      \"key2\": \"value2\"\n}\n"
        },
        "DisableCache": 1,
        "DisableCompression": 0,
        "FilterInvalidIP": 0,
        "IgnoreCertificateError": 0,
        "MonitorTimeout": 20000,
        "Redirection": 1,
        "SlowElementThreshold": 5000,
        "WaitCompletionTime": 5000,
        "VerifyStringBlacklist": "error",
        "VerifyStringWhitelist": "success",
        "ElementBlacklist": "www.example.com/a.jpg",
        "DNSHijackWhitelist": "www.aliyun.com:203.0.3.55|203.3.44.67",
        "PageTamper": "www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg",
        "FlowHijackJumpTimes": 0,
        "FlowHijackLogo": "aliyun"
      },
      "Stream": {
        "TargetUrl": "http://www.aliyun.com/stream/test.mp4",
        "StreamType": 0,
        "StreamMonitorTimeout": 30,
        "StreamAddressType": 0,
        "PlayerType": 12,
        "CustomHeaderContent": {
          "key": "{\n      \"key1\": \"value1\",\n      \"key2\": \"value2\"\n}"
        },
        "WhiteList": "www.aliyun.com:203.0.3.55|203.3.44.67"
      }
    },
    "MonitorCategory": 1,
    "Monitors": [
      {
        "CityCode": "110100",
        "OperatorCode": "1",
        "ClientType": 1
      }
    ],
    "Frequency": "5m",
    "CustomPeriod": {
      "EndHour": 22,
      "StartHour": 14
    },
    "CommonSetting": {
      "CustomHost": {
        "Hosts": [
          {
            "Domain": "www.aliyun.com",
            "IpType": 0,
            "Ips": [
              "10.0.114.17"
            ]
          }
        ],
        "SelectType": 0
      },
      "IpType": 0,
      "MonitorSamples": 0,
      "IsOpenTrace": true,
      "TraceClientType": 1,
      "XtraceRegion": "cn-hangzhou",
      "CustomVPCSetting": {
        "RegionId": "cn-hangzhou",
        "VpcId": "vpc-2zexy5nae9q2otaxxxx",
        "VSwitchId": "vsw-bp1i0xezblf1yrz4xxxxx",
        "SecureGroupId": "sg-xxxxxxx"
      },
      "CustomPrometheusSetting": {
        "PrometheusLabels": {
          "key": "保留欄位。"
        },
        "PrometheusClusterId": "保留欄位。",
        "PrometheusClusterRegion": "保留欄位。"
      }
    },
    "AvailableAssertions": [
      {
        "Type": "websiteTTLB",
        "Target": "key\n",
        "Operator": "gt",
        "Expect": "100"
      }
    ],
    "Status": "RUNNING",
    "ResourceGroupId": "default",
    "Tags": [
      {
        "Key": "user1",
        "Value": "p_營運"
      }
    ]
  }
}

錯誤碼

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

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

變更歷史

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