REST API Azure Enterprise

Artikel ini menjelaskan REST API untuk digunakan dengan pendaftaran enterprise Azure Anda. Ini juga menjelaskan cara menyelesaikan masalah umum dengan REST API.

API konsumsi dan penggunaan

Pelanggan Microsoft Enterprise Azure bisa mendapatkan informasi penggunaan dan penagihan melalui REST API. Pemilik peran (Admin Enterprise, Admin Departemen, Pemilik Akun) harus mengaktifkan akses ke API dengan membuat kunci dari portal Microsoft Azure EA. Kemudian, siapa pun yang diberikan nomor pendaftaran dan kunci dapat mengakses data melalui API.

API yang Tersedia

Saldo dan Ringkasan - API Saldo and Ringkasan menyediakan ringkasan bulanan informasi tentang saldo, pembelian baru, biaya layanan Azure Marketplace, penyesuaian, dan biaya kelebihan biaya. Untuk informasi selengkapnya, lihat API Pelaporan untuk pelanggan Enterprise - Saldo dan Ringkasan.

Detail Penggunaan - API Usage Detail menyediakan perincian harian terkait jumlah yang dikonsumsi dan perkiraan biaya oleh pendaftaran. Hasilnya juga mencakup informasi tentang instans, meter, dan departemen. Anda dapat melakukan kueri API dengan periode penagihan atau dengan tanggal mulai dan akhir yang ditentukan. Untuk informasi selengkapnya, lihat API Pelaporan untuk pelanggan Enterprise - Detail Penggunaan.

Biaya Penyimpanan Marketplace - API Biaya Marketplace Store menampilkan biaya marketplace berbasis penggunaan, hari yang diurai untuk periode penagihan atau tanggal mulai dan akhir tertentu. Untuk informasi selengkapnya, lihat API Pelaporan untuk pelanggan Enterprise - Biaya Marketplace Store.

Lembar Harga - API Lembar Harga menyediakan tarif yang berlaku untuk setiap meter untuk suatu periode pendaftaran dan penagihan. Untuk informasi selengkapnya, lihat API Pelaporan untuk pelanggan Enterprise - Lembar Harga.

Periode Tagihan - API Periode Penagihan menghasilkan daftar periode tagihan yang memiliki data konsumsi untuk pendaftaran dalam urutan kronologis terbalik. Setiap periode berisi properti yang menunjuk ke rute API untuk empat set data, BalanceSummary, UsageDetails, Marketplace Charges, dan PriceSheet. Untuk informasi selengkapnya, lihat API Pelaporan untuk pelanggan Enterprise - Periode Tagihan.

Mengaktifkan akses data API

Pemilik peran dapat melakukan langkah-langkah berikut di portal Microsoft Azure EA. Buka Laporan > Unduh Penggunaan > Kunci Akses API. Kemudian, pemilik peran dapat:

  • Membuat kunci akses primer dan sekunder.
  • Menonaktifkan kunci akses.
  • Melihat tanggal mulai dan akhir kunci akses.

Membuat atau mengambil Kunci API

  1. Masuk sebagai admin perusahaan.
  2. Klik Laporan di jendela navigasi kiri, lalu klik tab Unduh Penggunaan.
  3. Klik Kunci Akses API.
  4. Di bawah Kunci Akses Pendaftaran, pilih simbol hasilkan kunci untuk menghasilkan kunci primer atau sekunder.
  5. Pilih Luaskan Kunci untuk melihat seluruh kunci akses API yang dihasilkan.
  6. Pilih Salin untuk mendapatkan kunci akses API untuk segera digunakan.

Contoh memperlihatkan halaman Kunci Akses API

Jika Anda ingin memberikan kunci akses API kepada orang-orang yang bukan admin perusahaan dalam pendaftaran Anda, lakukan langkah-langkah berikut:

  1. Di jendela navigasi kiri, klik Kelola.
  2. Klik simbol pensil di samping biaya tampilan DA (biaya tampilan Admin Departemen).
  3. Pilih Aktifkan, lalu klik Simpan.
  4. Klik simbol pensil di samping biaya tampilan AO (biaya tampilan Pemilik Akun).
  5. Pilih Aktifkan, lalu klik Simpan.

