Topik ini menjelaskan cara mengelola dan memanfaatkan API metrik yang telah ditentukan sebelumnya, API data produk, serta API layanan kustom.
Prasyarat
Untuk mengelola dan menggunakan API metrik yang telah ditentukan sebelumnya, pastikan produk dan perangkat telah dibuat serta cadangan telah diselesaikan.
Untuk informasi lebih lanjut, lihat akses data.
Untuk API data produk atau API layanan kustom, pastikan API terkait telah dibuat. Untuk informasi lebih lanjut, lihat API data produk dan API layanan kustom.
Mengelola API
Di konsol IoT Platform, klik Overview. Pada tab Overview, temukan instans yang ingin dikelola dan klik ID instans atau nama instans tersebut.
Navigasikan ke DataService Studio > Data APIs menggunakan panel navigasi di sisi kiri.
Pada halaman Data API, pilih tab Predefined Metrics API, Product Data API, atau Custom Service API. Temukan API yang diinginkan, lalu klik View di kolom Operation.
Di bagian kanan atas halaman API Details, pilih nomor versi untuk melihat detailnya, termasuk informasi dasar, pemantauan API, dan parameter.
Klik API Operations untuk meninjau penggunaan API.
Klik API Test untuk menguji API dan melihat detail permintaan, contoh balasan, serta contoh pemanggilan.
Menggunakan API
Dengan detail API yang tersedia, Anda dapat mengintegrasikan dan memanggil API yang sesuai di server Anda untuk mengambil data relevan serta memaksimalkan penggunaan aset data.
Catatan: Jumlah maksimum permintaan per detik (QPS) untuk memanggil API layanan data dengan satu akun Alibaba Cloud adalah 100.
Panggil ListAnalyticsData untuk mengambil data dari API tertentu sesuai kebutuhan bisnis.
Jika menggunakan SDK yang disediakan oleh Alibaba Cloud, lihat contoh berikut berdasarkan bahasa pengembangan Anda:
Saat tidak menggunakan SDK Alibaba Cloud, perhatikan parameter umum berikut selama pengembangan:
Nama
Tipe
Wajib
Nilai Contoh
Deskripsi
apiPath
String
Ya
pk/temperatureMax
Path titik akhir API.
iotInstanceId
String
Ya
iot-cn-npk1u******
Pengenal unik dari instans IoT Platform yang terkait dengan topik. Untuk informasi lebih lanjut, lihat Masalah Terkait Instans IoT Platform.
pageNum
Integer
Tidak (Kondisional)
10
Nomor halaman untuk hasil yang dipaginasi.
pageSize
Integer
Tidak (Kondisional)
100
Menentukan jumlah catatan per halaman, hingga maksimum 100.
Di halaman detail API, Anda dapat meninjau parameter balasan API. Berikut adalah parameter balasan umum:
Nama
Tipe
Nilai Contoh
Deskripsi
Count
Long
3
Menunjukkan jumlah total entri yang dikembalikan.
HasNext
Boolean
false
Menentukan apakah ada halaman data berikutnya yang tersedia.
true: Ada halaman berikutnya.
false: Tidak ada halaman lagi.
PageNum
Integer
1
Nomor halaman saat ini.
PageSize
Integer
100
Jumlah entri yang ditampilkan per halaman.
ResultJson
String
[{"testCode":"TBB186","testLevel":5,"testWorkYears":3,"testName":"Jack"},{"testCode":"TBB1314","testLevel":2,"testWorkYears":4,"testName":"Tom"},{"testCode":"TBB8888","testLevel":2,"testWorkYears":5,"testName":"Eric"}]
Sebuah string JSON yang berisi detail data yang dikembalikan.