全部產品
Search
文件中心

Cloud Monitor:DescribeSiteMonitorAttribute

更新時間:Jul 30, 2026

呼叫 DescribeSiteMonitorAttribute 介面查詢網站監控任務的詳細資訊。

介面說明

本文將提供一個範例,查詢網站監控任務 cc641dff-c19d-45f3-ad0a-818a0c4f**** 的詳細資訊,返回結果顯示,網站監控任務的名稱為 test123、探測位址為 https://aliyun.com、營運商為 阿里巴巴 等資訊。

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

TaskId

string

監控任務 ID。

cc641dff-c19d-45f3-ad0a-818a0c4f****

IncludeAlert

boolean

返回的任務詳情是否包含警示規則。

false

關於公用請求參數的詳情,請參閱公用參數

返回參數

名稱

類型

描述

樣本值

object

返回結果。

Code

string

狀態碼。

200

Message

string

返回資訊。

successful

MetricRules

object

MetricRule

array<object>

監控任務的警示規則。

object

監控任務的警示規則。

ActionEnable

string

警示規則的狀態。取值:

true

AlarmActions

string

警示規則通知的警示聯絡群組。

CloudMonitor

ComparisonOperator

string

警示規則的臨界值比較運算子。取值:

GreaterThanYesterday

Dimensions

string

警示規則對應的維度。

[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]

EvaluationCount

string

警示重試次數。

3

Expression

string

警示規則的運算式。

$Availability=30

Level

string

警示規則的層級。取值:

2

MetricName

string

監控項目名稱。

Availability

Namespace

string

雲端服務的資料命名空間。

acs_networkmonitor

OkActions

string

收到警示的聯絡人群組。

[ "CloudMonitor"]

Period

string

時間間隔。通常是監控項目的上報週期,單位:秒。

15s

RuleId

string

警示規則 ID。

bf071ae_7b7aec3817b0fdf****

RuleName

string

警示規則名稱。

rule1

StateValue

string

警示的狀態。取值:

OK

Statistics

string

警示的統計方法。取值:

Availability

Threshold

string

警示臨界值。

30

RequestId

string

請求 ID。

D17DF650-7EBD-54D0-903A-1D4E624D7402

SiteMonitors

object

監控任務詳細資訊。

Address

string

監控任務的偵測位址。

https://aliyun.com

AgentGroup

string

偵測點類型。預設為 PC。

PC

CustomSchedule

object

自訂偵測週期。只能選擇週一至週日的某個時間段進行偵測。

days

object

days

array

偵測日。

integer

偵測日。

1

end_hour

integer

自訂偵測結束時間。

18

start_hour

integer

自訂偵測開始時間。

8

time_zone

string

自訂偵測的時區。

local

Interval

string

監控任務的週期。單位:分鐘。取值:1、5、15、30 和 60。

1

IspCities

object

IspCity

array<object>

偵測點的營運商和城市。

object

偵測點的營運商和城市。

City

string

城市 ID。

738

CityName

string

城市名稱。

北京市。

Isp

string

營運商 ID。

465

IspName

string

營運商名稱。

阿里巴巴。

Type

string

偵測點網路類型。取值:

IDC

OptionJson

object

擴充選項。每一種偵測類型有不同的擴充類型,詳情請參見 CreateSiteMonitor

assertions

object

assertions

array<object>

斷言設定群組。

object

斷言設定群組。

operator

string

斷言比較運算子。取值:

lessThan

property

string

斷言內容解析路徑。

json path

target

string

斷言比對比較的目標數值或字元。

0

type

string

斷言類型。取值:

response_time

attempts

integer

DNS 失敗後重試次數。

3

auth_info

object

鑑權資訊。

type

string

鑑權資訊,目前支援 HTTP Basic Authentication。可選值為 basic。

basic

username

string

HTTP Basic Authentication 使用的使用者名稱。

test_username

password

string

HTTP Basic Authentication 使用的密碼。

test_password

grant_type

string

在 Oauth2.0 驗證中,使用的鑑權類型。可選值為 client_credentials 和 password。

password

client_id

string

在 Oauth2.0 中使用用戶端鑑權時的用戶端 ID。

client_id

client_secret

string

在 Oauth2.0 中使用用戶端鑑權時的用戶端金鑰。

client_secret

scopes

object

scopes

array

在 Oauth2.0 中申請的權限範圍。

string

在 Oauth2.0 中申請的單一權限。

test_operation

token_url

string

OAuth2.0 中的驗證伺服器位址。

