Kiracı kaynak kullanımı API başvurusuTenant resource usage API reference

Kiracı, kiracının kendi kaynak kullanım verilerini görüntülemek için Kiracı API 'Lerini kullanabilir.A tenant can use the tenant APIs to view the tenant's own resource usage data. Bu API 'Ler Azure kullanım API 'Leri ile tutarlıdır.These APIs are consistent with the Azure usage APIs.

Azure 'da olduğu gibi kullanım verilerini almak için Windows PowerShell cmdlet Get-Usagetoplamaları ' nı kullanabilirsiniz.You can use the Windows PowerShell cmdlet Get-UsageAggregates to get usage data, just like in Azure.

API çağrısıAPI call

İstekRequest

İstek, istenen abonelikler ve istenen zaman dilimi için tüketim ayrıntılarını alır.The request gets consumption details for the requested subscriptions and for the requested time frame. İstek gövdesi yok.There is no request body.

YöntemMethod İstek URI'siRequest URI
GETGET https://{Ermenistan/{Ermenistan}/abonelikler/{Subıd}/sağlayıcılar/Microsoft. Commerce/Usagetoplamalar? reportedStartTime = {reportedStartTime} &reportedEndTime = {reportedEndTime} &Aggregationayrıntı düzeyi = {parçalı} &api-Version = 2015-06 -01-Preview&continuationToken = {Token-Value}https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&aggregationGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

ParametrelerParameters

ParametreParameter AçıklamaDescription
ArmendpointArmendpoint Azure Stack hub ortamınızın uç noktası Azure Resource Manager.Azure Resource Manager endpoint of your Azure Stack Hub environment. Azure Stack hub kuralı, Azure Resource Manager uç noktanın adının biçimde olması olur https://management.{domain-name} .The Azure Stack Hub convention is that the name of Azure Resource Manager endpoint is in the format https://management.{domain-name}. Örneğin, geliştirme seti için, etki alanı adı Local. azurestack. External, ardından Kaynak Yöneticisi uç noktası olur https://management.local.azurestack.external .For example, for the development kit, the domain name is local.azurestack.external, then the Resource Manager endpoint is https://management.local.azurestack.external.
SubıdsubId Çağrıyı yapan kullanıcının abonelik KIMLIĞI.Subscription ID of the user who is making the call. Bu API 'yi yalnızca tek bir aboneliğin kullanımını sorgulamak için kullanabilirsiniz.You can use this API only to query for a single subscription's usage. Sağlayıcılar, tüm kiracıların kullanımını sorgulamak için sağlayıcı kaynak kullanımı API 'sini kullanabilir.Providers can use the provider resource usage API to query usage for all tenants.
reportedStartTimereportedStartTime Sorgunun başlangıç saati.Start time of the query. DateTime değeri UTC biçiminde ve saatin başında olmalıdır; Örneğin, 13:00.The value for DateTime should be in UTC and at the beginning of the hour; for example, 13:00. Günlük toplama için bu değeri UTC gece yarısı olarak ayarlayın.For daily aggregation, set this value to UTC midnight. Biçim kaçışdır ISO 8601; Örneğin, 2015-06-16T18% 3A53% 3A11% 2b00% 3a00Z, burada iki nokta üst üste% 3A ve artı, URI 'si kolay olması için% 2B ' a atmalıdır.The format is escaped ISO 8601; for example, 2015-06-16T18%3a53%3a11%2b00%3a00Z, where colon is escaped to %3a and plus is escaped to %2b so that it's URI friendly.
reportedEndTimereportedEndTime Sorgunun bitiş saati.End time of the query. Reportedstarttime için uygulanan kısıtlamalar bu parametre için de geçerlidir.The constraints that apply to reportedStartTime also apply to this parameter. Reportedendtime değeri gelecekte olamaz.The value for reportedEndTime can't be in the future.
Aggregationayrıntı düzeyiaggregationGranularity İki ayrı olası değeri olan isteğe bağlı parametre: günlük ve saatlik.Optional parameter that has two discrete potential values: daily and hourly. Değerler önereceği için, biri günlük ayrıntı düzeyi halinde verileri döndürür ve diğeri saatlik bir çözünürlüğlük olur.As the values suggest, one returns the data in daily granularity, and the other is an hourly resolution. Günlük seçeneği varsayılandır.The daily option is the default.
api-sürümüapi-version Bu isteği yapmak için kullanılan protokolün sürümü.Version of the protocol that's used to make this request. 2015-06-01-Preview kullanmanız gerekir.You must use 2015-06-01-preview.
continuationTokencontinuationToken Son çağrıdan kullanım API sağlayıcısına alınan belirteç.Token retrieved from the last call to the usage API provider. Yanıt 1.000 satırdan fazla olduğunda bu belirteç gereklidir.This token is needed when a response is greater than 1,000 lines. İlerleme için bir yer işareti görevi görür.It acts as a bookmark for progress. Mevcut değilse, veriler, geçirilen ayrıntı düzeyine göre günün veya saatin başından itibaren alınır.If not present, the data is retrieved from the beginning of the day or hour, based on the granularity passed in.