Contoh memperlihatkan biaya tampilan DA dan AO diaktifkan Langkah-langkah sebelumnya memberi pemegang kunci akses API dengan akses ke informasi biaya dan harga dalam laporan penggunaan.

Lewati tombol di API

Berikan kunci API untuk setiap panggilan untuk autentikasi dan otorisasi. Serahkan properti berikut ini ke header HTTP:

Kunci header permintaan Nilai
Authorization Tentukan nilai dalam format ini: token pembawa {API_KEY}
Contoh: token pembawa < APIKey>

Swagger

Titik akhir Swagger tersedia di API Enterprise Reporting v3untuk API berikut. Swagger membantu memeriksa API. Gunakan Swagger untuk menghasilkan SDK klien menggunakan AutoRest atau Swagger CodeGen. Data yang tersedia setelah 1 Mei 2014 tersedia melalui API.

Kode respons API

Saat Anda menggunakan API, kode status respons akan ditampilkan. Tabel berikut ini menjelaskannya.

Kode status respons Pesan Deskripsi
200 OK Tidak ada kesalahan
401 Tidak diizinkan Kunci API tidak ditemukan, Tidak Valid, Kedaluwarsa dll.
404 Tidak tersedia Titik akhir laporan tidak ditemukan
400 Permintaan Buruk Parameter tidak valid - Rentang tanggal, nomor EA, dll.
500 server_error Permintaan pemrosesan kesalahan tak terduga

Frekuensi pembaruan data penggunaan dan penagihan

File data penggunaan dan penagihan diperbarui setiap 24 jam untuk bulan penagihan saat ini. Namun, latensi data dapat terjadi hingga tiga hari. Misalnya, jika penggunaan dilakukan pada hari Senin, data mungkin tidak muncul dalam file data hingga Kamis.

Katalog layanan Azure

Semua layanan Azure diposting ke katalog dalam format CSV dalam blog penyimpanan Azure. Katalog ini berguna jika Anda perlu membuat katalog yang dikumpulkan dari semua layanan Azure untuk sistem Anda. Katalog saat ini berada di https://azurecatalog.blob.core.windows.net/catalog/AzureCatalog.csv.

Detail file data CSV

Informasi berikut menjelaskan properti laporan API.

Ringkasan Penggunaan

Format JSON dihasilkan dari laporan CSV. Hasilnya, formatnya sama dengan format CSV ringkasan. Nama kolom digunakan, jadi Anda harus deserialisasi ke dalam tabel data saat Anda menggunakan data ringkasan JSON.

Nama kolom CSV Nama kolom JSON Kolom baru JSON Komentar
AccountOwnerId AccountOwnerLiveId AccountOwnerLiveId
Nama akun AccountName AccountName
ServiceAdministratorId ServiceAdministratorLiveId ServiceAdministratorLiveId
SubscriptionId SubscriptionId SubscriptionId
SubscriptionGuid MOCPSubscriptionGuid SubscriptionGuid
Nama langganan SubscriptionName SubscriptionName
Tanggal Tanggal Tanggal Memperlihatkan tanggal laporan katalog layanan berjalan. Formatnya adalah untai (karakter) tanggal tanpa tanda waktu.
Bulan Bulan Bulan
Hari Hari Hari
Tahun Tahun Tahun
Produk BillableItemName Produk
Meter ID ResourceGuid meterId
Kategori meter Layanan MeterCategory Berguna untuk membantu menemukan layanan. Relevan untuk layanan yang memiliki beberapa ServiceType. Misalnya,Virtual Machines.
Meter Sub-Category ServiceType MeterSubCategory Menyediakan tingkat detail kedua untuk layanan. Misalnya, A1 komputer virtual (Non-Windows).
Wilayah meteran ServiceRegion meterRegion Tingkat detail ketiga yang diperlukan untuk layanan. Berguna untuk menemukan konteks wilayah ResourceGUID.
Nama Meter ServiceResource MeterName Nama layanan.
Kuantitas yang Dikonsumsi ResourceQtyConsumed ConsumedQuantity
ResourceRate ResourceRate ResourceRate
ExtendedCost ExtendedCost ExtendedCost
Lokasi sumber daya ServiceSubRegion ResourceLocation
Layanan yang Dikonsumsi ServiceInfo ConsumedService
ID Instans Komponen InstanceId
ServiceInfo1 ServiceInfo1 ServiceInfo1
ServiceInfo2 ServiceInfo2 ServiceInfo2
AdditionalInfo AdditionalInfo AdditionalInfo
Tag Tag Tag
Pengidentifikasi Layanan Store OrderNumber StoreServiceIdentifier
Nama Departemen DepartmentName DepartmentName
Pusat Biaya CostCenter CostCenter
Satuan ukuran UnitOfMeasure UnitOfMeasure Contoh nilai: Jam, GB, Peristiwa, Dorong, Unit, Jam Kerja, MB, Unit Harian
ResourceGroup ResourceGroup ResourceGroup

