你当前正在访问 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=2023-05-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/usages?api-version=2023-05-01&$filter={$filter}

URI 参数

名称 必需 类型 说明
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 (指标的名称,可以具有 或 多个名称) 。

响应

名称 类型 说明
200 OK

UsageListResult

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

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。 如果资源不存在,将返回 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=2023-05-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

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

MetricName

指标名称。

名称 类型 说明
localizedValue

string

指标的友好名称。

value

string

指标的名称。

QuotaUsageStatus

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

名称 类型 说明
Blocked

string

InOverage

string

Included

string

Unknown

string

UnitType

指标的单位。

名称 类型 说明
Bytes

string

BytesPerSecond

string

Count

string

CountPerSecond

string

Milliseconds

string

Percent

string

Seconds

string

Usage

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

名称 类型 说明
currentValue

number

此指标的当前值。

limit

number

此指标的最大值。

name

MetricName

指标的名称信息。

nextResetTime

string

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

quotaPeriod

string

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

status

QuotaUsageStatus

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

unit

UnitType

指标的单位。

UsageListResult

对列表使用请求的响应。

名称 类型 说明
nextLink

string

用于获取“使用情况”下一页的链接。

value

Usage[]

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