Metrics - List At Subscription Scope

Szolgáltatás:: Monitor

API-verzió:: 2023-10-01

Az előfizetésimetrikaadatait sorolja fel. Ez az API a alapértelmezett ARM-szabályozási korlátokat használta.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region={region}

Opcionális paraméterekkel:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region={region}&timespan={timespan}&interval={interval}&metricnames={metricnames}&aggregation={aggregation}&top={top}&orderby={orderby}&$filter={$filter}&resultType={resultType}&metricnamespace={metricnamespace}&AutoAdjustTimegrain={AutoAdjustTimegrain}&ValidateDimensions={ValidateDimensions}&rollupby={rollupby}

URI-paraméterek

Name	In	Kötelező	Típus	Description
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.
region	query	True	string	Az a régió, ahol a kívánt metrikák találhatók.
$filter	query		string	A $filter a visszaadott metrikaadatok halmazának csökkentésére szolgál. Példa: A metrika az A, B és C metaadatokat tartalmazza. - A C összes idősorát adja vissza, ahol A = a1 és B = b1 vagy b2 *$filter=A eq 'a1' és B eq 'b1' vagy B eq 'b2' és C eq '' - Érvénytelen változat: $filter=A eq 'a1' és B eq 'b1' és C eq '' vagy B = 'b2'* Ez érvénytelen, mert a logikai vagy operátor nem tud két különböző metaadatnevet elkülöníteni. - Adja vissza az összes idősort, ahol A = a1, B = b1 és C = c1: $filter=A eq 'a1' és B eq 'b1' és C eq 'c1' - Minden idősor visszaadása, ahol A = a1 *$filter=A eq 'a1' és B eq '' és C eq ''*.
aggregation	query		string	A lekérendő összesítési típusok listája (vesszővel elválasztva). Példák: átlag, minimum, maximális
AutoAdjustTimegrain	query		boolean	Ha igaz értékre van állítva, ha a metrika nem támogatja a megadott időbélyeget, az API a legközelebbi támogatott időbélyeg használatával adja vissza az eredményt. Ha hamis értékre van állítva, a rendszer hibát ad vissza az érvénytelen időbélyeg-paraméterek esetében. Alapértelmezés szerint hamis.
interval	query		string	A lekérdezés időköze (azaz időgrain) ISO 8601-es időtartamformátumban. Alapértelmezés szerint PT1M. A "FULL" érték speciális esete, amely egyetlen adatpontot ad vissza a kért teljes időtartamra vonatkozóan. Példák: PT15M, PT1H, P1D, FULL
metricnames	query		string	A lekérni kívánt metrikák neve (vesszővel elválasztva). 20 metrika korlátozása.
metricnamespace	query		string	Metrikanévtér, ahol a metrikák találhatók.
orderby	query		string	Az eredmények rendezéséhez használandó összesítés és a rendezés iránya. Csak egy rendelés adható meg. Példák: asc összegzése
resultType	query		MetricResultType	Csökkenti az összegyűjtött adatok készletét. Az engedélyezett szintaxis a művelettől függ. A részletekért tekintse meg a művelet leírását.
rollupby	query		string	Dimenziónév(ek) a találatok összesítéséhez. Ha például csak a "City eq Seattle vagy City eq Tacoma" szűrővel rendelkező metrikaértékeket szeretné látni, de nem szeretne külön értékeket látni az egyes városokhoz, megadhatja a "RollUpBy=City" értéket, hogy a Seattle és a Tacoma találatai egy időrendben jelenjenek meg.
timespan	query		string	A lekérdezés időideje. Ez egy "startDateTime_ISO/endDateTime_ISO" formátumú sztring.
top	query		integer (int32)	A kérelemben erőforrás-azonosítónként lekérhető rekordok maximális száma. Csak akkor érvényes, ha a szűrő meg van adva. Alapértelmezés szerint 10.
ValidateDimensions	query		boolean	Ha hamis értékre van állítva, a rendszer figyelmen kívül hagyja az érvénytelen szűrőparaméter-értékeket. Ha igaz értékre van állítva, a rendszer hibát ad vissza érvénytelen szűrőparaméterek esetén. Alapértelmezés szerint igaz.

Válaszok

Name	Típus	Description
200 OK	Response	Sikeres kérés a metrikaértékek listájának lekéréséhez.
Other Status Codes	ErrorContract	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get subscription level metric data

Get subscription level metric metadata

