分頁查詢應用監控或前端監控的相關監控指標。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| IntervalInSec |
integer |
否 |
資料片的時間間隔,單位為毫秒,最小值為 60000。 |
100000 |
| StartTime |
integer |
是 |
起始時間的時間戳記,精確到毫秒。 |
1667287695000 |
| EndTime |
integer |
是 |
結束時間的時間戳記,精確到毫秒。 |
1667546895000 |
| OrderBy |
string |
否 |
排序依據,可設為任一維度,請參見下文補充說明。 |
pid |
| Metric |
string |
是 |
需要查詢的指標,不可自訂輸入,請參見下文補充說明。 |
appstat.host |
| Order |
string |
否 |
排序標準。取值:
說明
不填則不排序。 |
ASC |
| CurrentPage |
integer |
否 |
查詢結果的頁碼,預設為 |
1 |
| PageSize |
integer |
否 |
此參數已不支援使用。查詢結果的每頁專案數量。 |
10 |
| Filters |
array<object> |
否 |
篩選條件組合。 |
|
|
object |
否 |
參數結構體。 |
||
| Key |
string |
否 |
篩選條件組合,必須添加 |
pid |
| Value |
string |
否 |
篩選條件組合,必須添加 |
xxx@74xxx |
| Dimensions |
array |
否 |
指標對應的維度。 |
["detector_browser","detector_device"] |
|
string |
否 |
指標對應的維度,請參見下文補充說明。最多可添加 5 個。 |
pid |
|
| Measures |
array |
否 |
指標對應的測量資料。 |
pv |
|
string |
否 |
指標對應的測量資料,請參見下文補充說明。最多可添加 5 個。 |
instanceCount |
|
| CustomFilters |
array |
否 |
自訂過濾條件。 |
|
|
string |
否 |
自訂過濾條件,多個過濾條件之間使用半形逗號(,)分隔。 |
["not rpcType:40","not rpcType:41"] |
如何擷取應用 pid
在 ARMS 控制台左側導覽列選擇應用監控 > 應用列表或前端監控 > 前端列表,然後單擊目標應用程式名稱,以進入應用的總覽頁面。
此時瀏覽器地址欄中的 URL 即包含前端應用的 pid,格式為pid=xxx。由於瀏覽器進行了編碼,應用需要對xxx%40xxx格式的 pid 稍作修改。例如,如果 URL 中包含的 pid 為eb4zdose6v%409781be0f44d****,則需要將%40替換為@,即:eb4zdose6v@9781be0f44d****。
可查詢的應用監控指標
請求參數 Filters 必須添加pid和regionId條件。已知具體的查詢條件時,應將值傳入 Filters 參數中,用於限定查詢結果的範圍。如果不知道具體的查詢條件,可以將下表中的維度傳入 Dimensions 參數,從而獲得該維度所有可能值的列表。
| 指標(Metric) | 描述 | 維度(Dimensions) | 測量資料(Measures) |
| appstat.vm | 通用指標,對應應用詳情下的 JVM 監控圖表,包括 GC 指標、堆記憶體和非堆記憶體詳情以及線程數。 | - pid - rootIp | GC 指標: - youngGcCount:JVM 監控 Young GC 次數 - oldGcCount:JVM 監控 Full GC 次數 - youngGcTime:JVM 監控 Young GC 耗時 - oldGcTime:JVM 監控 Full GC 耗時 - youngGcCountInstant:JVM 監控 Young GC 次數瞬時值 - oldGcCountInstant:JVM 監控 Full GC 次數瞬時值 - youngGcTimeInstant:JVM 監控 Young GC 耗時瞬時值 - oldGcTimeInstant:JVM 監控 Full GC 耗時瞬時值 |
| appstat.vm | 通用指標,對應應用詳情下的 JVM 監控圖表,包括 GC 指標、堆記憶體和非堆記憶體詳情以及線程數。 | - pid - rootIp | 堆記憶體和非堆記憶體詳情: - edenSpace:年輕代 eden 區 - oldGen:老年代 - survivorSpace:年輕代 survivor 區 - metaSpace:元空間 - nonHeapCommitted:非堆記憶體 - nonHeapInit:非堆記憶體初始值 - nonHeapMax:非堆記憶體最大值 - nonHeapUsed:非堆記憶體使用量量 - directUsed:對外記憶體中 direct_buffer 已使用的大小 - directCapacity:對外記憶體中 direct_buffer 的總大小 |
| appstat.vm | 通用指標,對應應用詳情下的 JVM 監控圖表,包括 GC 指標、堆記憶體和非堆記憶體詳情以及線程數。 | - pid - rootIp | 線程數: - threadCount:線程總數 - threadNewCount:建立線程數 - threadDeadlockCount:JVM 內死結的個數 - threadRunnableCount:JVM 處於 Runnable 的線程個數 - threadTerminatedCount:終結線程數 - threadTimedWaitCount:處於 timed_waiting 狀態的線程個數 - threadWaitCount:處於 waiting 狀態的線程個數 - threadBlockedCount:阻塞線程數 |
| appstat.host | 主機監控,包括執行個體數、CPU、實體記憶體、磁碟、負載、網路流量(Bytes)和網路資料包數量。 | - pid - rootIp | instanceCount:執行個體數 |
| appstat.host | 主機監控,包括執行個體數、CPU、實體記憶體、磁碟、負載、網路流量(Bytes)和網路資料包數量。 | - pid - rootIp | CPU: - systemCpuIdle:最近 5s 的空閑 CPU 使用率,控制台頁面未展示 - systemCpuSystem:最近 5s 的系統 CPU 使用率 - systemCpuUser:最近 5s 的使用者 CPU 使用率 - systemCpuIoWait:最近 5s 的等待 IO 完成的 CPU 使用率 |
| appstat.host | 主機監控,包括執行個體數、CPU、實體記憶體、磁碟、負載、網路流量(Bytes)和網路資料包數量。 | - pid - rootIp | 實體記憶體: - systemMemFree:當前系統的空閑記憶體(KB) - systemMemUsed:當前系統的已經使用的記憶體(KB) - systemMemTotal:當前系統的總記憶體(KB),控制台頁面未展示 - systemMemBuffers:當前系統的 buffer cache 的記憶體數 - systemMemCached:當前系統的 page cache 裡的記憶體數 |
| appstat.host | 主機監控,包括執行個體數、CPU、實體記憶體、磁碟、負載、網路流量(Bytes)和網路資料包數量。 | - pid - rootIp | 磁碟: - systemDiskFree:磁碟空閑位元組數 - systemDiskUsage:磁碟使用率 - systemDiskTotal:磁碟總位元組數,公用雲控制台頁面未展示 |
| appstat.host | 主機監控,包括執行個體數、CPU、實體記憶體、磁碟、負載、網路流量(Bytes)和網路資料包數量。 | - pid - rootIp | systemLoad:負載 |
| appstat.host | 主機監控,包括執行個體數、CPU、實體記憶體、磁碟、負載、網路流量(Bytes)和網路資料包數量。 | - pid - rootIp | 網路: - systemNetInPackets:最近 30 秒平均每秒網路接收到的報文數 - systemNetOutPackets:最近 30 秒平均每秒網路發送的位元組數 - systemNetInErrs:最近 30 秒平均每秒網路接收的錯誤數 - systemNetOutErrs:最近 30 秒平均每秒網路發送的錯誤數 - systemNetInBytes:最近 30 秒平均每秒網路接收到的位元組數 - systemNetOutBytes:最近 30 秒平均每秒網路發送的位元組數 |
| appstat.database | 資料庫調用。 | - pid - rpcType:調用類型 - endpoint:資料庫地址為 localhost: 3306 - destId:庫名為 arms | - rt:回應時間,單位毫秒 - count:請求數 - error:錯誤數 - resultsize:僅支援 Mysql 5.X 版本 - slowcount:慢調用次數 |
| appstat.incall | 應用詳情。 | - pid - rpcType - rootIp - rpc - ppid | - rt:回應時間,單位毫秒 - count:請求數 - error:錯誤數 - errorrate:錯誤率 - qps:每秒查詢數 |
| appstat.exception | 異常。 | - pid - rpc - endpoint - excepType - excepInfo | - rt:回應時間,單位毫秒 - count:請求數 - error:錯誤數 |
| appstat.sql | 慢 SQL。 | - pid - rpc - endpoint - sqlId | - rt:回應時間,單位毫秒 - count:請求數 - error:錯誤數 - slowcount:慢調用次數 - resultsize:僅支援 Mysql 5.X 版本 說明:slow=true 時,limit 條件不生效。 |
| appstat.mq.send | MQ 發送。 | 無 | - rt:回應時間,單位毫秒 - count:請求數 - error:錯誤數 - delay:調度延遲,單位毫秒 |
| appstat.mq.receive | MQ 接收。 | 無 | - rt:回應時間,單位毫秒 - count:請求數 - error:錯誤數 - delay:調度延遲,單位毫秒 |
| appstat.schedulerx | SchedulerX 的調用量。 | - pid - rpcType - rootIp - rpc | count:請求數 |
| appstat.elasticsearch | Elasticsearch 的調用量。 | - rpc - endpoint - opType:操作類型。例如 index、search 等。僅使用 Elasticsearch rest high level client 時支援。 | count:請求數 |
| appstat.redis | Redis 的調用量。 | - pid - rpcType - endpoint - opType - rpc | count:請求數 |
| appstat.status | 查詢指定狀態代碼下的調用次數(僅支援 HTTP 服務)。 | - pid - rootIp - rpc | - 200:HTTP 狀態代碼為 200(即正常)的調用次數 - 2xx:HTTP 狀態代碼以 2 開頭(即正常)的調用次數 - 3xx:HTTP 狀態代碼為 3 開頭的調用次數 - 4xx:HTTP 狀態代碼以 4 開頭(即用戶端錯誤)的調用次數 - 5xx:HTTP 狀態代碼以 5 開頭(即服務端錯誤)的調用次數 |
可查詢的前端監控指標
您可以使用 QueryMetric 介面查詢前端監控的以下指標。
請求參數 Filters 必須添加pid和regionId條件。已知具體的查詢條件時,應將值傳入 Filters 參數中,用於限定查詢結果的範圍。如果不知道具體的查詢條件,可以將下表中的維度傳入 Dimensions 參數,從而獲得該維度所有可能值的列表。
| 指標(Metric) | 描述 | 維度(Dimensions) | 測量資料(Measures) |
| webstat.api | API 成功率 | - api(API 請求地址,不帶參數) - detector_app_version(用戶端版本) - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - release(版本號碼) - sr(螢幕解析度) | - count(請求次數) - rate(API 成功率) - avg_time(平均耗時) |
| webstat.api.detail | API 詳情 | - api(API 請求地址,不帶參數) - ct(網路制式) - detector_browser(瀏覽器) - detector_browser_version(瀏覽器版本) - detector_device(裝置) - detector_os(作業系統) - detector_os_version(作業系統版本) - domain(網域名稱) - ip_country_id(國家 ID 或地區 ID) - ip_isp(電訊廠商) - ip_region_id(中國省市 ID) - msg(返回資訊) - page(頁面地址) - sr(螢幕解析度) | - count(請求次數) - fail_count(失敗次數) - fail_time(失敗耗時) - fail_uv(失敗影響使用者數) - success_count(成功次數) - success_rate(成功率) - success_time(成功耗時) |
| webstat.apicost | API 成功耗時 | - api(API 請求地址,不帶參數) - code(返回狀態代碼) - detector_app_version(用戶端版本) - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - release(版本號碼) - sr(螢幕解析度) | - count(成功次數) - avg_time(成功耗時均值) |
| webstat.apifailtime | API 失敗耗時 | - api(API 請求地址,不帶參數) - code(返回狀態代碼) - detector_app_version(用戶端版本) - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - release(版本號碼) - sr(螢幕解析度) | - count(錯誤次數) - avg_time(失敗耗時均值) |
| webstat.apimsg | API 訊息聚類 | - code(返回狀態代碼) - detector_app_version(用戶端版本) - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - msg(錯誤資訊) - release(版本號碼) - sr(螢幕解析度) - success(1 表示請求成功,0 表示請求失敗) | count(請求次數) |
| webstat.avg | 自訂統計:均值統計 | - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - key(自訂 Key) - sr(螢幕解析度) | - count(總次數) - pv(頁面瀏覽量) - uv(使用者訪問量) - avg_val(平均值) |
| webstat.errcate | 錯誤聚類排行 | - msg(錯誤資訊) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - sr(螢幕解析度) - release(版本號碼) - environment(環境) - detector_app_version(用戶端版本) - detector_app(用戶端 App) | count(錯誤次數) |
| webstat.index | 總覽(訪問量) | - ct(網路制式) - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_isp(電訊廠商) - ip_region_id(中國省市 ID) - page(頁面地址) - sr(螢幕解析度) | - pv(頁面瀏覽量) - uv(獨立訪客) |
| webstat.msg.top | 頁面高頻錯誤 | - msg(錯誤資訊) - page(頁面地址) | - count(錯誤次數) - error_uv(影響使用者數) - 影響使用者率(影響使用者數÷總 UV) |
| webstat.perf.bucket | 對應 ARMS 前端監控控制台的訪問速度頁面上的效能樣本分層圖。 | - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - page(頁面地址) - sr(螢幕解析度) | - cfpt(自訂首屏) - ctti(自訂首次可互動) - dns(DNS 查詢耗時) - dom(DOM 解析耗時) - fmp(首屏時間) - fpt(首次渲染時間) - load(頁面完全載入時間) - ready(DOM Ready 時間) - res(資源載入耗時) - ssl(SSL 安全連線耗時) - t1~t10(自訂效能指標) - tcp(TCP 串連耗時) - trans(內容傳輸耗時) - ttfb(請求響應耗時) - tti(首次可互動時間) |
| webstat.perf.distribution | 對應 ARMS 前端監控控制台的訪問速度頁面上的效能分層圖。 | - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - page(頁面地址) - sr(螢幕解析度) | - cfpt(自訂首屏) - ctti(自訂首次可互動) - dns(DNS 查詢耗時) - dom(DOM 解析耗時) - fmp(首屏時間) - fpt(首次渲染時間) - load(頁面完全載入時間) - ready(DOM Ready 時間) - res(資源載入耗時) - ssl(SSL 安全連線耗時) - t1~t10(自訂效能指標) - tcp(TCP 串連耗時) - trans(內容傳輸耗時) - ttfb(請求響應耗時) - tti(首次可互動時間) |
| webstat.resource | 資源錯誤排行 | - ct(網路制式) - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_isp(電訊廠商) - ip_region_id(中國省市 ID) - node_name(錯誤類型) - page(頁面地址) - sr(螢幕解析度) - src(資源資訊) | count(資源錯誤數) |
| webstat.resource | 對應 ARMS 前端監控控制台的總覽頁面的資源彈層。 | - ct(網路制式) - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_isp(電訊廠商) - ip_region_id(中國省市 ID) - node_name(錯誤類型) - page(頁面地址) - sr(螢幕解析度) - src(資源資訊) | count(錯誤次數) |
| webstat.satisfy | 滿意度 | - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - page(頁面地址) - sr(螢幕解析度) | - bad(不滿意:fpt>8000) - good(滿意:fpt<2000) - neutral(可容忍:fpt>2000 且 fpt<8000) - satisfy(滿意指數) |
| webstat.session | 慢載入追蹤 | 無 | - browser_version(瀏覽器版本) - browser(瀏覽器) - date(開始時間) - dom(DOM 解析耗時) - ip_country_id(國家 ID 或地區 ID) - ip_country(中國省市) - ip_region_id(中國省市 ID) - ip_region(國家或地區) - load(頁面完全載入) - page(頁面地址) - sid(會話 ID) |
| webstat.speed | 訪問速度 | - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - release(版本號碼) - sr(螢幕解析度) - page(頁面地址) - environment(環境) | - avg_cfpt(自訂首屏) - count(樣本量) - avg_ctti(自訂首次可互動) - avg_dns(DNS 查詢耗時) - avg_dom(DOM 解析耗時) - avg_fmp(首屏時間) - avg_fpt(首次渲染時間) - avg_load(頁面完全載入時間) - avg_ready(DOM Ready 時間) - avg_res(資源載入耗時) - avg_ssl(SSL 安全連線耗時) - avg_t1~t10(自訂效能指標) - avg_tcp(TCP 串連耗時) - avg_trans(內容傳輸耗時) - avg_ttfb(請求響應耗時) - avg_tti(首次可互動時間) |
| webstat.stable | 錯誤率排行 | - page(頁面地址) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - sr(螢幕解析度) - msg(錯誤資訊) - release(版本號碼) - environment(環境) - detector_app_version(用戶端版本) - detector_app(用戶端 App) | - count(樣本量) - error_pv(錯誤樣本量) - rate(JS 錯誤率) |
| webstat.sum | 自訂統計:求和統計 | - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - key(自訂 key) - sr(螢幕解析度) | - count(總次數) - pv(頁面瀏覽量) - sum_val(總和) - uv(獨立訪客) |
| webstat.url | 訪問的 URL | - detector_browser(瀏覽器) - detector_device(裝置) - detector_os(作業系統) - ip_country_id(國家 ID 或地區 ID) - ip_region_id(中國省市 ID) - sr(螢幕解析度) - uid - username(使用者名稱) | - pv(頁面瀏覽量) - uv(獨立訪客) |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結構體。 |
||
| Code |
string |
介面狀態,取值說明如下:
|
200 |
| Message |
string |
調用失敗時返回的資訊。 |
StartTime is mandatory for this action. |
| RequestId |
string |
請求 ID。 |
687F9CB7-4798-57BF-A6EE-E6CC76****** |
| Success |
boolean |
查詢是否成功:
|
true |
| Data |
object |
返回結構體。 |
|
| PageSize |
integer |
查詢結果的每頁專案數量。 |
1 |
| Total |
integer |
查詢結果的總專案數量。 說明
此參數的傳回值為估算值,僅用於分頁結束判斷,不代表實際的資料總量。 |
2 |
| Page |
integer |
查詢結果的頁碼。 |
1 |
| Completed |
boolean |
分頁查詢是否結束。
|
false |
| Items |
array<object> |
返回資料。 |
|
|
object |
返回資料的資料結構體列表。 |
[] |
返回樣本
{
"RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******",
"Data": {
"PageSize": 1,
"Total": 87,
"Page": 1,
"Items": [
{
"date": 1667287680000,
"instanceCount": 17,
"rule": "query1",
"pid": "null"
},
{
"date": 1667290680000,
"instanceCount": 17,
"rule": "query1",
"pid": "null"
}
]
},
"Code": 200,
"Success": true
}
樣本
正常返回樣本
JSON格式
{
"Code": "200",
"Message": "StartTime is mandatory for this action.",
"RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******",
"Success": true,
"Data": {
"PageSize": 1,
"Total": 2,
"Page": 1,
"Completed": false,
"Items": [
[]
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 452 | OperationTimeOut | The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again. | 系統在處理當前請求時出現了逾時,可能是請求涉及的資源過多導致系統無法在限定時間內處理完畢,請調整相關條件後重試。 |
| 400 | ParameterMetricIllegal | The specified metric is invalid. | 參數metric非法 |
| 400 | ParameterMeasuresIllegal | The specified Measures is invalid. | Measures非法 |
| 400 | ParameterTimeStampIllegal | The specified timeStamp is invalid. | 時間參數非法 |
| 400 | ParameterOrderIllegal | The specified order is invalid. | 參數order非法 |
| 400 | ParameterZeroStrategyIllegal | The specified zeroStrategy is invalid. | 參數zeroStrategy非法 |
| 400 | ParameterPageSizeIllegal | The specified PageSize is invalid. | PageSize非法 |
| 400 | ParameterIntervalIllegal | The specified interval is invalid. | 參數Interval非法 |
| 400 | ParameterMeasuresMissing | You must specify measures. | 參數measures缺失 |
| 400 | ParameterDimensionsIllegal | The specified dimensions is invalid. | Dimensions非法 |
| 400 | ParameterPidMissing | You must specify pid. | 參數pid缺失 |
| 400 | ParameterRegionIdIllegal | The specified RegionId is invalid. | RegionId非法 |
| 400 | InternalError | Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries. | |
| 400 | ParameterRegionIllegal | The specified region is invalid. | 地區參數非法 |
| 403 | APINotAuthorize | The current user is not authorized to access the interface. | 目前使用者無許可權訪問該介面 |
| 404 | AppNotExist | The application does not exist. | 應用不存在 |
| 404 | RunningTaskNotExist | Application data collection task does not exist or has been stopped. | 應用資料擷取任務不存在或已停止 |
| 429 | OperationIsThrottled | The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again. | 後端服務無法完整的處理當前請求,返回結果可能是不完整的,請調整操作條件後重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。