查詢PolarDB集群的性能數據。
接口說明
-
若監控頻率為 5 秒/次：
- 當查詢時間范圍小于等于 1 小時，顯示粒度為 5 秒。
- 當查詢時間范圍小于等于 1 天，顯示粒度為 1 分鐘。
- 當查詢時間范圍小于等于 7 天，顯示粒度為 10 分鐘。
- 當查詢時間范圍小于等于 30 天，顯示粒度為 1 小時。
- 當查詢范圍大于 30 天，顯示粒度為 1 天。
-
若監控頻率為 60 秒/次：
- 當查詢范圍小于等于 1 天，顯示粒度為 1 分鐘。
- 當查詢范圍小于等于 7 天，顯示粒度為 10 分鐘。
- 當查詢范圍小于等于 30 天，顯示粒度為 1 小時。
- 當查詢范圍大于 30 天，顯示粒度為 1 天。
說明
監控頻率默認為 60 秒/次，您可以調用 ModifyDBClusterMonitor 接口將其設置為 5 秒/次。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| polardb:DescribeDBClusterPerformance | READ |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。 | pc-**************** |
| Key | string | 是 | 查詢的性能指標，多個值間用英文逗號（,）分隔，詳細參數請參見性能參數表。 說明
最多可傳入 5 個查詢的性能指標。
| PolarDBDiskUsage |
| StartTime | string | 是 | 查詢開始時間。格式為 | 2020-09-23T01:01Z |
| EndTime | string | 是 | 查詢結束時間。格式為 | 2020-09-23T01:00Z |
| Interval | string | 否 | 性能數據粒度。取值范圍如下：
| 60 |
返回參數
示例
正常返回示例
JSON格式
{
"PerformanceKeys": {
"PerformanceItem": [
{
"MetricName": "mean_data_size",
"Measurement": "PolarDBDiskUsage",
"Points": {
"PerformanceItemValue": [
{
"Value": "42.38",
"Timestamp": 1600822800000
}
]
},
"DBNodeId": "pi-*************"
}
]
},
"DBVersion": "8.0",
"EndTime": "2020-09-23T01:01:00Z",
"RequestId": "35D3E3DA-4650-407A-BFF5-59BFF1******",
"StartTime": "2020-09-23T01:00:00Z",
"DBClusterId": "pc-*****************",
"DBType": "MySQL"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidKey.Malformed | The specified parameter Key is not valid. | 指定的參數鍵無效 |
| 400 | InvalidEndTime.Malformed | The specified parameter EndTime is not valid. | 指定的參數EndTime無效 |
| 400 | InvalidStartTime.Malformed | The specified parameter StartTime is not valid. | 指定的參數StartTime無效 |
| 400 | InvalidParameterCombination | The end time must be greater than the start time. | 結束時間必須大于開始時間 |
| 400 | InvalidDateRange.Malformed | The Date Range can not more than one month. | 日期范圍不能超過一個月。 |
| 404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 當前的記錄中不存在提供的 DBClusterId。 |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的參數DBClusterId無效 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-02-29 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-09-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |