API Reporting untuk pelanggan Enterprise - Detail Penggunaan
Catatan
Pada 1 Mei 2024, AZURE Enterprise Reporting API akan dihentikan. Api Pelaporan Perusahaan yang tersisa akan berhenti merespons permintaan. Pelanggan perlu beralih menggunakan API Microsoft Cost Management sebelum itu. Untuk mempelajari lebih lanjut, lihat Migrasi dari Pelaporan Azure Enterprise ke gambaran umum API Manajemen Biaya Microsoft.
API ini hanya mendukung rekaman penggunaan dengan hingga 400 karakter tag untuk sumber daya tertentu. API mungkin gagal jika Anda memiliki catatan melebihi jumlah maksimum tag. Jika Anda mengalami masalah ini, migrasi ke Ekspor atau API Ekspor.
API Detail Penggunaan menawarkan detail harian jumlah penggunaan dan perkiraan biaya oleh Pendaftaran. Hasilnya juga mencakup informasi tentang instans, meter, dan departemen. API dapat dikueri menurut periode Penagihan atau menurut tanggal mulai dan selesai tertentu.
Properti header umum yang perlu ditambahkan akan ditentukan dalam artikel Gambaran Umum API Pelaporan untuk pelanggan Enterprise. Rentang waktu kustom dapat ditentukan dengan parameter tanggal mulai dan berakhir yang dalam format yyyy-MM-dd.
CSV Format
API yang tercantum di bawah ini menyediakan data dalam format CSV.
Panggilan sinkron (non-polling)
Kami mengembalikan data dalam format CSV sebagai respons panggilan REST API. Performa API tergantung pada jumlah data penggunaan yang dikembalikan oleh panggilan Anda dan dapat memakan waktu maksimal 60 menit. Meskipun API mendukung rentang tanggal kustom, kami sarankan Anda membatasinya berdasarkan volume data penggunaan yang Anda miliki untuk periode tersebut. Kami mengizinkan dukungan maksimum satu bulan.
| Metode | Unduh URI Permintaan |
|---|---|
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/download?billingPeriod={billingPeriod} |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/download?startTime=2017-01-01& endTime=2017-01-10 |
Panggilan asinkron (berbasis polling)
Panggilan adalah proses dua langkah yang mengharuskan Anda mengirimkan permintaan terlebih dahulu untuk rentang waktu tertentu lalu polling untuk mendapatkan URL berbasis kunci akses bersama untuk lokasi Azure Blob yang memiliki data CSV. Rentang waktu maksimum yang didukung di sini adalah 36 bulan. Kami merekomendasikan API ini untuk himpunan data yang lebih besar.
| Metode | Kirim Permintaan URI |
|---|---|
| POST | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/submit?billingPeriod={billingPeriod} |
| POST | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails/submit?startTime=2017-04-01& endTime=2017-04-10 |
Respons panggilan kirim Asinkron (polling)
{
"id": "string",
"enrollmentNumber":"string",
"requestedOn":"2017-08-29T06:56:29.1290704Z",
"status":1,
"blobPath":"",
"reportUrl":"string",
"startDate":"2017-06-01T00:00:00",
"endDate":"2017-06-30T00:00:00"
}
Definisi properti Respons panggilan asinkron
| Nama Properti | Jenis | Deskripsi |
|---|---|---|
| id | string | ID unik untuk permintaan tersebut. |
| enrollmentNumber | string | Nomor Pendaftaran tempat permintaan dibuat. |
| requestedOn | string | Waktu tanggal permintaan dibuat. |
| status | int | Menunjukkan status permintaan. Antrean = 1, InProgress = 2, Selesai = 3, Gagal = 4, NoDataFound = 5, ReadyToDownload=6, TimedOut = 7. |
| blobPath | string | URL kunci akses bersama ke blob csv. |
| reportUrl | string | URL yang dapat digunakan untuk polling status permintaan kirim. |
| startDate | string | Sesuai dengan awal rentang waktu yang digunakan saat melakukan panggilan kirim. |
| endDate | string | Sesuai dengan akhir rentang waktu yang digunakan saat melakukan panggilan kirim. |
reportUrl adalah URL yang dapat digunakan untuk panggilan polling lebih lanjut (operasi GET). Ketika bidang status dalam respons permintaan polling kembali sebagai 3, permintaan selesai. Kami memiliki bidang blobPath dalam respons yang diisi dengan URL yang menunjuk ke data csv. Blob tersedia selama 1 hari sejak tanggal waktu di bidang respons requestedOn. Status 4, 5, dan 7 adalah status kegagalan di mana panggilan API telah mencapai kondisi kesalahan. Untuk semua status lainnya, panggilan polling harus diulang.
JSON Format
API yang tercantum di bawah ini menyediakan data dalam format JSON. Jika periode penagihan tidak ditentukan, maka data untuk periode penagihan saat ini dikembalikan. Rentang waktu maksimum yang didukung adalah 36 bulan.
| Metode | URI Permintaan |
|---|---|
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetails |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/billingPeriods/{billingPeriod}/usagedetails |
| GET | https://consumption.azure.com/v3/enrollments/{enrollmentNumber}/usagedetailsbycustomdate?startTime=2017-01-01& endTime=2017-01-10 |
Catatan
Untuk menggunakan versi API sebelumnya, ganti v3 dengan v2 di URL di atas. Beberapa bidang tidak tersedia jika Anda menggunakan v2.
Respons
Karena volume data yang berpotensi besar, kumpulan hasil di-paged. Properti nextLink, jika ada, menentukan tautan untuk halaman data berikutnya. Jika tautan kosong, tautan menunjukkan bahwa itu adalah halaman terakhir.
{
"id": "string",
"data": [
{
"serviceName":"Storage",
"serviceTier":"Premium Page Blobs",
"location":"US West",
"chargesBilledSeparately":false,
"partNumber":"ABC-12345",
"resourceGuid":"00000000-0000-0000-0000-000000000000",
"offerId":"MS-AZR-0003P",
"cost":1,
"accountId":123456,
"productId":1234,
"resourceLocationId":12,
"consumedServiceId":1,
"departmentId":3456,
"accountOwnerEmail":"account@live.com",
"accountName":"Account Name",
"serviceAdministratorId":"123",
"subscriptionId":0000000,
"subscriptionGuid":"00000000-0000-0000-0000-000000000000",
"subscriptionName":"Subscription Name",
"date":"2018-08-01T00:00:00",
"product":"Locally Redundant Storage Premium Storage - Page Blob/P10 - US West",
"meterId":"00000000-0000-0000-0000-000000000000",
"meterCategory":"Storage",
"meterSubCategory":"Locally Redundant",
"meterRegion":"California",
"meterName":"Premium Storage - Page Blob/P10 (Units)",
"consumedQuantity"1,
"resourceRate":1,
"resourceLocation":"uswest",
"consumedService":"Microsoft.Compute",
"instanceId":"Id",
"serviceInfo1":"string",
"serviceInfo2":"string",
"additionalInfo":"string",
"tags":"string",
"storeServiceIdentifier":"string",
"departmentName":"Department Name",
"costCenter":"1234",
"unitOfMeasure":"Units",
"resourceGroup":"ResourceGroup"
}
],
"nextLink": "string"
}
Definisi bidang detail penggunaan
| Nama Properti | Jenis | Deskripsi |
|---|---|---|
| id | string | Id unik untuk panggilan API. |
| data | Array JSON | Array detail penggunaan harian untuk setiap instance\meter. |
| nextLink | string | Ketika ada lebih banyak halaman data, nextLink menunjuk ke URL untuk mengembalikan halaman data berikutnya. |
| accountId | int | Bidang usang. Ada untuk kompatibilitas mundur. |
| productId | int | Bidang usang. Ada untuk kompatibilitas mundur. |
| resourceLocationId | int | Bidang usang. Ada untuk kompatibilitas mundur. |
| consumedServiceId | int | Bidang usang. Ada untuk kompatibilitas mundur. |
| departmentId | int | Bidang usang. Ada untuk kompatibilitas mundur. |
| accountOwnerEmail | string | Email akun pemilik akun. |
| accountName | string | Pelanggan memasukkan nama akun. |
| serviceAdministratorId | string | Email Alamat Administrator Layanan. |
| subscriptionId | int | Bidang usang. Ada untuk kompatibilitas mundur. |
| subscriptionGuid | string | Pengidentifikasi Unik Global untuk langganan. |
| subscriptionName | string | Nama langganan. |
| tanggal | string | Tanggal terjadinya konsumsi. |
| produk | string | Detail tambahan pada meteran. |
| meterId | string | Pengidentifikasi untuk meteran yang memancarkan penggunaan. |
| meterCategory | string | Layanan platform Azure yang digunakan. |
| meterSubCategory | string | Menentukan jenis layanan Azure yang dapat memengaruhi tarif. |
| meterRegion | string | Mengidentifikasi lokasi pusat data untuk layanan tertentu yang diberi harga berdasarkan lokasi pusat data. |
| meterName | string | Nama meterannya. |
| consumedQuantity | double | Jumlah meteran yang telah dikonsumsi. |
| resourceRate | double | Tarif yang berlaku per unit yang dapat ditagih. |
| cost | double | Biaya yang telah dikeluarkan untuk meteran. |
| resourceLocation | string | Mengidentifikasi pusat data tempat meteran berjalan. |
| consumedService | string | Layanan platform Azure yang digunakan. |
| instansId | string | Pengidentifikasi ini adalah nama sumber daya atau ID Sumber Daya yang sepenuhnya memenuhi syarat. Untuk informasi selengkapnya, lihat Azure Resource Manager API |
| serviceInfo1 | string | Metadata Layanan Azure Internal. |
| serviceInfo2 | string | Misalnya, jenis gambar untuk mesin virtual dan nama ISP untuk ExpressRoute. |
| additionalInfo | string | Metadata khusus layanan. Misalnya, jenis gambar untuk mesin virtual. |
| tag | string | Tag yang ditambahkan pelanggan. Untuk informasi selengkapnya, lihat Menata sumber daya Azure Anda dengan tag. |
| storeServiceIdentifier | string | Kolom ini tidak digunakan. Ada untuk kompatibilitas mundur. |
| departmentName | string | Nama departemen. |
| costCenter | string | Pusat biaya yang terkait dengan penggunaan. |
| unitOfMeasure | string | Mengidentifikasi unit tempat layanan ditagihkan. Contoh: GB, jam, 10.000 dtk. |
| resourceGroup | string | Grup sumber daya tempat meteran yang disebarkan berjalan. Untuk informasi selengkapnya, lihat Ringkasan Azure Resource Manager. |
| chargesBilledSeparately | string | Biaya yang ditagih di luar Komitmen Moneter. |
| lokasi | string | Lokasi tempat layanan disebarkan. |
| offerId | string | OfferId terhadap layanan. |
| partNumber | string | Nomor SKU untuk layanan. |
| resourceGuid | string | Pengidentifikasi untuk meteran yang memancarkan penggunaan. |
| serviceTier | string | Tingkat Layanan. |
| serviceName | string | Nama Layanan. |
Pembatasan Tarif
Untuk memungkinkan pengalaman yang konsisten di seluruh pelanggan kami, semua API Penggunaan dibatasi pada tingkat pendaftaran. Ketika Anda mencapai batas, Anda menerima kode status HTTP 429 Terlalu banyak permintaan. Throughput saat ini dalam interval 15 menit seperti di bawah ini:
| API | Batas Tarif |
|---|---|
| Halaman Berikutnya | 1000 |
| Unduh | 50 |
| Jajak pendapat | 180 |
| Kirim | 20 |