API Gateway：API警示設定

1. 關聯資源

API Gateway監控警示功能可以滿足您多樣化的業務需求，監控警示的指標包括：

• HttpStatusCode

• API回應時間

• API總體請求次數

• 流入流量

• 流出流量

建立警示規則關聯資源時，有三種方式，如下：

• 手動關聯同一Region下的一個API或者多個API。此方式適合對同Region下某一個或多個API設定相同的警示規則。API配置修改後，警示規則不受影響；

• 關聯API分組，也就是對一個API分組下的所有API設定相同的警示規則，監控這些API的調用情況。API分組下若需要對API進行增刪改操作，會自動同步警示規則，無需額外修改；

• 關聯全部資源，指帳號下的API Gateway產品中的所有API都作為關聯資源，適用於需要管理的API很少的情境下。

2. 警示層級和方式

CloudMonitor警示可設定多級警示，閾值處於不同區間時，對應Critical 、Warning、Info三個不同層級，不同層級通過不同渠道發送警示通知。警示通知等詳細配置可以參考概覽

• Critical：電話語音+手機簡訊+郵件+DingTalk機器人（需付費使用）

• Warning：手機簡訊+郵件+DingTalk機器人

• Info：郵件+DingTalk機器人

3. 設定一個或多個API的警示規則

配置過程中涉及的警示模板，警示規則，通知連絡人，警示通知等詳細配置可以參考概覽

1、登入API Gateway控制台，選擇地區，在左側導覽列選擇API管理>API列表中找到想設定警示規則的API。

2. 在API列表，單擊API名稱，進入API詳情頁，在左側菜單選擇監控資訊，之後單擊頁面右上方中的警示按鈕，即進入到CloudMonitor配置控制台。

3、在警示規則頁面，單擊建立警示規則，在建立警示規則頁選擇產品API Gateway，資源範圍選擇執行個體，點擊下方的添加執行個體，在添加執行個體彈出框中選擇對應的API添加。

4.設定API分組的警示規則

1、如果需要對該API分組下的所有API應用相同的警示規則，進入API分組詳情頁，點擊詳情頁右上方的開啟CloudMonitor。

2、在第一次配置API分組CloudMonitor時，會有彈出框提示使用者建立API Gateway - 監控服務關聯角色。

3、點擊確定後，會提示CloudMonitor開啟成功，提示資訊中會附有CloudMonitor的應用分組名稱。CloudMonitor的這個應用分組是由API Gateway經使用者授權後建立的，並且與當前的API分組對應，命名格式固定為：APIGATEWAY_${region}_${groupId}，region的值是API分組所在的region，groupId是API分組的分組ID。

4、成功開通CloudMonitor後，通過API分組詳情頁右上方的點擊跳轉至CloudMonitor配置，即可直接配置應用到當前應用分組的警示規則。

5. 設定全部資源的警示規則

步驟與第3章相同，資源範圍選取“全部資源”即可。設定完成後帳號下API Gateway上的所有Region所有API都將使用同一警示規則，不能選擇API，適用於需要管理的API很少的情境。

6. API Gateway支援的警示規則

API Gateway提供了HttpStatusCode，API回應時間，API總體請求次數，流入流量，流出流量五個指標的規則；您可以就這幾個方面，配置您的警示。

• API回應時間：API Gateway的後端回應時間。

• API總體請求次數：某一周期內API Gateway收到用戶端的請求總次數。

• 流入流量：某一周期內API Gateway收到的用戶端請求產生的流量。

• 流出流量：某一周期內API Gateway向後端服務發出請求產生的流量。

• HttpStatusCode：API Gateway返回狀態代碼，有Code2XX，Code4XX，Code5XX可選。

-Code2XX：表示API請求成功。（注意：此處並非一定是業務成功）

-Code4XX：表示用戶端錯誤，可能是參數錯誤等。

-Code5XX：表示服務端錯誤，這個對於API開放者來說，一般需要重點監控。

6. 注意事項

• 可以根據API發布環境進行警示，如果VPC網路的使用者根據環境配置警示無效，建議先開啟API Gateway控制台，進入API詳情頁，在監控頁面查看該API是否支援根據環境查詢監控資料，如果不支援，請提交工單，我們將升級您的API Gateway版本。