全部產品
Search
文件中心

Application Real-Time Monitoring Service:GetAppApiByPage - 查詢介面的黃金三指標資料

更新時間:Apr 10, 2026

通過分頁的形式查詢應用下每個介面的請求量、錯誤數、平均回應時間三種效能資料。可通過返回資訊中的Completed欄位判斷分頁是否結束。如未結束,CurrentPage參數加一後繼續發起查詢即可。

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

地區 ID。

cn-hangzhou

StartTime

integer

開始時間的時間戳記,精確到毫秒。

1600063200000

EndTime

integer

結束時間的時間戳記,精確到毫秒。

1600066800000

CurrentPage

integer

查詢結果的頁碼。

1

PageSize

integer

此參數已不支援使用。查詢結果的每頁專案數量。預設為 10。

10

IntervalMills

integer

資料片的時間間隔,單位為毫秒,最小值為 60000,最大值為 2147483647。

60000

PId

string

應用 ID。

在 ARMS 控制台的應用監控>應用列表頁面單擊目標應用程式名稱。此時瀏覽器地址欄中的 URL 即包含應用的 pid,格式為 pid=xxx。由於瀏覽器進行了編碼,因此需要對 pid 稍作修改。例如,如果 URL 中包含的 pid 為 xxx%4074xxx,則需要將%40 替換為@,即:xxx@74xxx。

a2n80plglh@745eddxxx

返回參數

名稱

類型

描述

樣本值

object

Code

integer

介面狀態。

  • 2XX:成功。

  • 3XX:重新導向。

  • 4XX:請求錯誤。

  • 5XX:伺服器錯誤。

200

Message

string

返回結果的提示資訊。

message

RequestId

string

請求 ID。

B6A00968-82A8-4F14-9D1B-B53827DB****

Success

boolean

查詢是否成功。

  • true:成功。

  • false:失敗。

true

Data

object

返回結構體。

PageSize

integer

返回結果的每頁專案數量。

10

Total

string

返回結果的總專案數量。

說明

此參數的傳回值為估算值,僅用於分頁結束判斷,不代表實際的資料總量

2

Page

integer

返回結果的頁碼。

1

Completed

boolean

分頁查詢是否結束。

  • true:結束。

  • false:需要繼續分頁(CurrentPage+1 後繼續查詢)。

false

Items

array<object>

返回應用介面的黃金三指標資料

object

介面的黃金三指標資料

{
     "date": 1691051460000, //發生時間
     "rt": 89.61016949152541,  //平均回應時間
     "rpc": "/api/v1/info",  //介面
     "count": 59,  //請求數
     "error": 1  //錯誤數
}

[]

樣本

正常返回樣本

JSON格式

{
  "Code": 200,
  "Message": "message",
  "RequestId": "B6A00968-82A8-4F14-9D1B-B53827DB****",
  "Success": true,
  "Data": {
    "PageSize": 10,
    "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 ParameterIllegal The specified parameter is invalid. 參數非法
400 ParameterRegionIllegal The specified region is invalid. 地區參數非法
500 InternalError Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries. 內部錯誤,建議重試。如果多次重試報錯請聯絡DingTalk服務帳號。
403 RetcodeDailyCustomLimit Usage today has exceeded the custom limit. The current operation is prohibited. 今日使用額度已經超過自訂額度,當前操作被禁止。
403 RetcodeDailyFreeLimit Usage today has exceeded the Essential Edition limit. The current operation is prohibited. 今日使用額度已經超過基礎版限定量,當前操作被禁止。
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. 後端服務無法完整的處理當前請求,返回結果可能是不完整的,請調整操作條件後重試。

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

變更歷史

更多資訊,參考變更詳情