Mendapatkan metadata laporan

Untuk memeriksa setelan laporan, seperti cakupan dan metriknya, atau untuk memeriksa waktu habis 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

gcloud

Di konsol Google Cloud , aktifkan Cloud Shell.

Aktifkan Cloud Shell

Di bagian bawah konsol Google Cloud , sesi Cloud Shell akan dimulai dan menampilkan perintah command line. Cloud Shell adalah lingkungan shell dengan Google Cloud CLI yang sudah terinstal, dan dengan nilai yang sudah ditetapkan untuk project Anda saat ini. Diperlukan waktu beberapa detik untuk melakukan inisialisasi pada sesi.

Untuk mengetahui informasi tentang cara menyiapkan autentikasi bagi lingkungan produksi, lihat Menyiapkan Kredensial Default Aplikasi untuk kode yang berjalan di Google Cloud dalam dokumentasi autentikasi Google Cloud .

Python

  1. Instal library klien Python untuk App Optimize API.

  2. Untuk menggunakan contoh Python di halaman ini dalam lingkungan pengembangan lokal, instal dan lakukan inisialisasi gcloud CLI, lalu siapkan Kredensial Default Aplikasi dengan kredensial pengguna Anda.

    1. Instal Google Cloud CLI.

    2. Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

    3. Jika Anda menggunakan shell lokal, buat kredensial autentikasi lokal untuk akun pengguna Anda: 

      gcloud auth application-default login

      Anda tidak perlu melakukan langkah ini jika menggunakan Cloud Shell.

      Jika error autentikasi ditampilkan, dan Anda menggunakan penyedia identitas (IdP) eksternal, konfirmasi bahwa 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 dokumentasi autentikasi Google Cloud .

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.

    Jika Anda menggunakan penyedia identitas (IdP) eksternal, Anda harus login ke gcloud CLI dengan identitas gabungan Anda terlebih dahulu.

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 dokumentasi autentikasi Google Cloud .

Peran yang diperlukan

Untuk mendapatkan izin yang diperlukan untuk membaca metadata laporan, minta administrator untuk memberi Anda peran IAM App Optimize Viewer (roles/appoptimize.viewer) di 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 Google Cloud project yang memiliki resource laporan yang ingin Anda ambil.
  • REPORT_ID: ID laporan yang akan diambil. ID ini ditentukan saat laporan dibuat, dan dapat diperoleh dengan mencantumkan 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 Google Cloud project yang memiliki resource laporan yang ingin Anda ambil.
  • REPORT_ID: ID laporan yang akan diambil. ID ini ditentukan saat laporan dibuat, dan dapat diperoleh dengan mencantumkan 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 Google Cloud project yang memiliki resource laporan yang ingin Anda ambil.
  • REPORT_ID: ID laporan yang akan diambil. ID ini ditentukan saat laporan dibuat, dan dapat diperoleh dengan mencantumkan laporan.

Jika permintaan berhasil, API akan menampilkan respons JSON yang berisi metadata laporan. Berikut contoh respons yang berhasil, termasuk dimensi dan metrik yang dipilih, cakupan project, dan kapan laporan dijadwalkan berakhir:

{
  "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"
  ]
}

Langkah berikutnya