Get subscription level metric data

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region=westus2&timespan=2021-06-08T19:00:00Z/2021-06-12T01:00:00Z&interval=PT6H&metricnames=Data Disk Max Burst IOPS&aggregation=count&top=10&orderby=count desc&$filter=LUN eq '0' and Microsoft.ResourceId eq '*'&metricnamespace=microsoft.compute/virtualmachines&AutoAdjustTimegrain=True&ValidateDimensions=False

Mintaválasz

Állapotkód:: 200

{
  "cost": 4679,
  "timespan": "2021-06-08T19:00:00Z/2021-06-12T01:00:00Z",
  "interval": "PT6H",
  "value": [
    {
      "id": "subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics/Data Disk Max Burst IOPS",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "Data Disk Max Burst IOPS",
        "localizedValue": "Data Disk Max Burst IOPS"
      },
      "displayDescription": "Maximum IOPS Data Disk can achieve with bursting",
      "unit": "Count",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas1/providers/Microsoft.Compute/virtualMachines/sas1-dev"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 413
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas2/providers/Microsoft.Compute/virtualMachines/sas2-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 133
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas3/providers/Microsoft.Compute/virtualMachines/sas3-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 78
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas4/providers/Microsoft.Compute/virtualMachines/sas4-vm"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "microsoft.resourceid",
                "localizedValue": "microsoft.resourceid"
              },
              "value": "/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/resourceGroups/sas5/providers/Microsoft.Compute/virtualMachines/sas5-vm-asc"
            }
          ],
          "data": [
            {
              "timeStamp": "2021-06-08T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-09T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-10T19:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T01:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T07:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T13:00:00Z",
              "count": 72
            },
            {
              "timeStamp": "2021-06-11T19:00:00Z",
              "count": 72
            }
          ]
        }
      ],
      "errorCode": "Success"
    }
  ],
  "namespace": "microsoft.compute/virtualmachines",
  "resourceregion": "westus2"
}

Állapotkód:: default

{
  "error": {
    "code": "BadRequest",
    "message": "Missing required region params"
  }
}

Get subscription level metric metadata

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics?api-version=2023-10-01&region=westus2&timespan=2021-06-10T02:23:16.129Z/2021-06-12T02:23:16.129Z&metricnames=Data Disk Max Burst IOPS&$filter=LUN eq '0'&metricnamespace=microsoft.compute/virtualmachines

Mintaválasz

Állapotkód:: 200

