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

Quota By Counter Keys - Update

汇报使用现有配额计数器键指定的所有配额计数器值到指定服务实例中的值。 这应该用于重置配额计数器值。

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

URI 参数

名称 必需 类型 说明
quotaCounterKey
path True

string

配额计数器密钥标识符。这是在配额按键策略的计数器键属性中定义的表达式的结果。例如,如果在策略中指定 counter-key=“boo”,则可以通过“boo”计数器键访问它。 但如果将其定义为 counter-key=“@ (”b“+”a“) ”,则可以通过“ba”键访问它

resourceGroupName
path True

string

资源组的名称。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。

请求正文

名称 类型 说明
properties.callsCount

integer

计数器被调用的次数。

properties.kbTransferred

number

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

响应

名称 类型 说明
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

示例请求

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/quotas/ba?api-version=2021-08-01

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

示例响应

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

定义

名称 说明
ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

QuotaCounterCollection

分页配额计数器列表表示形式。

QuotaCounterContract

配额计数器详细信息。

QuotaCounterValueContractProperties

配额计数器值详细信息。

QuotaCounterValueUpdateContract

配额计数器值详细信息。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误的情况下,在请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。

QuotaCounterCollection

分页配额计数器列表表示形式。

名称 类型 说明
count

integer

所有页面的总记录计数数。

nextLink

string

下一页链接(如果有)。

value

QuotaCounterContract[]

配额计数器值。

QuotaCounterContract

配额计数器详细信息。

名称 类型 说明
counterKey

string

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

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

计数器被调用的次数。

kbTransferred

number

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

QuotaCounterValueUpdateContract

配额计数器值详细信息。

名称 类型 说明
properties.callsCount

integer

计数器被调用的次数。

properties.kbTransferred

number

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