次の方法で共有


Quota By Period Keys - Get

サービス インスタンス内の特定の期間のポリシーのカウンター キーに関連付けられているクォータ カウンターの値を取得します。

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

URI パラメーター

名前 / 必須 説明
quotaCounterKey
path True

string

クォータ カウンター キー識別子。これは、キーごとのクォータ ポリシーのカウンター キー属性で定義された式の結果です。たとえば、ポリシーで counter-key="boo" を指定すると、"boo" カウンター キーでアクセスできます。 ただし、counter-key="@("b"+"a")" として定義されている場合は、"ba" キーでアクセスできます

quotaPeriodKey
path True

string

クォータ期間キー識別子。

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName
path True

string

API Management サービスの名前。

正規表現パターン: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する API バージョン。

応答

名前 説明
200 OK

QuotaCounterContract

応答本文には、指定した期間のクォータ カウンターの詳細が含まれています。

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

ApiManagementGetQuotaCounterKeysByQuotaPeriod

要求のサンプル

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba/periods/0_P3Y6M4DT12H30M5S?api-version=2022-08-01

応答のサンプル

{
  "counterKey": "ba",
  "periodKey": "0_P3Y6M4DT12H30M5S",
  "periodStartTime": "2014-08-04T04:24:35Z",
  "periodEndTime": "2018-02-08T16:54:40Z",
  "value": {
    "callsCount": 0,
    "kbTransferred": 2.5625
  }
}

定義

名前 説明
ErrorFieldContract

エラー フィールド コントラクト。

ErrorResponse

エラー応答。

QuotaCounterContract

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

QuotaCounterValueContractProperties

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

ErrorFieldContract

エラー フィールド コントラクト。

名前 説明
code

string

プロパティ レベルのエラー コード。

message

string

プロパティ レベルエラーの人間が判読できる表現。

target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。

error.message

string

人が判読できるエラーの表現。

QuotaCounterContract

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

名前 説明
counterKey

string

Counter の Key 値。 空にしないでください。

periodEndTime

string

カウンター期間の終了の日付。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。

periodKey

string

カウンターが収集された期間の識別子。 空にしないでください。

periodStartTime

string

カウンター期間の開始日。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。

value

QuotaCounterValueContractProperties

クォータ値のプロパティ

QuotaCounterValueContractProperties

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

名前 説明
callsCount

integer

Counter が呼び出された回数。

kbTransferred

number

キロバイト単位で転送されたデータ。