Laporan Marketplace Azure

Nama kolom CSV Nama kolom JSON Kolom baru JSON
AccountOwnerId AccountOwnerId AccountOwnerId
Nama akun AccountName AccountName
SubscriptionId SubscriptionId SubscriptionId
SubscriptionGuid SubscriptionGuid SubscriptionGuid
Nama langganan SubscriptionName SubscriptionName
Tanggal BillingCycle Tanggal (Untai (karakter) Tanggal saja. Tidak ada tanda waktu)
Bulan Bulan Bulan
Hari Hari Hari
Tahun Tahun Tahun
Meter ID MeterResourceId MeterId
Nama Penerbit Namapengsayang Penerbit PublisherName
Nama Penawaran OfferFriendlyName OfferName
Nama Paket PlanFriendlyName PlanName
Kuantitas yang Dikonsumsi BilledQty ConsumedQuantity
ResourceRate ResourceRate ResourceRate
ExtendedCost ExtendedCost ExtendedCost
Satuan ukuran UnitOfMeasure UnitOfMeasure
ID Instans InstanceId InstanceId
Informasi Tambahan AdditionalInfo AdditionalInfo
Tag Tag Tag
Nomor Pesanan OrderNumber OrderNumber
Nama Departemen DepartmentNames DepartmentName
Pusat Biaya CostCenters CostCenter
Grup Sumber Daya ResourceGroup ResourceGroup

Lembar harga

Nama kolom CSV Nama kolom JSON Komentar
Layanan Layanan Tidak ada perubahan pada harga
Satuan ukuran UnitOfMeasure
Nomor Bagian Overage ConsumptionPartNumber
Harga Pelajaran Overage ConsumptionPrice
Kode mata uang CurrencyCode

Masalah API yang umum

Saat Anda menggunakan REST API Azure Enterprise, Anda mungkin mengalami salah satu masalah umum berikut.

Anda mungkin mencoba menggunakan kunci API yang tidak memiliki jenis otorisasi yang benar. Kunci API dihasilkan oleh:

  • Enterprise Administrator
  • Admin Departemen (DA)
  • Pemilik Akun (AO)

Kunci yang dihasilkan oleh admin EA memberikan akses ke semua informasi untuk pendaftaran tersebut. Admin EA baca-saja tidak dapat membuat kunci API.

Kunci yang dihasilkan oleh DA atau AO tidak menyediakan akses ke informasi saldo, tagihan, dan lembar harga.

Kunci API kedaluwarsa setiap enam bulan. Jika kedaluwarsa, Anda perlu membuatnya kembali.

Jika Anda menemui kesalahan waktu habis, Anda dapat mengatasinya dengan meningkatkan ambang batas waktu.

Anda mungkin menerima kesalahan 401 kesalahan kedaluwarsa (tidak sah). Kesalahan tersebut biasanya disebabkan oleh kunci yang kedaluwarsa. Jika kunci kedaluwarsa, Anda dapat membuatnya kembali.

Anda mungkin menerima kesalahan 400 dan 404 (tidak tersedia) yang dihasilkan dari panggilan API ketika tidak ada data terkini yang tersedia untuk rentang tanggal yang dipilih. Misalnya, kesalahan ini mungkin terjadi karena transfer pendaftaran baru saja dimulai. Data dari tanggal tertentu dan yang lebih baru sekarang berada di pendaftaran baru. Jika tidak, kesalahan mungkin terjadi jika Anda menggunakan nomor pendaftaran baru untuk mengambil informasi yang ada di pendaftaran lama.

Langkah berikutnya