Kiracı kaynak kullanımı API başvurusu

Makale
06/19/2024

Kiracı, kiracının kendi kaynak kullanım verilerini görüntülemek için kiracı API'lerini kullanabilir. Bu API'ler Azure kullanım API'leriyle tutarlıdır.

Azure'da olduğu gibi kullanım verilerini almak için Get-UsageAggregates Windows PowerShell cmdlet'ini kullanabilirsiniz.

API çağrısı

İstek

İstek, istenen abonelikler ve istenen zaman çerçevesi için tüketim ayrıntılarını alır. İstek gövdesi yok.

Yöntem	İstek URI'si
GET	https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&toplamaGranularity={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Parametreler

Parametre	Açıklama
Armendpoint	Azure Stack Hub ortamınızın Azure Resource Manager uç noktası. Azure Stack Hub kuralı, Azure Resource Manager uç noktasının adının biçiminde `https://management.{domain-name}`olmasıdır. Örneğin geliştirme seti için etki alanı adı local.azurestack.external, Resource Manager uç noktası ise olur`https://management.local.azurestack.external`.
subId	Aramayı yapan kullanıcının abonelik kimliği. Bu API'yi yalnızca tek bir aboneliğin kullanımını sorgulamak için kullanabilirsiniz. Sağlayıcılar, tüm kiracıların kullanımını sorgulamak için sağlayıcı kaynak kullanımı API'sini kullanabilir.
reportedStartTime	Sorgunun başlangıç saati. DateTime değeri UTC ve saatin başında olmalıdır; örneğin, 13:00. Günlük toplama için bu değeri UTC gece yarısı olarak ayarlayın. Biçimi ISO 8601 kaçış; örneğin, 2015-06-16T18%3a53%3a11%2b00%3a00Z; burada iki nokta üst üste %3a'ya, artı ise URI kullanımına uygun olması için %2b'ye kaçılır.
reportedEndTime	Sorgunun bitiş saati. ReportedStartTime için geçerli olan kısıtlamalar bu parametre için de geçerlidir. ReportedEndTime değeri gelecekte olamaz.
aggregationGranularity	İki ayrı olası değere sahip isteğe bağlı parametre: günlük ve saatlik. Değerlerden de anlaşılacağı gibi, biri verileri günlük ayrıntı düzeyinde, diğeri ise saatlik çözünürlükte döndürür. Günlük seçeneği varsayılan seçenektir.
api-sürümü	Bu isteği yapmak için kullanılan protokolün sürümü. 2015-06-01-preview kullanmalısınız.
continuationToken	Kullanım API'sinin sağlayıcısına yapılan son çağrıdan alınan belirteç. Bu belirteç, bir yanıt 1.000 satırdan büyük olduğunda gereklidir. İlerleme için bir yer işareti işlevi görür. Yoksa, veriler geçirilen ayrıntı düzeyine bağlı olarak günün veya saatin başından alınır.

Yanıt

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ı

Parametre	Açıklama
kimlik	Kullanım toplamının benzersiz kimliği.
name	Kullanım toplamının adı.
tür	Kaynak tanımı.
subscriptionId	Azure kullanıcısının abonelik tanımlayıcısı.
usageStartTime	Bu kullanım toplamasının ait olduğu kullanım demetinin UTC başlangıç saati.
usageEndTime	Bu kullanım toplamasının ait olduğu kullanım demetinin UTC bitiş saati.
ınstancedata	Örnek ayrıntılarının anahtar-değer çiftleri (yeni bir biçimde): resourceUri: Kaynak grupları ve örnek adı dahil olmak üzere tam kaynak kimliği. location: Bu hizmetin çalıştırıldığı bölge. etiketler: Kullanıcının belirttiği kaynak etiketleri. additionalInfo: Kullanılan kaynak hakkında daha fazla ayrıntı. Örneğin, işletim sistemi sürümü veya görüntü türü.
miktar	Bu zaman diliminde gerçekleşen kaynak tüketimi miktarı.
meterId	Kullanılan kaynağın benzersiz kimliği ( ResourceID olarak da adlandırılır).

Aracılığıyla paylaş