Untuk memeriksa setelan laporan, seperti cakupan dan metriknya, atau untuk memeriksa waktu berlakunya, gunakan App Optimize API untuk mendapatkan metadata laporan.
Permintaan API ini tidak menampilkan baris data sebenarnya dalam laporan. Untuk mendownload informasi ini, Anda harus membaca data laporan.
Sebelum memulai
-
Verify that you have the permissions required to complete this guide.
Pilih tab untuk melihat bagaimana Anda berencana menggunakan contoh dalam dokumen ini:
gcloud
Instal Google Cloud CLI.
Konfigurasi gcloud CLI agar menggunakan identitas gabungan Anda.
Untuk mengetahui informasi selengkapnya, lihat Login ke gcloud CLI dengan identitas gabungan Anda.
Untuk melakukan inisialisasi gcloud CLI, jalankan perintah berikut:
gcloud initSetelah menginisialisasi gcloud CLI, update gcloud CLI dan instal komponen yang diperlukan:
gcloud components update gcloud components install beta
Untuk mengetahui informasi tentang cara menyiapkan autentikasi bagi lingkungan produksi, lihat Menyiapkan Kredensial Default Aplikasi untuk kode yang berjalan di Google Cloud dalam Google Cloud dokumentasi autentikasi.
Python
- Instal library klien Python untuk App Optimize API.
-
Untuk menggunakan contoh Python di halaman ini dalam lingkungan pengembangan lokal, instal dan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.
-
Instal Google Cloud CLI.
-
Konfigurasi gcloud CLI agar menggunakan identitas gabungan Anda.
Untuk mengetahui informasi selengkapnya, lihat Login ke gcloud CLI dengan identitas gabungan Anda.
-
Buat kredensial autentikasi lokal untuk akun pengguna Anda:
gcloud auth application-default login
Jika error autentikasi ditampilkan, dan Anda menggunakan penyedia identitas (IdP) eksternal, pastikan Anda telah login ke gcloud CLI dengan identitas gabungan Anda.
Untuk mengetahui informasi selengkapnya, lihat Menyiapkan ADC untuk lingkungan pengembangan lokal dalam dokumentasi autentikasi. Google Cloud
Untuk mengetahui informasi tentang cara menyiapkan autentikasi bagi lingkungan produksi, lihat Menyiapkan Kredensial Default Aplikasi untuk kode yang berjalan di Google Cloud dalam Google Cloud dokumentasi autentikasi.
-
REST
Untuk menggunakan contoh REST API di halaman ini dalam lingkungan pengembangan lokal, gunakan kredensial yang Anda berikan ke gcloud CLI.
Instal Google Cloud CLI, lalu login ke gcloud CLI dengan identitas gabungan Anda.
Untuk mengetahui informasi selengkapnya, lihat Melakukan autentikasi untuk menggunakan REST dalam dokumentasi autentikasi. Google Cloud
Untuk mengetahui informasi tentang cara menyiapkan autentikasi bagi lingkungan produksi, lihat Menyiapkan Kredensial Default Aplikasi untuk kode yang berjalan di Google Cloud dalam Google Cloud dokumentasi autentikasi.
Peran yang diperlukan
Untuk mendapatkan izin yang diperlukan guna membaca metadata laporan, minta administrator untuk memberi Anda peran IAM App Optimize Viewer (roles/appoptimize.viewer) pada project yang memiliki resource laporan.
Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.
Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.
Mendapatkan metadata laporan
Untuk mengambil metadata laporan, ikuti petunjuk sesuai metode pilihan Anda:
gcloud
Gunakan perintah gcloud beta app-optimize reports describe untuk mendapatkan metadata laporan.
gcloud beta app-optimize reports describe REPORT_ID \
--project=PROJECT_ID \
--location=global
Ganti kode berikut:
PROJECT_ID: ID project yang memiliki resource laporan yang ingin Anda ambil. Google CloudREPORT_ID: ID laporan yang akan diambil. ID ini ditentukan saat laporan dibuat, dan dapat diperoleh dengan membuat daftar laporan.
Python
Kode Python berikut menggunakan AppOptimizeClient.get_report() untuk mendapatkan metadata laporan.
from google.cloud import appoptimize_v1beta
project_id = "PROJECT_ID"
report_id = "REPORT_ID"
name = f"projects/{project_id}/locations/global/reports/{report_id}"
# Create the App Optimize client and request the report's metadata
client = appoptimize_v1beta.AppOptimizeClient()
request = appoptimize_v1beta.GetReportRequest(name=name)
response = client.get_report(request=request)
# Display the metadata
print(response)
Ganti kode berikut:
PROJECT_ID: ID project yang memiliki resource laporan yang ingin Anda ambil. Google CloudREPORT_ID: ID laporan yang akan diambil. ID ini ditentukan saat laporan dibuat, dan dapat diperoleh dengan membuat daftar laporan.
REST
Gunakan perintah curl berikut untuk mendapatkan
metadata laporan:
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports/REPORT_ID"
Ganti kode berikut:
PROJECT_ID: ID project yang memiliki resource laporan yang ingin Anda ambil. Google CloudREPORT_ID: ID laporan yang akan diambil. ID ini ditentukan saat laporan dibuat, dan dapat diperoleh dengan membuat daftar laporan.
Jika permintaan berhasil, API akan menampilkan respons JSON yang berisi metadata laporan. Berikut adalah contoh respons yang berhasil, termasuk dimensi dan metrik yang dipilih, cakupan project, dan kapan laporan dijadwalkan untuk berakhir masa berlakunya:
{
"name": "projects/PROJECT_ID/locations/global/reports/REPORT_ID",
"dimensions": [
"location",
"product_display_name",
"project",
"resource",
"resource_type"
],
"scopes": [
{
"project": "projects/PROJECT_ID"
}
],
"filter": "hour >= now - duration(\"168h\")",
"expireTime": "2026-02-05T18:50:25.273833857Z",
"metrics": [
"cost",
"cpu_mean_utilization"
]
}