Metrics - List
리소스에 대한 메트릭 값을 Lists.
GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metrics?api-version=2023-10-01
GET https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/metrics?timespan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&api-version=2023-10-01&metricnamespace={metricnamespace}&AutoAdjustTimegrain={AutoAdjustTimegrain}&ValidateDimensions={ValidateDimensions}&rollupby={rollupby}
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
리소스의 식별자입니다. |
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
$filter
|
query |
string |
$filter 반환된 메트릭 데이터 집합을 줄이는 데 사용됩니다. |
|
aggregation
|
query |
string |
검색할 집계 형식(쉼표로 구분됨) 목록입니다. 예: 평균, 최소, 최대 |
|
Auto
|
query |
boolean |
true로 설정하면 전달된 시간 범위가 이 메트릭에서 지원되지 않는 경우 API는 지원되는 가장 가까운 시간 범위를 사용하여 결과를 반환합니다. false로 설정하면 잘못된 시간 범위 매개 변수에 대한 오류가 반환됩니다. 기본값은 false입니다. |
|
interval
|
query |
string |
ISO 8601 기간 형식의 쿼리 간격(예: timegrain)입니다. 기본값은 PT1M입니다. 요청된 전체 시간 범위에 대해 단일 데이터 포인트를 반환하는 'FULL' 값에 대한 특수 사례입니다. 예: PT15M, PT1H, P1D, FULL |
|
metricnames
|
query |
string |
검색할 메트릭의 이름(쉼표로 구분됨)입니다. |
|
metricnamespace
|
query |
string |
원하는 메트릭이 있는 메트릭 네임스페이스입니다. |
|
orderby
|
query |
string |
정렬 결과 및 정렬 방향에 사용할 집계입니다. 하나의 주문만 지정할 수 있습니다. 예: sum asc |
|
result
|
query |
수집된 데이터 집합을 줄입니다. 허용되는 구문은 작업에 따라 달라집니다. 자세한 내용은 작업의 설명을 참조하세요. |
||
rollupby
|
query |
string |
결과를 롤업할 차원 이름입니다. 예를 들어 'City eq Seattle 또는 City eq Tacoma'와 같은 필터를 사용하여 메트릭 값만 표시하지만 각 도시에 대해 별도의 값을 표시하지 않으려는 경우 'RollUpBy=City'를 지정하여 시애틀 및 타코마에 대한 결과를 한 번 더 롤업할 수 있습니다. |
|
timespan
|
query |
string |
쿼리의 시간 범위입니다. 'startDateTime_ISO/endDateTime_ISO' 형식의 문자열입니다. |
|
top
|
query |
integer int32 |
요청의 리소스 ID당 검색할 최대 레코드 수입니다. 필터가 지정된 경우에만 유효합니다. 기본값은 10입니다. |
|
Validate
|
query |
boolean |
false로 설정하면 잘못된 필터 매개 변수 값이 무시됩니다. true로 설정하면 잘못된 필터 매개 변수에 대한 오류가 반환됩니다. 기본값은 true입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
메트릭 값 목록을 가져오는 데 성공한 요청입니다. |
|
Other Status Codes |
작업이 실패한 이유를 설명하는 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
Get Metric for data |
Get Metric for metadata |
Get Metric with error |
Get Metric for data
샘플 요청
GET https://management.azure.com/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2021-04-20T09:00:00.000Z/2021-04-20T14:00:00.000Z&interval=PT6H&metricnames=BlobCount,BlobCapacity&aggregation=average,minimum,maximum&top=5&orderby=average asc&$filter=Tier eq '*'&api-version=2023-10-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices&AutoAdjustTimegrain=True&ValidateDimensions=False
샘플 응답
{
"cost": 598,
"timespan": "2021-04-20T09:00:00Z/2021-04-20T14:00:00Z",
"interval": "PT1H",
"value": [
{
"id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "BlobCount",
"localizedValue": "Blob Count"
},
"displayDescription": "The number of blob objects stored in the storage account.",
"unit": "Count",
"timeseries": [
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Hot"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 7,
"minimum": 7,
"maximum": 7
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Standard"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 2,
"minimum": 2,
"maximum": 2
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Cool"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Archive"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Untiered"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
}
],
"errorCode": "Success"
},
{
"id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCapacity",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "BlobCapacity",
"localizedValue": "Blob Capacity"
},
"displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.",
"unit": "Bytes",
"timeseries": [
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Standard"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 621492,
"minimum": 621492,
"maximum": 621492
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Hot"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 4733,
"minimum": 4733,
"maximum": 4733
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Archive"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Untiered"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Cool"
}
],
"data": [
{
"timeStamp": "2021-04-20T09:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T10:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T11:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T12:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
},
{
"timeStamp": "2021-04-20T13:00:00Z",
"average": 0,
"minimum": 0,
"maximum": 0
}
]
}
],
"errorCode": "Success"
}
],
"namespace": "microsoft.storage/storageaccounts/blobservices",
"resourceregion": "westus2"
}
Get Metric for metadata
샘플 요청
GET https://management.azure.com/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics?timespan=2017-04-14T02:20:00Z/2017-04-14T04:20:00Z&$filter=Tier eq '*'&api-version=2023-10-01&metricnamespace=Microsoft.Storage/storageAccounts/blobServices
샘플 응답
{
"timespan": "2021-04-15T02:18:00Z/2021-04-22T02:18:00Z",
"interval": "PT1H",
"value": [
{
"id": "/subscriptions/1f3fa6d2-851c-4a91-9087-1a050f3a9c38/resourceGroups/todking/providers/Microsoft.Storage/storageAccounts/tkfileserv/blobServices/default/providers/Microsoft.Insights/metrics/BlobCount",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "BlobCount",
"localizedValue": "Blob Count"
},
"displayDescription": "The number of blob objects stored in the storage account.",
"unit": "Count",
"timeseries": [
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Cool"
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Archive"
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Standard"
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Untiered"
}
]
},
{
"metadatavalues": [
{
"name": {
"value": "tier",
"localizedValue": "tier"
},
"value": "Hot"
}
]
}
]
}
],
"namespace": "microsoft.storage/storageaccounts/blobservices",
"resourceregion": "westus2"
}
Get Metric with error
샘플 요청
GET https://management.azure.com/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics?timespan=2021-06-07T21:51:00Z/2021-06-08T01:51:00Z&interval=FULL&metricnames=MongoRequestsCount,MongoRequests&aggregation=average&api-version=2023-10-01&metricnamespace=microsoft.documentdb/databaseaccounts&AutoAdjustTimegrain=True&ValidateDimensions=False
샘플 응답
{
"cost": 239,
"timespan": "2021-06-07T21:51:00Z/2021-06-08T01:51:00Z",
"interval": "PT4H",
"value": [
{
"id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequestsCount",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "MongoRequestsCount",
"localizedValue": "(deprecated) Mongo Request Rate"
},
"unit": "CountPerSecond",
"timeseries": [],
"errorMessage": "Sampling type is not found. Metric:CosmosDBCustomer,AzureMonitor,MongoRequests, SamplingType:NullableAverage.",
"errorCode": "InvalidSamplingType"
},
{
"id": "/subscriptions/ac41e21f-afd6-4a79-8070-f01eba278f97/resourceGroups/todking/providers/Microsoft.DocumentDb/databaseAccounts/tk-cosmos-mongo/providers/Microsoft.Insights/metrics/MongoRequests",
"type": "Microsoft.Insights/metrics",
"name": {
"value": "MongoRequests",
"localizedValue": "Mongo Requests"
},
"displayDescription": "Number of Mongo Requests Made",
"unit": "Count",
"timeseries": [
{
"metadatavalues": [],
"data": [
{
"timeStamp": "2021-06-07T21:51:00Z",
"average": 0
}
]
}
],
"errorCode": "Success"
}
],
"namespace": "microsoft.documentdb/databaseaccounts",
"resourceregion": "westus2"
}
정의
Name | Description |
---|---|
Error |
리소스 관리 오류 추가 정보입니다. |
Error |
오류 응답 |
Localizable |
지역화 가능한 문자열 클래스입니다. |
Metadata |
메트릭 메타데이터 값을 나타냅니다. |
Metric |
쿼리의 결과 데이터입니다. |
Metric |
메트릭의 단위입니다. |
Metric |
메트릭 값을 나타냅니다. |
Response |
메트릭 쿼리에 대한 응답입니다. |
Result |
수집된 데이터 집합을 줄입니다. 허용되는 구문은 작업에 따라 달라집니다. 자세한 내용은 작업의 설명을 참조하세요. |
Time |
시계열 결과 형식입니다. 이 경우 판별자 값은 항상 TimeSeries입니다. |
ErrorAdditionalInfo
리소스 관리 오류 추가 정보입니다.
Name | 형식 | Description |
---|---|---|
info |
object |
추가 정보입니다. |
type |
string |
추가 정보 유형입니다. |
ErrorResponse
오류 응답
Name | 형식 | Description |
---|---|---|
additionalInfo |
오류 추가 정보입니다. |
|
code |
string |
오류 코드입니다. |
details |
오류 세부 정보입니다. |
|
message |
string |
오류 메시지입니다. |
target |
string |
오류 대상입니다. |
LocalizableString
지역화 가능한 문자열 클래스입니다.
Name | 형식 | Description |
---|---|---|
localizedValue |
string |
표시 이름입니다. |
value |
string |
고정 값입니다. |
MetadataValue
메트릭 메타데이터 값을 나타냅니다.
Name | 형식 | Description |
---|---|---|
name |
메타데이터의 이름입니다. |
|
value |
string |
메타데이터의 값입니다. |
Metric
쿼리의 결과 데이터입니다.
Name | 형식 | Description |
---|---|---|
displayDescription |
string |
이 메트릭에 대한 자세한 설명입니다. |
errorCode |
string |
'성공' 또는 이 메트릭에 대한 쿼리 실패에 대한 오류 세부 정보입니다. |
errorMessage |
string |
이 특정 메트릭을 쿼리하는 동안 오류 메시지가 발생했습니다. |
id |
string |
메트릭 ID입니다. |
name |
메트릭의 이름 및 표시 이름(예: 지역화 가능한 문자열)입니다. |
|
timeseries |
데이터 쿼리가 수행될 때 반환되는 시계열입니다. |
|
type |
string |
메트릭 리소스의 리소스 종류입니다. |
unit |
메트릭의 단위입니다. |
MetricUnit
메트릭의 단위입니다.
Name | 형식 | Description |
---|---|---|
BitsPerSecond |
string |
초당 이진 숫자의 속도 단위입니다. |
ByteSeconds |
string |
데이터 전송 또는 스토리지 단위입니다. 데이터를 전송하거나 저장하는 데 걸리는 시간(초)을 곱한 바이트 단위의 데이터 크기입니다. |
Bytes |
string |
메모리 단위(바이트)입니다. |
BytesPerSecond |
string |
메모리의 속도 단위(초당 바이트)입니다. |
Cores |
string |
처리 능력 단위입니다. |
Count |
string |
원시 수량 단위입니다. |
CountPerSecond |
string |
초당 원시 수량의 속도 단위입니다. |
MilliCores |
string |
CPU 코어 1/1000의 처리 능력 단위입니다. |
MilliSeconds |
string |
1/1000초의 시간 단위입니다. |
NanoCores |
string |
CPU 코어의 10억 분의 1에 대한 처리 능력 단위입니다. |
Percent |
string |
백분율 단위입니다. |
Seconds |
string |
시간 단위(초)입니다. |
Unspecified |
string |
지정된 단위가 없습니다. |
MetricValue
메트릭 값을 나타냅니다.
Name | 형식 | Description |
---|---|---|
average |
number |
시간 범위의 평균 값입니다. |
count |
number |
시간 범위의 샘플 수입니다. 평균 값에 기여한 값의 수를 결정하는 데 사용할 수 있습니다. |
maximum |
number |
시간 범위에서 가장 큰 값입니다. |
minimum |
number |
시간 범위의 최소 값입니다. |
timeStamp |
string |
ISO 8601 형식의 메트릭 값에 대한 타임스탬프입니다. |
total |
number |
시간 범위에 있는 모든 값의 합계입니다. |
Response
메트릭 쿼리에 대한 응답입니다.
Name | 형식 | Description |
---|---|---|
cost |
number |
쿼리의 상대 비용을 나타내는 정수 값입니다. |
interval |
string |
메트릭 데이터가 ISO 8601 기간 형식으로 반환된 간격(창 크기)이며 요청된 전체 시간 범위에 대해 단일 데이터 포인트를 반환하는 'FULL' 값에 대한 특수한 경우입니다(예: PT15M, PT1H, P1D, FULL). AutoAdjustTimegrain=true가 지정된 경우 이 값이 조정되고 원래 요청된 것과 다를 수 있습니다. 메타데이터 요청이 수행된 경우에는 이 값이 없습니다. |
namespace |
string |
쿼리되는 메트릭의 네임스페이스 |
resourceregion |
string |
메트릭에 대해 쿼리되는 리소스의 지역입니다. |
timespan |
string |
데이터가 검색된 시간 범위입니다. 해당 값은 '/'로 구분된 두 개의 날짜/시간으로 구성됩니다. 이는 나중에 조정되어 원래 요청된 내용에서 다시 반환될 수 있습니다. |
value |
Metric[] |
컬렉션의 값입니다. |
ResultType
수집된 데이터 집합을 줄입니다. 허용되는 구문은 작업에 따라 달라집니다. 자세한 내용은 작업의 설명을 참조하세요.
Name | 형식 | Description |
---|---|---|
Data |
string |
|
Metadata |
string |
TimeSeriesElement
시계열 결과 형식입니다. 이 경우 판별자 값은 항상 TimeSeries입니다.
Name | 형식 | Description |
---|---|---|
data |
메트릭 값을 나타내는 데이터 요소의 배열입니다. 이는 데이터 결과 형식이 지정된 경우에만 반환됩니다. |
|
metadatavalues |
호출에서 $filter 지정된 경우 반환되는 메타데이터 값입니다. |