閱讀920 返回首頁    go 阿裏雲 go 技術社區[雲棲]

查詢API錯誤分布數據__API管理相關接口_API_API 網關-阿裏雲

描述

查詢指定API的監控信息：Error

  • 此功能麵向開放API的用戶
  • 該接口用於查詢指定API監控數據中對失敗調用的統計數據
  • 監控功能默認對線上環境的API做統計，不包括測試環境的API調用

請求參數

名稱 類型 是否必須 描述
Action String 是 操作接口名，係統規定參數，取值：DescribeApiErrorData
GroupId String 否 分組編號
ApiId String 是 API編號
StartTime String 是 開始時間，按照ISO8601標準表示，並需要使用UTC時間。格式為：YYYY-MM-DDThh:mm:ssZ
EndTime String 是 結束時間，按照ISO8601標準表示，並需要使用UTC時間。格式為：YYYY-MM-DDThh:mm:ssZ

返回參數

名稱 類型 描述
ClientErrors MonitorItem 由 MonitorItem 組成的格式，返回API調用(客戶端原因)失敗監控信息。
所有返回給調用者的http狀態碼為4XX的調用都統計為客戶端原因的失敗調用。
ServerErrors MonitorItem 由 MonitorItem 組成的格式，返回API調用(服務端原因)失敗監控信息。
所有返回給調用者的http狀態碼為5XX的調用都統計為服務端原因的失敗調用。

示例

請求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApiErrorData
  2. &GroupId=63be9002440b4778a61122f14c2b2bbb
  3. &ApiId=d6f679aeb3be4b91b3688e887ca1fe16    
  4. &StartTime=2016-07-23T08:28:48Z
  5. &EndTime=2016-07-23T09:28:48Z
  6. &<公共請求參數>

返回示例

XML格式

  1. <DescribeApiErrorDataResponse>
  2.     <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ001</RequestId>
  3.     <ClientErrors>
  4.         <MonitorItem>
  5.             <ItemTime>2016-07-28T08:20:00Z</ItemTime>
  6.             <ItemValue>2</ItemValue>
  7.         </MonitorItem>
  8.         <MonitorItem>
  9.             <ItemTime>2016-07-28T08:22:00Z</ItemTime>
  10.             <ItemValue>5</ItemValue>
  11.         </MonitorItem>
  12.         <MonitorItem>
  13.             <ItemTime>2016-07-28T08:24:00Z</ItemTime>
  14.             <ItemValue>6</ItemValue>
  15.         </MonitorItem>
  16.     </ClientErrors>
  17.     <ServerErrors>
  18.         <MonitorItem>
  19.             <ItemTime>2016-07-28T08:20:00Z</ItemTime>
  20.             <ItemValue>0</ItemValue>
  21.         </MonitorItem>
  22.         <MonitorItem>
  23.             <ItemTime>2016-07-28T08:22:00Z</ItemTime>
  24.             <ItemValue>1</ItemValue>
  25.         </MonitorItem>
  26.         <MonitorItem>
  27.             <ItemTime>2016-07-28T08:24:00Z</ItemTime>
  28.             <ItemValue>1</ItemValue>
  29.         </MonitorItem>
  30.     </ServerErrors>
  31. </DescribeApiErrorDataResponse>

JSON格式

  1. {
  2.     "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ001",
  3.     "ClientErrors": {
  4.       "MonitorItem": [
  5.         {
  6.           "ItemTime": "2016-07-28T08:20:00Z",
  7.           "ItemValue": "2"
  8.         },
  9.         {
  10.           "ItemTime": "2016-07-28T08:22:00Z",
  11.           "ItemValue": "5"
  12.         },
  13.         {
  14.           "ItemTime": "2016-07-28T08:24:00Z",
  15.           "ItemValue": "6"
  16.         }
  17.       ]
  18.     },
  19.     "ServerErrors": {
  20.       "MonitorItem": [
  21.         {
  22.           "ItemTime": "2016-07-28T08:20:00Z",
  23.           "ItemValue": "0"
  24.         },
  25.         {
  26.           "ItemTime": "2016-07-28T08:22:00Z",
  27.           "ItemValue": "1"
  28.         },
  29.         {
  30.           "ItemTime": "2016-07-28T08:24:00Z",
  31.           "ItemValue": "1"
  32.         }
  33.       ]
  34.     }
  35.   }

最後更新：2016-11-23 17:16:09

  上一篇：go 查詢已發布API列表__API管理相關接口_API_API 網關-阿裏雲
  下一篇：go 查詢API響應時間數據__API管理相關接口_API_API 網關-阿裏雲