{
  "timespan": "2021-06-10T02:23:16Z/2021-06-12T02:23:16Z",
  "interval": "PT1M",
  "value": [
    {
      "id": "subscriptions/92d2a2d8-b514-432d-8cc9-a5f9272630d5/providers/Microsoft.Insights/metrics/Data Disk Read Bytes/sec",
      "type": "Microsoft.Insights/metrics",
      "name": {
        "value": "Data Disk Read Bytes/sec",
        "localizedValue": "Data Disk Read Bytes/Sec"
      },
      "displayDescription": "Bytes/Sec read from a single disk during monitoring period",
      "unit": "BytesPerSecond",
      "timeseries": [
        {
          "metadatavalues": [
            {
              "name": {
                "value": "lun",
                "localizedValue": "lun"
              },
              "value": "0"
            }
          ]
        },
        {
          "metadatavalues": [
            {
              "name": {
                "value": "lun",
                "localizedValue": "lun"
              },
              "value": "1"
            }
          ]
        }
      ]
    }
  ],
  "namespace": "microsoft.compute/virtualmachines",
  "resourceregion": "westus2"
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorContract	Hibaválasz
ErrorResponse	Hibaválasz
LocalizableString	A honosítható sztringosztály.
MetadataValue	Egy metrika metaadat-értékét jelöli.
Metric	Egy lekérdezés eredményadatai.
MetricResultType	Csökkenti az összegyűjtött adatok készletét. Az engedélyezett szintaxis a művelettől függ. A részletekért tekintse meg a művelet leírását.
MetricUnit	A metrika mértékegysége.
MetricValue	Metrikaértéket jelöl.
Response	A metrikák lekérdezésére adott válasz.
TimeSeriesElement	Idősor eredménytípusa. Ebben az esetben a diszkriminatív érték mindig TimeSeries.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorContract

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorResponse	Hibaválasz A hibaobjektum.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

LocalizableString

Objektum

A honosítható sztringosztály.

Name	Típus	Description
localizedValue	string	A megjelenítendő név.
value	string	Az invariáns érték.

MetadataValue

Objektum

Egy metrika metaadat-értékét jelöli.

Name	Típus	Description
name	LocalizableString	A metaadatok neve.
value	string	A metaadatok értéke.

Metric

Objektum

Egy lekérdezés eredményadatai.

Name	Típus	Description
displayDescription	string	A metrika részletes leírása.
errorCode	string	"Siker" vagy a metrika lekérdezési hibáinak hibaadatai.
errorMessage	string	Hibaüzenet jelenik meg az adott metrika lekérdezése közben.
id	string	A metrika azonosítója.
name	LocalizableString	A metrika neve és megjelenítendő neve, azaz honosítható sztring.
timeseries	TimeSeriesElement[]	Az adat lekérdezés végrehajtásakor visszaadott idősor.
type	string	A metrikaerőforrás erőforrástípusa.
unit	MetricUnit	A metrika mértékegysége.

MetricResultType

Enumerálás

Csökkenti az összegyűjtött adatok készletét. Az engedélyezett szintaxis a művelettől függ. A részletekért tekintse meg a művelet leírását.

Érték	Description
Data
Metadata

MetricUnit

Enumerálás

A metrika mértékegysége.

Érték	Description
Count	A nyers mennyiség mértékegysége.
Bytes	Memóriaegység bájtban.
Seconds	Időegység másodpercben.
CountPerSecond	A másodpercenkénti nyers mennyiség kamatlábegysége.
BytesPerSecond	Memóriaegységek másodpercenkénti bájtban való aránya.
Percent	Százalékegység.
MilliSeconds	Időegység egy másodperc 1/1000-ében.
ByteSeconds	Az adatátvitel vagy a tárolás egysége. Ez a bájtban megadott adatok mérete és az adatok átviteléhez vagy tárolásához szükséges idő másodpercben megszorozva.
Unspecified	Nincs megadott egység.
Cores	A feldolgozási teljesítmény mértékegysége.
MilliCores	A processzormag 1/1000-ed részének feldolgozási teljesítménye.
NanoCores	A processzormag egymilliárd része feldolgozási teljesítményegysége.
BitsPerSecond	Bináris számjegyek sebességegysége másodpercenként.

MetricValue

Objektum

Metrikaértéket jelöl.

Name	Típus	Description
average	number (double)	Az időtartomány átlagos értéke.
count	number (double)	Az időtartományban lévő minták száma. Az átlagértékhez hozzájárult értékek számának meghatározására használható.
maximum	number (double)	Az időtartomány legnagyobb értéke.
minimum	number (double)	Az időtartomány legkisebb értéke.
timeStamp	string (date-time)	A metrikaérték időbélyege ISO 8601 formátumban.
total	number (double)	Az időtartomány összes értékének összege.

Response

Objektum

A metrikák lekérdezésére adott válasz.

Name	Típus	Description
cost	number (int32) minimum: 0	A lekérdezés relatív költségét jelölő egész szám.
interval	string	Az az intervallum (ablakméret), amelyre vonatkozóan a metrikaadatokat ISO 8601-es időtartamformátumban adták vissza egy speciális esettel a "FULL" értékhez, amely egyetlen adatpontot ad vissza a kért teljes időtartamra (Példák: PT15M, PT1H, P1D, FULL). Ez módosítható, és eltérhet az eredetileg kérttől, ha az AutoAdjustTimegrain=true érték van megadva. Ez nem jelenik meg metaadat-kérés esetén.
namespace	string	A lekérdezett metrikák névtere
resourceregion	string	A lekérdezett erőforrás régiója a metrikákhoz.
timespan	string	Az az időkeret, amelyre az adatokat lekérte. Értéke két összefűzött dátum/időből áll, "/" elválasztva. Ez a jövőben módosítható, és visszatérhet az eredetileg kérttől.
value	Metric[]	A gyűjtemény értéke.

TimeSeriesElement

Objektum

Idősor eredménytípusa. Ebben az esetben a diszkriminatív érték mindig TimeSeries.

Name	Típus	Description
data	MetricValue[]	A metrikaértékeket képviselő adatpontok tömbje. Ez csak akkor lesz visszaadva, ha az eredmény típusú adatok meg van adva.
metadatavalues	MetadataValue[]	A visszaadott metaadat-értékek, ha $filter meg lett adva a hívásban.

Megosztás:

Metrics - List At Subscription Scope

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Get subscription level metric data

Mintakérelem

Mintaválasz

Get subscription level metric metadata

Mintakérelem

Mintaválasz

Definíciók

ErrorAdditionalInfo

ErrorContract

ErrorResponse

LocalizableString

MetadataValue

Metric

MetricResultType

MetricUnit

MetricValue

Response

TimeSeriesElement