https://www.example.com

auth_style

string

OAuth2.0 驗證風格,可選值為 ROA 和 RPC。

ROA

access_key_id

string

僅在多步撥測中支援,使用阿里雲鑑權時傳入的 accessKey,建議使用加密儲存。

testAk

access_key_secret

string

僅在多步撥測中支援,使用阿里雲鑑權時傳入的 accessKey Secret,建議使用加密儲存。

testSk

region_id

string

僅在多步撥測中支援,使用阿里雲鑑權時請求的 regionId。

cn-hangzhou

api_action

string

僅在多步撥測中支援,使用阿里雲操作時請求的 API。

example_api

api_version

string

僅在多步撥測中支援,使用阿里雲操作時請求的 API 版本。

2019-01-01

with_addon_resources

boolean

僅在多步撥測中支援,當該步驟使用阿里雲鑑權時,操作是否存在額外資源。

false

service_name

string

使用 AWS 鑑權時請求的服務名稱。

example_service_name

session_token

string

使用 AWS 鑑權時的 session_token。

example_token

blocked_url_list

object

blocked_url_list

array

封鎖的資源 URL 清單。支援路徑萬用字元。

string

封鎖的資源 URL 清單。支援路徑萬用字元。

www.taobao.com/**

browser_headers

object

browser_headers

array<object>

自訂標頭。結構為 {"key": "somekey", "value":"somevalue"}

object

自訂標頭。結構為 {"key": "somekey", "value":"somevalue"}

{"key":"value"}

browser_hosts

object

browser_hosts

array

自訂 Host。結構為 {"url":"someurl", "ip":"someip"}

string

自訂 Host。結構為 {"url":"someurl", "ip":"someip"}

{"url":"www.taobao.com","ip":"127.0.0.1"}

browser_info

object

browser_info

array<object>

瀏覽器資訊。

object

瀏覽器資訊。

browser

string

瀏覽器類型。

Chrome

device

string

螢幕類型。

laptop

browser_insecure

boolean

是否忽略憑證錯誤。取值:

false

browser_task_version

string

瀏覽器撥測版本。取值:

1

cookie

string

傳送 HTTP 請求的 Cookie。

lang=en

diagnosis_mtr

boolean

是否啟用任務失敗後的自動 MTR 網路診斷。取值:

false

diagnosis_ping

boolean

是否啟用任務失敗後自動 PING 網路延遲探測。取值:

false

dns_hijack_whitelist

string

DNS 劫持設定清單。

www.taobao.com:www.taobao.com.danuoyi.tbcache.com

dns_match_rule

string

DNS 的比對規則。取值:

IN_DNS

dns_server

string

DNS 伺服器的 IP 位址。

192.168.XX.XX

dns_type

string

DNS 解析類型。僅適用於 DNS 探測類型。取值:

A

empty_message

boolean

是否允許 WebSocket 任務不傳回訊息或傳回空訊息。取值:

false

expect_exist_string

object

expect_exist_string

array

預期頁面中存在的字串清單。

string

預期頁面中存在的字串清單。

expected string

expect_non_exist_string

object

expect_non_exist_string

array

預期頁面中不存在的字串清單。

string

預期頁面中不存在的字串清單。

unexpected string

expect_value

string

待解析的別名或位址。

dns_server

failure_rate

number

封包遺失率。

0.4

header

string

HTTP 請求標頭。

testKey:testValue

http_method

string

HTTP 請求方法。取值:

get

ip_network

string

ip_network 指示該任務的網路類型,可選值為 v4、v6、auto,預設值為 v4。

v4

isBase64Encode

string

是否對密碼進行 base64 解碼儲存。取值:

false

match_rule

integer

是否包含警示規則。取值:

1

min_tls_version

string

最低 TLS 版本。預設支援 TLS1.2 及以上版本,TLS1.0 和 1.1 已被停用,如仍需支援可變更設定。

tlsv1.2

password

string

SMTP、POP3 或 FTP 探測類型的密碼。

123****

ping_num

integer

PING 探測類型的心跳。

29

ping_port

integer

PING 連接埠。適用於 TCP PING。

80

ping_type

string

PING 通訊協定類型。取值:

icmp

port

integer

TCP、UDP、SMTP、POP3 探測類型的連接埠。

110

protocol

string

探測通訊協定。

TCP

quic_enabled

boolean

瀏覽器撥測是否使用 QUIC 通訊協定,取值:

true

quic_target

object

quic_target

array

強制使用 QUIC 通訊協定的網站清單。

string

強制使用 QUIC 通訊協定的網站,格式為 url:port,port 可以不填,預設為 443。

www.taobao.com

request_content

string

HTTP 探測類型的請求內容。

aa=bb

request_format

string

HTTP 請求內容格式。取值:

txt

response_content

string

比對回應內容。

txt

response_format

string

HTTP 回應內容格式。取值:

txt

retry_delay

integer

探測失敗後重試次數。

0

screen_shot

boolean

是否啟用頁面截圖。

false

strict_mode

boolean

false

time_out

integer

逾時時間。單位:毫秒。

3

traffic_hijack_element_blacklist

object

traffic_hijack_element_blacklist

array

當發生重新導向時,如果瀏覽器載入資源的 URL 與該清單中的運算式能比對,則認為發生流量劫持。

string

當發生重新導向時,如果瀏覽器載入資源的 URL 與該清單中的運算式能比對,則認為發生流量劫持。

www.taobao.com

traffic_hijack_element_count

integer

當發生重新導向時,如果瀏覽器載入資源數超過這個值,則認為發生流量劫持。當該值為 0 時,不進行驗證,預設值為 0。

0

traffic_hijack_element_whitelist

object

traffic_hijack_element_whitelist

array

當發生重新導向時,如果瀏覽器載入資源的 URL 與該清單中的任意一個運算式都不比對,則認為發生流量劫持。

string

當發生重新導向時,如果瀏覽器載入資源的 URL 與該清單中的任意一個運算式都不比對,則認為發生流量劫持。

www.taobao.com

username

string

FTP、SMTP 或 POP3 的使用者名稱。

testUser

waitTime_after_completion

integer

瀏覽器撥測任務中,頁面開啟後的額外等待時間。

3

scroll_end

boolean

當任務為瀏覽器探測任務時,scroll_end 代表開啟頁面之後是否捲動到頁面最底端。

false

host_binding

string

HTTP 任務自訂 host,格式為 ip1,ip2:address,可以設定多行對應。冒號左邊是網域可被解析的 A 記錄或 CNAME,使用逗號隔開,冒號右邊是網域。

127.0.0.1:www.aliyun.com

host_binding_type

integer

host_binding_type 的可選值為 0 或 1,指示自訂 host 的生效方式。0 表示隨機,1 表示輪詢。

枚舉值:

  • 0 :

    0

  • 1 :

    1

0

hops

integer

指定 PING 任務失敗時,執行 traceroute 診斷的跳躍數。

20

icmp_timeout_millis

integer

指定使用 ICMP 通訊協定進行的 PING 任務的單次 PING 逾時時間,單位為毫秒。

3000

config_variables

object

config_variables

array<object>

環境變數設定,對多步探測生效。

object

環境變數可以在不同測試步驟的參數中被引用(使用預留位置 {{$.變數名稱}}),也可以從一步測試結果中解析傳回內容並對對應的變數更新賦值且在下一步的測試中引用。對於敏感資訊,如 API 金鑰,可勾選加密儲存。

name

string

環境變數名稱。

variable_name

value

string

變數值。

variable_value

secure

boolean

加密儲存。

true

steps

object

steps

array<object>

對多步探測生效。多步探測中的步驟設定。

array<object>

多步探測中的單步設定。

name deprecated

string

步驟名稱(已廢棄)。

step1

step_type

string

該步驟的撥測類型。可選類型有:

http

url

string

多步撥測中,單步撥測的 URL。

https://aliyun.com

allow_failure

boolean

目前步驟如果失敗,是否還繼續下一步探測。預設值為 false。

true

is_critical

boolean

如果目前步驟失敗,則會標記整個探測為失敗。預設值為 false。

true

wait_time_in_secs

integer

等待時間,單位為秒。

5

extracted_variables

object

extracted_variables

array<object>

變數提取設定。

array<object>

單一變數提取設定。

name

string

變數名稱。

test_variable

parser

object

變數提取方法設定。

parser_type

string

提取變數的模式。0 為 JSON,1 為 XML,2 為正規運算式。

0

value

string

變數提取運算式。

x.testkey.arrayvalue[0].innerkey

field

string

當變數位置為 HTTP header 時,該選項生效。提取 header 中該選項所指向的 key。

request_id

extracted_type

string

提取變數的位置。0 為 HTTP body,1 為 HTTP header。

1

option

string

該步驟的擴充選項。每一種探測類型有不同的擴充類型,詳情請參見 CreateSiteMonitor

{"enable_operator_dns": true}

step_name

string

步驟名稱。

step1

trace_region

string

設定與可觀測鏈路 OpenTelemetry 版本整合時,目標應用程式的部署地域。

cn-hangzhou

trace_type

string

設定與可觀測鏈路 OpenTelemetry 版本整合時,使用的鏈路追蹤通訊協定。

OpenTelemetry

enable_packet_capture

boolean

該任務是否啟用封包擷取。

true

use_private_crt

boolean

是否使用私有憑證。

private_crt_file_name

string

私有憑證檔案名稱。

cert.pem

use_ssl

boolean

執行 TCP 任務時是否進行 SSL 連線。

tlsv1.0

max_tls_version

string

最高 TLS 版本。

tlsv1.3

server_name

string

伺服器名稱指示。

www.aliyun.com

supported_cipher_suits

string

支援的加密套件。

TLS_AES_256_GCM_SHA384

TaskId

string

監控任務 ID。

cc641dff-c19d-45f3-ad0a-818a0c4f****

TaskName

string

監控任務名稱。

test123

TaskState

string

監控任務的狀態。取值:

1

TaskType

string

監控任務類型。目前站點監控任務的類型包括:HTTP(S)、PING、TCP、UDP、DNS、SMTP、POP3、FTP。

HTTP

VpcConfig

object

內網撥測任務的 VPC 配置資訊。

Region

string

內網撥測任務的目標站點所在地域。

cn-beijing

SecurityGroupId

string

該內網撥測任務受限於的安全性群組 ID。

sg-xxxxxx

VpcId

string

該內網撥測任務掛載的 VPC ID。

vpc-xxxxxx

VswitchId

string

該內網撥測任務掛載的 VSwitch ID。

vsw-xxxxxx

Success

boolean

操作是否成功。取值:

true

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "MetricRules": {
    "MetricRule": [
      {
        "ActionEnable": "true",
        "AlarmActions": "CloudMonitor",
        "ComparisonOperator": "GreaterThanYesterday",
        "Dimensions": "[{\"taskId\": \"cc641dff-c19d-45f3-ad0a-818a0c4f****\" }]",
        "EvaluationCount": "3",
        "Expression": "$Availability=30",
        "Level": "2",
        "MetricName": "Availability",
        "Namespace": "acs_networkmonitor",
        "OkActions": "[ \"CloudMonitor\"]",
        "Period": "15s",
        "RuleId": "bf071ae_7b7aec3817b0fdf****",
        "RuleName": "rule1",
        "StateValue": "OK",
        "Statistics": "Availability",
        "Threshold": "30"
      }
    ]
  },
  "RequestId": "D17DF650-7EBD-54D0-903A-1D4E624D7402",
  "SiteMonitors": {
    "Address": "https://aliyun.com",
    "AgentGroup": "PC",
    "CustomSchedule": {
      "days": {
        "days": [
          1
        ]
      },
      "end_hour": 18,
      "start_hour": 8,
      "time_zone": "local"
    },
    "Interval": "1",
    "IspCities": {
      "IspCity": [
        {
          "City": "738",
          "CityName": "北京市。",
          "Isp": "465",
          "IspName": "阿里巴巴。",
          "Type": "IDC"
        }
      ]
    },
    "OptionJson": {
      "assertions": {
        "assertions": [
          {
            "operator": "lessThan",
            "property": "json path",
            "target": "0",
            "type": "response_time"
          }
        ]
      },
      "attempts": 3,
      "auth_info": {
        "type": "basic",
        "username": "test_username",
        "password": "test_password",
        "use_cookie_session_key": false,
        "grant_type": "password",
        "client_id": "client_id",
        "client_secret": "client_secret",
        "scopes": {
          "scopes": [
            "test_operation"
          ]
        },
        "token_url": "https://www.example.com",
        "auth_style": "ROA",
        "access_key_id": "testAk",
        "access_key_secret": "testSk",
        "region_id": "cn-hangzhou",
        "api_action": "example_api",
        "api_version": "2019-01-01",
        "with_addon_resources": false,
        "service_name": "example_service_name",
        "session_token": "example_token"
      },
      "blocked_url_list": {
        "blocked_url_list": [
          "www.taobao.com/**"
        ]
      },
      "browser_headers": {
        "browser_headers": [
          {
            "key": "value"
          }
        ]
      },
      "browser_hosts": {
        "browser_hosts": [
          "{\"url\":\"www.taobao.com\",\"ip\":\"127.0.0.1\"}"
        ]
      },
      "browser_info": {
        "browser_info": [
          {
            "browser": "Chrome",
            "device": "laptop"
          }
        ]
      },
      "browser_insecure": false,
      "browser_task_version": "1",
      "cookie": "lang=en",
      "diagnosis_mtr": false,
      "diagnosis_ping": false,
      "dns_hijack_whitelist": "www.taobao.com:www.taobao.com.danuoyi.tbcache.com",
      "dns_match_rule": "IN_DNS",
      "dns_server": "192.168.XX.XX",
      "dns_type": "A",
      "empty_message": false,
      "expect_exist_string": {
        "expect_exist_string": [
          "expected string"
        ]
      },
      "expect_non_exist_string": {
        "expect_non_exist_string": [
          "unexpected string"
        ]
      },
      "expect_value": "dns_server",
      "failure_rate": 0.4,
      "header": "testKey:testValue",
      "http_method": "get",
      "ip_network": "v4",
      "isBase64Encode": "false",
      "match_rule": 1,
      "min_tls_version": "tlsv1.2",
      "password": "123****",
      "ping_num": 29,
      "ping_port": 80,
      "ping_type": "icmp",
      "port": 110,
      "protocol": "TCP",
      "quic_enabled": true,
      "quic_target": {
        "quic_target": [
          "www.taobao.com"
        ]
      },
      "request_content": "aa=bb",
      "request_format": "txt",
      "response_content": "txt",
      "response_format": "txt",
      "retry_delay": 0,
      "screen_shot": false,
      "strict_mode": false,
      "time_out": 3,
      "traffic_hijack_element_blacklist": {
        "traffic_hijack_element_blacklist": [
          "www.taobao.com"
        ]
      },
      "traffic_hijack_element_count": 0,
      "traffic_hijack_element_whitelist": {
        "traffic_hijack_element_whitelist": [
          "www.taobao.com"
        ]
      },
      "username": "testUser",
      "waitTime_after_completion": 3,
      "scroll_end": false,
      "host_binding": "127.0.0.1:www.aliyun.com",
      "host_binding_type": 0,
      "hops": 20,
      "icmp_timeout_millis": 3000,
      "config_variables": {
        "config_variables": [
          {
            "name": "variable_name",
            "value": "variable_value",
            "secure": true
          }
        ]
      },
      "steps": {
        "steps": [
          {
            "name": "step1",
            "step_type": "http",
            "url": "https://aliyun.com",
            "allow_failure": true,
            "is_critical": true,
            "wait_time_in_secs": 5,
            "extracted_variables": {
              "extracted_variables": [
                {
                  "name": "test_variable",
                  "parser": {
                    "parser_type": "0",
                    "value": "x.testkey.arrayvalue[0].innerkey"
                  },
                  "field": "request_id",
                  "extracted_type": "1"
                }
              ]
            },
            "option": "{\"enable_operator_dns\": true}",
            "step_name": "step1",
            "use_generated_cookie": true,
            "auto_extract_cookie": true
          }
        ]
      },
      "trace_region": "cn-hangzhou",
      "trace_type": "OpenTelemetry",
      "safe_link": 0,
      "enable_packet_capture": true,
      "use_private_crt": false,
      "private_crt_file_name": "cert.pem",
      "use_ssl": true,
      "max_tls_version": "tlsv1.3",
      "server_name": "www.aliyun.com",
      "supported_cipher_suits": "TLS_AES_256_GCM_SHA384"
    },
    "TaskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****",
    "TaskName": "test123",
    "TaskState": "1",
    "TaskType": "HTTP",
    "VpcConfig": {
      "Region": "cn-beijing",
      "SecurityGroupId": "sg-xxxxxx",
      "VpcId": "vpc-xxxxxx",
      "VswitchId": "vsw-xxxxxx"
    }
  },
  "Success": true
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 ParameterInvalid The parameter is missing or invalid. %s 非法參數。
401 AccessDeniedException You donot have sufficient access to perform this action.
500 InternalError The request processing has failed due to some unknown error.
402 LimitExceeded The quota for this customer had been reached.
403 Forbidden You are not authorized to operate the specified resource. 沒有權限,請使用 RAM 進行授權。
404 Forbidden Task Id does not exist
406 ExceedingQuota Exceeding quota limits. 任務數量超出限額。
429 Throttli∂ngException The request was denied due to request throttling.

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

變更歷史

更多資訊,參考變更詳情