擷取Quota資源消耗資訊
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
odps:GetQuotaUsage |
get |
*Quota
|
無 | 無 |
請求文法
GET /api/v1/quotas/{nickname}/usage HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| nickname |
string |
是 |
一級 Quota 暱稱。 |
os_quota_p |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| tenantId |
string |
否 |
租戶 ID。可以通過登入 MaxCompute 控制台,在左側導覽列選擇租戶管理>租戶屬性查看。 |
478403690625249 |
| region |
string |
否 |
地區 ID。 |
cn-chengdu |
| from |
integer |
是 |
查詢開始時間點。該時間是指寫入日誌資料時指定的日誌時間。
|
1669081045 |
| to |
integer |
是 |
查詢結束時間點。該時間是指寫入日誌資料時指定的日誌時間。
|
1669360870 |
| subQuotaNickname |
string |
否 |
二級 Quota 暱稱。 |
ot_tunnel_quota |
| aggMethod |
string |
否 |
彙總演算法。當擷取計算 Quota 計算資源消耗資料時,為最佳化頁面體驗,每個指標至多支援展示 60 個點,因此當時間範圍大於 1h 時,圖表預設使用區間範圍內(所選時間範圍的分鐘數/60)的平均值彙總資料,您可以根據自身需求更改彙總演算法。 |
max |
| productId |
string |
否 |
Quota 類型。預設為 odps。
|
ODPS |
| plotTypes |
array |
否 |
圖表類型。 |
|
|
string |
否 |
圖表類型。 當 productId 為 ODPS 時支援參數:
當 productId 為 TUNNEL 時必須填寫參數,枚舉值:
|
cpu |
|
| yAxisTypes |
array |
否 |
資料指標欄位。 |
|
|
string |
否 |
資料指標欄位。 當 productId 為 ODPS 時無需填寫。 當 productId 為 TUNNEL 時支援填入 project 名稱,此時返回的結果是專案維度資訊。 |
your_project_name |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
請求返回參數。 |
||
| requestId |
string |
請求 ID。 |
0b87b7a416652014358483492eea0b |
| httpCode |
integer |
HTTP 狀態代碼。
|
200 |
| errorCode |
string |
錯誤碼。 |
OBJECT_NOT_EXIST |
| errorMsg |
string |
錯誤描述資訊。 |
This object does not exist. |
| data |
object |
請求返回結果。 |
|
| metrics |
object |
指標結果。 |
"timestamps": [1668046140000, 1668065220000], //毫秒 "project1#upload#request": [10, 20], "project1#download#request": [20, 30], "project1#upload#throughput": [50, 50], "project1#download#throughput": [60, 70], "pro2#errorNum": [5, 10] |
| plot |
array<object> |
圖表資訊。 |
|
|
object |
圖表資訊。 |
||
| title |
string |
圖表標題。 |
專案請求並發數 |
| type |
string |
圖表類型。 |
request |
| yAxis |
array |
資料指標欄位。 |
|
|
string |
資料指標欄位。 當 productId 為 ODPS 時: cpu 具體類型 memory 具體類型 當 productId 為 TUNNEL 且填入 project 名稱時: project#operation#type |
project1#download#request |
樣本
正常返回樣本
JSON格式
{
"requestId": "0b87b7a416652014358483492eea0b",
"httpCode": 200,
"errorCode": "OBJECT_NOT_EXIST",
"errorMsg": "This object does not exist.",
"data": {
"metrics": {
"test": "test",
"test2": 1
},
"plot": [
{
"title": "專案請求並發數",
"type": "request",
"yAxis": [
"project1#download#request"
]
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。