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

Quota By Counter Keys - Update

服务:

API Management

API 版本:

2024-05-01

将使用现有配额计数器键指定的所有配额计数器值更新为指定服务实例中的值。 这应用于重置配额计数器值。

PATCH 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 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	类型	说明
properties.callsCount	integer (int32)	调用 Counter 的次数。
properties.kbTransferred	number (double)	以千字节为单位传输的数据。

响应

名称	类型	说明
200 OK	QuotaCounterCollection	更新了配额计数器值。
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementUpdateQuotaCounterKey

示例请求

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba?api-version=2024-05-01

{
  "properties": {
    "callsCount": 0,
    "kbTransferred": 2.5630078125
  }
}

示例响应

状态代码:

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	配额计数器值详细信息。
QuotaCounterValueUpdateContract	配额计数器值详细信息。

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)	调用 Counter 的次数。
kbTransferred	number (double)	以千字节为单位传输的数据。

QuotaCounterValueUpdateContract

Object

配额计数器值详细信息。

名称	类型	说明
properties.callsCount	integer (int32)	调用 Counter 的次数。
properties.kbTransferred	number (double)	以千字节为单位传输的数据。