全部產品
Search

搜尋本產品

    Application Real-Time Monitoring Service：CreateTimingSyntheticTask - 建立定時撥測任務

    文件中心

    Application Real-Time Monitoring Service：CreateTimingSyntheticTask - 建立定時撥測任務

    更新時間：Apr 10, 2026

    建立定時撥測任務（新版）。

    介面說明

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

    調試

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

    調試

    授權資訊

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    地區 ID。

    cn-hangzhou
    Name

    string

    是

    撥測任務名稱，不允許重複。

    demo-test
    TaskType

    integer

    是

    任務類型：

    • 1：ICMP

    • 2：TCP

    • 3：DNS

    • 4：HTTP

    • 5：網站測速

    • 6：檔案下載

    4
    MonitorConf

    object

    是

    監測配置。

    NetICMP

    object

    否

    ICMP 撥測配置參數。當 TaskType 為 1 時必填。

    TargetUrl

    string

    是

    撥測目標地址，只能輸入 P 地址或者網域名稱。

    www.example.com
    Interval

    integer

    否

    ICMP（Ping）資料包發送的時間間隔。單位為毫秒（ms），最小值為 200，最大值為 2000，預設為 200。

    200
    PackageNum

    integer

    否

    發送 ICMP（Ping）資料包的數量。最小值為 1，最大值為 50，預設為 4。

    4
    PackageSize

    integer

    否

    發送 ICMP（Ping）資料包的大小。單位為 byte，ICMP（PING）包大小隻限 32、64、128、256、512、1024、1080、1450。

    32
    SplitPackage

    boolean

    否

    是否拆分 ICMP（Ping）資料包。預設為 true。

    true
    Timeout

    integer

    否

    ICMP 撥測的逾時時間。單位為毫秒（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
    NetTCP

    object

    否

    TCP 撥測的配置參數。當 TaskType 為 2 時必填。

    TargetUrl

    string

    是

    撥測目標地址（主機）。

    www.example.com

    ConnectTimes

    integer

    否

    建立 TCP 串連的次數。最小值為 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

    是

    DNS 撥測的目標地址（網域名稱）。

    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://www.demo.com/api/list
    Method

    string

    否

    HTTP 方法，GET 或 POST。

    GET
    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 字串即可。

    { "key1": "value1", "key2": "value2" }
    Type

    string

    否

    請求體類型，支援：text/plain、application/json、application/x-www-form-urlencoded、multipart/form-data、application/xml、text/html

    application/json
    ConnectTimeout

    integer

    否

    連線逾時, 單位 ms，預設 5000，可選範圍：1000~300000ms。

    5000
    Timeout

    integer

    否

    逾時時間，單位 ms，預設 10000，可選範圍：1000~300000ms。

    10000
    CheckCert

    boolean

    否

    是否校正認證，預設為否。

    true
    ProtocolAlpnProtocol

    integer

    否

    ALPN 協議版本（wap 移動端並且是 HTTPS 任務時可配置）：

    0-default 系統預設行為

    1-http/1.1

    2-h2

    3-off 關閉,不啟用 alpn_protocol

    1
    Website

    object

    否

    網站測速類型任務配置。

    TargetUrl

    string

    是

    目標 URL。

    https://www.aliyun.com
    AutomaticScrolling

    integer

    否

    是否支援自動滾動螢幕，載入頁面。

    • 0（預設）：否

    • 1：是

    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 參數非法，0：過濾，1：不過濾，預設 0。

    0
    IgnoreCertificateError

    integer

    否

    是否忽略在 SSL 握手中認證校正過程中的認證錯誤而繼續瀏覽，0-不忽略，1-忽略，預設為 1。

    1
    MonitorTimeout

    integer

    否

    監測逾時，單位為 ms。非必填，預設 20000。

    20000
    Redirection

    integer

    否

    當出現重新導向後，是否要繼續瀏覽, 0-否，1-是，預設是 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

    否

    識別元素：設定瀏覽頁面元素總個數。

    10
    FileDownload

    object

    否

    檔案下載類型任務配置。

    TargetUrl

    string

    是

    檔案下載連結。

    https://img.alicdn.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-212-48.png
    DownloadKernel

    integer

    否

    下載核心。

    • 1：curl

    • 0：WinInet

    預設 1

    1
    QuickProtocol

    integer

    否

    Quick 協議

    • 1：http1

    • 2：http2

    • 3：http3

    預設 1

    1
    ConnectionTimeout

    integer

    否

    連線逾時時間，ms，預設 5000，可選範圍：1000~120000ms 之間。

    5000
    MonitorTimeout

    integer

    否

    監測逾時時間，ms，預設 60000，可選範圍：1000~120000ms 之間。

    60000
    CustomHeaderContent

    object

    否

    自訂要求標頭內容，JSON Map。

    string

    否

    JSON Map。

    { "key1": "value1", "key2": "value2" }
    IgnoreCertificateStatusError

    integer

    否

    認證狀態錯誤忽略，0：不忽略，1：忽略，預設 1。

    1
    IgnoreCertificateUntrustworthyError

    integer

    否

    認證不可信忽略，0：不忽略，1：忽略，預設 1。

    1
    IgnoreInvalidHostError

    integer

    否

    主機無效錯誤忽略，0：不忽略，1：忽略，預設 1。

    1
    Redirection

    integer

    否

    是否支援重新導向, 0：不支援，1：支援，預設 1。

    1
    TransmissionSize

    integer

    否

    傳輸大小，KB，預設 2048KB，檔案下載的傳輸大小必須在 1~20480KB 之間。

    2048
    IgnoreCertificateCanceledError

    integer

    否

    忽略認證撤銷錯誤 0：不忽略，1：忽略，預設 1。

    1
    IgnoreCertificateAuthError

    integer

    否

    忽略 CA 憑證授權錯誤 0：不忽略，1：忽略，預設 1。

    1
    IgnoreCertificateOutOfDateError

    integer

    否

    忽略認證到期錯誤 0：不忽略，1：忽略，預設 1。

    1
    IgnoreCertificateUsingError

    integer

    否

    忽略認證使用錯誤 0：不忽略，1：忽略，預設 1。

    1
    VerifyWay

    integer

    否

    驗證方式。

    • 0：不驗證

    • 1：驗證字串

    • 2：MD5 驗證

    0
    ValidateKeywords

    string

    否

    驗證關鍵詞。

    aliyun
    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
    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

    是

    城市編碼。

    100023
    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。

    8
    CommonSetting

    object

    否

    通用設定。

    CustomHost

    object

    否

    自訂 host

    Hosts

    array<object>

    是

    host 列表。

    object

    是

    自訂 host

    Domain

    string

    是

    網域名稱

    www.aliyun.com
    IpType

    integer

    是

    IP 類型：

    • 0：自動

    • 1：IPv4

    • 2：IPv6

    0
    Ips

    array

    是

    IP 列表。

    string

    是

    IP。

    10.176.141.63
    SelectType

    integer

    是

    選擇方式：

    • 0：隨機

    • 1：輪詢

    0
    IpType

    integer

    否

    IP 類型：

    • 0：自動

    • 1：IPv4

    • 2：IPv6

    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

    否

    地區。

    cn-hangzhou
    VpcId

    string

    否

    VPC ID.

    vpc-bp1muectbr8f90vjxxxxx
    VSwitchId

    string

    否

    交換器 ID。

    vsw-bp14crq29vpycxp8xxxxx
    SecureGroupId

    string

    否

    安全性群組 ID，此安全性群組是撥測用戶端所在的安全性群組，安全性群組限定了撥測用戶端在 VPC 中的出入站規則。需要設定您的 VPC 所在安全性群組的入站規則為允許撥測用戶端所在的安全性群組訪問。否則，撥測用戶端無法順暢地訪問您的 VPC 內資源。

    sg-bp13wzf9vuwegmpxxxxx
    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（完全載入時間），具體使用見下文補充說明。

    DnsARecord
    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：正則匹配。

    eq
    Expect

    string

    是

    期望值

    200
    ResourceGroupId

    string

    否

    可不傳

    xxxx
    Tags

    array<object>

    否

    標籤列表。

    object

    否

    標籤。

    Key

    string

    否

    標籤鍵。

    Key
    Value

    string

    否

    標籤值。

    500

    斷言配置說明如下：

    HTTP 類型任務

    • type 為 HttpResCode 時，operator 支援 eq、neq、gt、gte、lt、lte、belong、n_belong

    • type 為 HttpResHead 時，operator 支援所有

    • type 為 HttpResBody，operator 支援所有

    • type 為 HttpResBodyJson，operator 支援所有

    • type 為 HttpResponseTime，支援 gt、gte、lt、lte、eq、belong

    ICMP 類型任務

    • type 為 IcmpPackLoss 時，名稱為丟包率%，支援 gt、gte、lt、lte、eq、belong

    • type 為 IcmpPackMaxLatency 時，名稱為最大包延時 ms，支援 gt、gte、lt、lte、eq、belong

    • type 為 IcmpPackAvgLatency 時，名稱為平均延時 ms，支援 gt、gte、lt、lte、eq、belong

    • TraceRouteHops 時，名稱為躍點數目，支援 gt、gte、lt、lte、eq、belong

    DNS 類型任務

    • type 為 DnsARecord 時，名稱為 A 記錄，target 有兩個選擇 every(展示-每條記錄)和 any(展示-存在記錄)，支援 eq、ctn、nctn、reg_match、not_reg_match

    • type 為 DnsCName 時，名稱為 Cname，target 有兩個選擇 every(展示-每條記錄)和 any(展示-存在記錄)，支援 eq、ctn、nctn、reg_match、not_reg_match

    WEBSITE 類型任務

    • type 為 websiteTTFB 時，名稱為首包時間，支援 gt、gte、lt、lte、eq、belong

    • type 為 websiteTTLB 時，名稱為尾包時間，支援 gt、gte、lt、lte、eq、belong

    • type 為 websiteFST 時，名稱為首屏時間，支援 gt、gte、lt、lte、eq、belong

    • type 為 websiteFFST 時，名稱為首屏完全渲染時間，支援 gt、gte、lt、lte、eq、belong

    • type 為 websiteOnload 時，名稱為完全載入時間，支援 gt、gte、lt、lte、eq、belong

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

    53B5874D-EBC1-5567-B787-E4B7267F5CEB
    Success

    boolean

    操作是否成功：true：操作成功 false：操作失敗

    true
    Code

    integer

    狀態代碼。200 表示成功。

    200
    Message

    string

    返回資訊。

    success
    Data

    object

    返回結果。

    TaskId

    string

    雲撥測任務 ID。

    5308a2691f59422c8c3b7aeccec9cd3b
    Status

    string

    任務狀態。取值：

    • INIT：建立任務。

    • RELEASE：解析中。

    • RUNNING：運行中。

    • STOP：暫停。

    • SYSTEM_STOP：系統暫停。

    • CANCEL：取消。

    • SYSTEM_CANCEL：系統取消。

    • DONE：已經完成。

    RUNNING

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "53B5874D-EBC1-5567-B787-E4B7267F5CEB",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "Data": {
    "TaskId": "5308a2691f59422c8c3b7aeccec9cd3b",
    "Status": "RUNNING"
  }
}

    錯誤碼

    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 CommercialStatusException %s
    403 SyntheticTrailExpired %s
    403 SyntheticInDebt %s
    403 SyntheticDailyTimesExhausted %s
    403 SyntheticDailyLimit %s
    403 APINotAuthorize The current user is not authorized to access the interface. 目前使用者無許可權訪問該介面
    403 INNER_PROHIBIT 內部使用者禁用雲撥測服務, 如需使用, 請加DingTalk群31359689聯絡白璵

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

    變更歷史

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