你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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 管理服务的名称。

正则表达式模式: ^[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
授权 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

计数器的 Key 值。 不得为空。

periodEndTime

string

计数器期的结束日期。 日期符合以下格式: yyyy-MM-ddTHH:mm:ssZ 由 ISO 8601 标准指定。

periodKey

string

收集计数器的时间段的标识符。 不得为空。

periodStartTime

string

计数器周期的开始日期。 日期符合以下格式: yyyy-MM-ddTHH:mm:ssZ 由 ISO 8601 标准指定。

value

QuotaCounterValueContractProperties

配额值属性

QuotaCounterValueContractProperties

配额计数器值详细信息。

名称 类型 说明
callsCount

integer

调用 Counter 的次数。

kbTransferred

number

以千字节为单位传输的数据。