API Reporting untuk pelanggan Enterprise - Detail Penggunaan

Catatan

Microsoft tidak lagi memperbarui API Pelaporan Enterprise. Sebagai gantinya, Anda harus menggunakan API Penggunaan Azure. API Azure Billing - Usage Details digantikan oleh Azure Consumption - Usage Details API.

API ini hanya mendukung catatan 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, migrasikan 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 akhir yang ada 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. Kinerja API bergantung 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 memberikan dukungan maksimal satu bulan.

Metode Permintaan Unduh URI
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 dan kemudian melakukan jajak pendapat untuk mendapatkan URL berbasis kunci akses bersama untuk lokasi Azure Blob yang memiliki data CSV. Waktu maksimum yang didukung berdering di sini adalah 36 bulan. Kami merekomendasikan API ini untuk dataset yang lebih besar.

Metode Ajukan 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

Tanggapan Asynchronous (polling) mengirimkan panggilan

    {
        "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 permintaan dibuat untuk.
dimintaOn string Tanggal waktu permintaan itu dibuat.
status int Menunjukkan status permintaan. Antri = 1, InProgress = 2, Selesai = 3, Gagal = 4, NoDataFound = 5, ReadyToDownload =6, TimedOut = 7.
blobPath string URL kunci akses bersama ke gumpalan csv.
reportUrl string URL yang dapat digunakan untuk polling untuk status permintaan submit.
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 menanggapi permintaan pemungutan suara 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 dari waktu tanggal di bidang respons yang diminta. Status 4, 5 dan 7 adalah status kegagalan di mana panggilan API telah mencapai kondisi kesalahan. Untuk semua status lainnya, panggilan pemungutan suara 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 akan 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 disand paged. Properti NextLink, jika ada, menentukan tautan untuk halaman data berikutnya. Jika tautan kosong, itu 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 instans\meter.
NextLink string Ketika ada lebih banyak halaman data, nextLink menunjuk ke URL untuk mengembalikan halaman data berikutnya.
accountId int Bidang usang. Hadir untuk kompatibilitas ke belakang.
productId int Bidang usang. Hadir untuk kompatibilitas ke belakang.
resourceLocationId int Bidang usang. Hadir untuk kompatibilitas ke belakang.
consumedServiceId int Bidang usang. Hadir untuk kompatibilitas ke belakang.
departmentId int Bidang usang. Hadir untuk kompatibilitas ke belakang.
accountOwnerEmail string Akun email pemilik akun.
accountName string Pelanggan memasukkan nama akun.
serviceAdministratorId string Alamat Email Administrator Layanan.
subscriptionId int Bidang usang. Hadir untuk kompatibilitas ke belakang.
subscriptionGuid string Pengenal Unik Global untuk langganan.
subscriptionName string Nama langganan.
tanggal string Tanggal di mana konsumsi terjadi.
produk string Detail tambahan pada meteran.
meterId string Pengidentifikasi untuk meteran yang dipancarkan penggunaan.
meterCategory string Layanan platform Azure yang digunakan.
meterSubCategory string Mendefinisikan 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.
dikonsumsiQuantity double Jumlah meteran yang telah dikonsumsi.
resourceRate double Tarif berlaku per unit yang dapat ditagih.
cost double Biaya yang telah dikeluarkan untuk meteran.
resourceLocation string Mengidentifikasi pusat data tempat meter berjalan.
consumedService string Layanan platform Azure yang digunakan.
instanceId string Pengidentifikasi ini adalah nama sumber daya atau ID Sumber Daya yang memenuhi syarat. Untuk informasi selengkapnya, lihat Azure Resource Manager API
serviceInfo1 string Internal Azure Service Metadata.
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 Pelanggan menambahkan tag. Untuk informasi selengkapnya, lihat Menata sumber daya Azure Anda dengan tag.
storeServiceidentifier string Kolom ini tidak digunakan. Hadir untuk kompatibilitas ke belakang.
departmentName string Nama departemen.
costCenter string Pusat biaya yang digunakan dikaitkan dengan.
unitOfMeasure string Mengidentifikasi unit tempat layanan ditagihkan. Contoh: GB, jam, 10.000 d.
resourceGroup string Kelompok sumber daya tempat meteran yang digunakan berjalan. Untuk informasi selengkapnya, lihat Ringkasan Azure Resource Manager.
chargesBilledSeparately string Biaya ditagih di luar Komitmen Moneter.
lokasi string Lokasi di mana layanan dikerahkan.
offerId string OfferId terhadap layanan.
partNumber string Nomor SKU untuk layanan.
resourceGuid string Pengidentifikasi untuk meteran yang dipancarkan 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 adalah seperti di bawah ini:

API Batas Tarif
Halaman Berikutnya 1000
Unduh 50
Jajak pendapat 180
Kirim 20

Lihat juga