Quota By Counter Keys - List By Service

サービス:: API Management

API バージョン:: 2024-05-01

指定したサービスインスタンスのポリシーで構成されたカウンターキーに関連付けられている現在のクォータカウンター期間のコレクションを一覧表示します。 API はまだページングをサポートしていません。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
quotaCounterKey	path	True	string	クォータカウンターキー識別子。これは、キーごとのクォータポリシーのカウンターキー属性で定義された式の結果です。たとえば、ポリシーで counter-key="boo" を指定した場合、"boo" カウンターキーでアクセスできます。しかし、それが counter-key="@("b"+"a")" として定義されている場合は、"ba" キーでアクセスできます
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	QuotaCounterCollection	クォータカウンター値のコレクションを一覧表示します。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementGetQuotaCounterKeys

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "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": ""
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
QuotaCounterCollection	ページクォータカウンターの一覧の表現。
QuotaCounterContract	クォータカウンターの詳細。
QuotaCounterValueContractProperties	クォータカウンター値の詳細。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

QuotaCounterCollection

Object

ページクォータカウンターの一覧の表現。

名前	型	説明
count	integer (int64)	すべてのページの合計レコード数。
nextLink	string	次のページリンク (ある場合)。
value	QuotaCounterContract[]	クォータカウンターの値。

QuotaCounterContract

Object

クォータカウンターの詳細。

名前	型	説明
counterKey	string minLength: 1	カウンターのキー値。空にすることはできません。
periodEndTime	string (date-time)	カウンター期間の終了日。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
periodKey	string minLength: 1	カウンターが収集された期間の識別子。空にすることはできません。
periodStartTime	string (date-time)	カウンター期間の開始日。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
value	QuotaCounterValueContractProperties	クォータ値のプロパティ

QuotaCounterValueContractProperties

Object

クォータカウンター値の詳細。

名前	型	説明
callsCount	integer (int32)	カウンターが呼び出された回数。
kbTransferred	number (double)	キロバイト単位で転送されたデータ。