YanıtResponse

GET
/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregates?reportedStartTime=reportedStartTime=2014-05-01T00%3a00%3a00%2b00%3a00&reportedEndTime=2015-06-01T00%3a00%3a00%2b00%3a00&aggregationGranularity=Daily&api-version=1.0
{
"value": [
{

"id":
"/subscriptions/sub1/providers/Microsoft.Commerce/UsageAggregate/sub1-meterID1",
"name": "sub1-meterID1",
"type": "Microsoft.Commerce/UsageAggregate",

"properties": {
"subscriptionId":"sub1",
"usageStartTime": "2015-03-03T00:00:00+00:00",
"usageEndTime": "2015-03-04T00:00:00+00:00",
"instanceData":"{\"Microsoft.Resources\":{\"resourceUri\":\"resourceUri1\",\"location\":\"Alaska\",\"tags\":null,\"additionalInfo\":null}}",
"quantity":2.4000000000,
"meterId":"meterID1"

}
},

...

Yanıt ayrıntılarıResponse details

ParametreParameter AçıklamaDescription
kimlikid Kullanım toplamanın benzersiz KIMLIĞI.Unique ID of the usage aggregate.
namename Kullanım toplamanın adı.Name of the usage aggregate.
türtype Kaynak tanımı.Resource definition.
subscriptionIdsubscriptionId Azure kullanıcısının abonelik tanımlayıcısı.Subscription identifier of the Azure user.
usageStartTimeusageStartTime Bu kullanım toplamasının ait olduğu kullanım demetini 'nin UTC başlangıç saati.UTC start time of the usage bucket to which this usage aggregate belongs.
UsagebitişsaatiusageEndTime Bu kullanım toplamasının ait olduğu kullanım demetini 'nin UTC bitiş saati.UTC end time of the usage bucket to which this usage aggregate belongs.
InstanceDatainstanceData Örnek ayrıntılarının anahtar-değer çiftleri (yeni bir biçimde):Key-value pairs of instance details (in a new format):
resourceUri: kaynak grupları ve örnek adı da dahil olmak üzere tam NITELIKLI kaynak kimliği.resourceUri: Fully qualified resource ID, including resource groups and instance name.
konum: Bu hizmetin çalıştırıldığı bölge.location: Region in which this service was run.
Etiketler: kullanıcının belirttiği kaynak etiketleri.tags: Resource tags that the user specifies.
AdditionalInfo: tüketilen kaynakla ilgili daha fazla ayrıntı.additionalInfo: More details about the resource that was consumed. Örneğin, işletim sistemi sürümü veya görüntü türü.For example, OS version or image type.
miktarquantity Bu zaman çerçevesinde gerçekleşen kaynak tüketimi miktarı.Amount of resource consumption that occurred in this time frame.
meterIdmeterId Tüketilen kaynak için benzersiz KIMLIK ( RESOURCEID olarak da bilinir).Unique ID for the resource that was consumed (also called ResourceID).

Sonraki adımlarNext steps