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

Accounts - List Usages

获取请求的认知服务帐户的使用情况

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages?api-version=2021-10-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages?api-version=2021-10-01&$filter={$filter}

URI 参数

Name In Required Type Description
accountName
path True
  • string

认知服务帐户的名称。

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

$filter
query
  • string

描述要返回的使用情况子集的 OData 筛选器表达式。 支持的参数为 name.value (指标的名称,可以具有多个名称) 。

响应

Name Type Description
200 OK

已成功检索认知服务帐户的用法。

Other Status Codes

描述操作失败的原因的错误响应。 如果资源不存在,将返回 404 (NotFound) 。

示例

Get Usages

Sample Request

GET https://management.azure.com/subscriptions/5a4f5c2e-6983-4ccb-bd34-2196d5b5bbd3/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/TestUsage02/usages?api-version=2021-10-01

Sample Response

{
  "value": [
    {
      "name": {
        "value": "Face.Transactions",
        "localizedValue": "Face.Transactions"
      },
      "status": "Included",
      "currentValue": 3,
      "limit": 30000,
      "nextResetTime": "2018-03-28T09:33:51Z",
      "quotaPeriod": "30.00:00:00",
      "unit": "Count"
    }
  ]
}

定义

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

MetricName

指标名称。

QuotaUsageStatus

认知服务帐户配额使用情况状态。

UnitType

指标的单位。

Usage

使用情况请求的使用情况数据。

UsageListResult

对列表使用情况请求的响应。

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

MetricName

指标名称。

Name Type Description
localizedValue
  • string

指标的友好名称。

value
  • string

指标的名称。

QuotaUsageStatus

认知服务帐户配额使用情况状态。

Name Type Description
Blocked
  • string
InOverage
  • string
Included
  • string
Unknown
  • string

UnitType

指标的单位。

Name Type Description
Bytes
  • string
BytesPerSecond
  • string
Count
  • string
CountPerSecond
  • string
Milliseconds
  • string
Percent
  • string
Seconds
  • string

Usage

使用情况请求的使用情况数据。

Name Type Description
currentValue
  • number

此指标的当前值。

limit
  • number

此指标的最大值。

name

指标的名称信息。

nextResetTime
  • string

当前配额的下一次重置时间。

quotaPeriod
  • string

用于汇总使用情况值的配额期。

status

认知服务帐户配额使用情况状态。

unit

指标的单位。

UsageListResult

对列表使用情况请求的响应。

Name Type Description
value

认知服务帐户的用法列表。