Operasi API internal - Panduan Pengguna Tingkat Lanjut AMS

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Operasi API internal

Jika Anda memantau operasi API, Anda mungkin melihat panggilan ke operasi khusus internal berikut:

  • GetDashboardUrl

  • ListReportsV2

Operasi API internal: GetDashboardUrl

Operasi ini muncul di log sistem saat dipanggil oleh konsol AMS. Ini tidak memiliki kasus penggunaan lain. Ini tidak tersedia untuk penggunaan langsung Anda.

Mengembalikan URL dasbor tertanam untuk laporan terkait. Operasi ini menerima dashboardName pengembalian olehListReports.

Permintaan sintaks

HTTP/1.1 200 Content-type: application/json { "dashboardName": "string" }

Permintaan elemen

dashboardName: Nama QuickSight dasbor tempat URL diminta. Nama dasbor dikembalikan dalam ListReports V2.

Tipe: String

Sintaks respons

HTTP/1.1 200 Content-type: application/json { "url": "string" }

Elemen respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200. Layanan mengembalikan data berikut dalam format JSON.

url: Mengembalikan QuickSight URL untuk dimintadashboardName.

Tipe: String

Kesalahan

Untuk informasi tentang kesalahan yang umum terjadi pada semua tindakan, lihat Kesalahan umum.

BadRequestException:

Permintaan yang diajukan tidak valid. Misalnya, jika input tidak lengkap atau salah. Lihat pesan kesalahan yang menyertainya untuk detailnya.

Kode Status HTTP: 400

NotFoundException:

Sumber daya yang diminta tidak ditemukan. Pastikan URI permintaan sudah benar.

Kode Status HTTP: 404

TooManyRequestsException:

Permintaan telah mencapai batas pelambatan. Coba lagi setelah periode waktu yang ditentukan.

Kode Status HTTP: 429

UnauthorizedException:

Permintaan ditolak karena penelepon tidak memiliki izin yang memadai.

Kode Status HTTP: 401

Operasi API internal: ListReports V2

API ini muncul di log sistem saat dipanggil oleh konsol AMS. Ini tidak memiliki kasus penggunaan lain. Ini tidak tersedia untuk penggunaan langsung Anda.

Mengembalikan daftar laporan operasional yang tersedia untuk akun tertentu.

Permintaan sintaks

Permintaan tidak memiliki badan permintaan.

Sintaks respons

HTTP/1.1 200 Content-type: application/json { "reportsList": [ { "dashboard": "string", "lastUpdatedTime": "string", } ], "reportsType": "string" }

Elemen respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200. Layanan mengembalikan data berikut dalam format JSON.

reportsList: Daftar laporan operasional yang tersedia.

Jenis: Array objek Dashboard

reportsType: Menunjukkan apakah laporan dikumpulkan di beberapa akun atau tidak.

Tipe: String

Kesalahan

Untuk informasi tentang kesalahan yang umum terjadi pada semua tindakan, lihat Kesalahan umum.

BadRequestException:

Permintaan yang diajukan tidak valid. Misalnya, input tidak lengkap atau salah. Lihat pesan kesalahan yang menyertainya untuk detailnya.

Kode Status HTTP: 400

NotFoundException:

Sumber daya yang diminta tidak ditemukan. Pastikan URI permintaan sudah benar.

Kode Status HTTP: 404

TooManyRequestsException:

Permintaan telah mencapai batas pelambatan. Coba lagi setelah periode waktu yang ditentukan.

Kode Status HTTP: 429

UnauthorizedException:

Permintaan ditolak karena penelepon tidak memiliki izin yang memadai.

Kode Status HTTP: 401