Bagikan melalui

Referensi API penggunaan sumber daya penyewa

  • Artikel

Penyewa dapat menggunakan API penyewa untuk melihat data penggunaan sumber daya miliknya sendiri. API ini konsisten dengan API penggunaan Azure.

Anda dapat menggunakan cmdlet Get-UsageAggregates Windows PowerShell untuk mendapatkan data penggunaan, seperti di Azure.

Panggilan API

Minta

Permintaan mendapatkan detail konsumsi untuk langganan yang diminta dan untuk jangka waktu yang diminta. Tidak ada isi permintaan.

Metode URI Permintaan
GET https://{armendpoint}/subscriptions/{subId}/providers/Microsoft.Commerce/usageAggregates?reportedStartTime={reportedStartTime}&reportedEndTime={reportedEndTime}&agregasiGranularitas={granularity}&api-version=2015-06-01-preview&continuationToken={token-value}

Parameter

Parameter Deskripsi
Armendpoint Titik akhir Azure Resource Manager dari lingkungan Azure Stack Hub Anda. Konvensi Azure Stack Hub adalah nama titik akhir Azure Resource Manager dalam format https://management.{domain-name}. Misalnya, untuk kit pengembangan, jika nama domain adalah local.azurestack.external, maka titik akhir Resource Manager adalah https://management.local.azurestack.external.
subId ID langganan pengguna yang melakukan panggilan. Anda dapat menggunakan API ini hanya untuk membuat kueri penggunaan satu langganan. Penyedia dapat menggunakan API penggunaan sumber daya penyedia untuk membuat kueri penggunaan bagi semua penyewa.
reportedStartTime Waktu mulai kueri. Nilai untuk DateTime harus dalam UTC dan pada awal jam; misalnya, 13:00. Untuk agregasi harian, atur nilai ini ke UTC tengah malam. Format ini lolos dari ISO 8601; misalnya, 2015-06-16T18%3a53%3a11%2b00%3a00Z, di mana colon lolos ke %3a dan plus lolos ke %2b, sehingga format ini ramah URI.
reportedEndTime Waktu akhir kueri. Batasan yang berlaku untuk reportedStartTime juga berlaku untuk parameter ini. Nilai untuk reportedEndTime tidak boleh di masa mendatang.
aggregationGranularity Parameter opsional yang memiliki dua nilai potensial berbeda: harian dan per jam. Seperti yang disarankan oleh nilai, satu menampilkan data dalam granuralitas harian, dan yang lainnya adalah resolusi per jam. Opsi harian adalah opsi default.
versi-api Versi protokol yang digunakan untuk membuat permintaan ini. Anda harus menggunakan 2015-06-01-preview.
continuationToken Token diambil dari panggilan terakhir ke penyedia API penggunaan. Token ini diperlukan ketika respons lebih dari 1.000 baris. Token ini berfungsi sebagai bookmark kemajuan. Jika tidak ada, data diambil dari awal hari atau jam, berdasarkan granularitas yang masuk.

Respons

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"

}
},

...

Detail respons

Parameter Deskripsi
id ID unik dari agregat penggunaan.
nama Nama agregat penggunaan.
jenis Definisi sumber daya.
subscriptionId Pengidentifikasi langganan pengguna Azure Stack.
usageStartTime Waktu mulai UTC dari wadah penggunaan tempat agregat penggunaan ini berada.
usageEndTime Waktu berakhir UTC dari wadah penggunaan tempat agregat penggunaan ini berada.
instanceData Pasangan kunci-nilai detail instans (dalam format baru):
resourceUri: ID sumber daya yang memenuhi syarat, termasuk grup sumber daya dan nama instans.
location: Wilayan tempat layanan ini dijalankan.
tags: Tag sumber daya yang ditentukan pengguna.
additionalInfo: Detail selengkapnya tentang sumber daya yang dikonsumsi. Misalnya, versi OS atau jenis gambar.
quantity Jumlah konsumsi sumber daya yang terjadi dalam jangka waktu ini.
meterId ID unik untuk sumber daya yang dikonsumsi (juga disebut ResourceID).

Langkah berikutnya