Quota By Counter Keys - List By Service
列出與指定服務實例上原則中設定之計數器索引鍵相關聯的目前配額計數器期間集合。 API 尚不支持分頁。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}?api-version=2024-05-01
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
quota
|
path | True |
string |
配額計數器金鑰標識碼。這是在 quota-by-key 原則的計數器索引鍵屬性中定義的表達式結果。例如,如果您在原則中指定counter-key=“boo”,則會由 “boo” 計數器索引鍵存取。 但如果它定義為 counter-key=“@(”b“+”a“)”,則會由 “ba” 鍵存取 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
資源群組的名稱。 名稱不區分大小寫。 |
|
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
API 管理服務的名稱。 |
|
subscription
|
path | True |
string (uuid) |
目標訂用帳戶的標識碼。 此值必須是 UUID。 |
|
api-version
|
query | True |
string minLength: 1 |
要用於這項作業的 API 版本。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
列出配額計數器值的集合。 |
|
| Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 | Description |
|---|---|
| user_impersonation | 模擬您的用戶帳戶 |
範例
ApiManagementGetQuotaCounterKeys
範例要求
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba?api-version=2024-05-01
範例回覆
{
"value": [
{
"counterKey": "ba",
"periodKey": "0_P3Y6M4DT12H30M5S",
"periodStartTime": "2014-08-04T04:24:35Z",
"periodEndTime": "2018-02-08T16:54:40Z",
"value": {
"callsCount": 5,
"kbTransferred": 2.5830078125
}
}
],
"nextLink": ""
}
定義
| 名稱 | Description |
|---|---|
|
Error |
資源管理錯誤其他資訊。 |
|
Error |
錯誤詳細數據。 |
|
Error |
錯誤回應 |
|
Quota |
分頁配額計數器清單表示法。 |
|
Quota |
配額計數器詳細數據。 |
|
Quota |
配額計數器值詳細數據。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
object |
其他資訊。 |
| type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
錯誤其他資訊。 |
|
| code |
string |
錯誤碼。 |
| details |
錯誤詳細數據。 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
| 名稱 | 類型 | Description |
|---|---|---|
| error |
error 物件。 |
QuotaCounterCollection
分頁配額計數器清單表示法。
| 名稱 | 類型 | Description |
|---|---|---|
| count |
integer (int64) |
所有頁面的總記錄計數數目。 |
| nextLink |
string |
如果有的話,下一頁連結。 |
| value |
配額計數器值。 |
QuotaCounterContract
配額計數器詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| counterKey |
string minLength: 1 |
計數器的 Key 值。 不得為空白。 |
| periodEndTime |
string (date-time) |
計數器期間結束的日期。 日期符合下列格式: |
| periodKey |
string minLength: 1 |
收集計數器的期間識別碼。 不得為空白。 |
| periodStartTime |
string (date-time) |
計數器期間開始的日期。 日期符合下列格式: |
| value |
配額值屬性 |
QuotaCounterValueContractProperties
配額計數器值詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| callsCount |
integer (int32) |
呼叫 Counter 的次數。 |
| kbTransferred |
number (double) |
以 KB 為單位傳輸的數據。 |