Bagikan melalui

API Kueri Azure Time Series Insights Gen2

  • Artikel

Gambaran Umum

API Kueri terdiri dari tiga REST API, masing-masing satu API untuk peristiwa, seri, dan agregat.

API Kueri mengembalikan skema peristiwa dan jumlah peristiwa selama rentang waktu tertentu melalui permintaan HTTP GET dengan penomoran halaman opsional. Informasiseri dan seri agregat juga diekspos melalui operasi GET dengan penomoran halaman opsional.

API Deskripsi
Dapatkan API Peristiwa Mengembalikan daftar peristiwa mentah yang cocok dengan rentang pencarian dan predikat.
Dapatkan API Seri Memungkinkan kueri dan pengambilan data Time Series Insights dari peristiwa yang diambil dengan menggunakan data yang direkam pada kawat melalui variabel yang ditentukan dalam model atau disediakan sebaris.
API Seri Agregat Memungkinkan kueri dan pengambilan data Time Series Insights dari peristiwa yang diambil dengan menggabungkan data yang direkam dengan menggunakan fungsi agregat atau sampel.

API juga mendukung berbagai operasi yang disesuaikan yang ditentukan melalui isi JSON permintaan HTTP. Definisi kueri dapat digunakan untuk operasi umum.

Penting

Respons kesalahan

Jika eksekusi kueri gagal, payload respons JSON akan berisi respons kesalahan yang sesuai dengan struktur berikut:

{
    "error" : {
        "code" : "...",
        "message" : "...",
        "innerError" : {  
            "code" : "...",
            "message" : "...",
        }
    }
}

Di sini, innerError bersifat opsional. Selain kesalahan dasar seperti permintaan cacat, kesalahan berikut dikembalikan:

Kode status http Kode kesalahan Contoh pesan kesalahan Kemungkinan kode innerError
400 InvalidApiVersion API versi '2016' tidak didukung. Versi yang didukung adalah '2016-12-12', '2018-11-01-preview'. -
400 InvalidUrl URL permintaan '/a/b' tidak dapat diurai. -
400 InvalidInput Kueri 'agregat' yang diberikan tidak valid. Kueri yang didukung adalah 'getEvents','getSeries','aggregateSeries'. InvalidQueryType
400 InvalidInput Ekspresi rangkaian waktu '$event.temperature.Double > 0' di 'projectedVariables.temperature.value' bukan ekspresi referensi properti yang valid. InvalidPropertyReferenceExpression
400 InvalidInput Ekspresi rangkaian waktu '$event.temperature.Double' dalam 'projectedVariables.temperature.filter' tidak valid. Ini hanya bisa menjadi ekspresi predikat yang mengembalikan boolean. InvalidPredicateExpression
400 InvalidInput Ekspresi rangkaian waktu '$event.temperature.Double' dalam 'projectedVariables.temperature.aggregation' tidak valid. Ini tidak berisi ekspresi agregat. InvalidAggregateExpression
400 InvalidInput Ekspresi rangkaian waktu '$event.temperature.Double > 0' dalam 'projectedVariables.temperature.value' bukan ekspresi nilai yang valid dari jenis 'numerik'. InvalidValueExpression
400 InvalidInput Ekspresi rangkaian waktu nilai dalam 'projectedVariables.temperature.value' tidak boleh ditentukan atau harus null untuk variabel jenis 'agregat'. ValueExpressionShouldNotBeSpecified
400 InvalidInput Ekspresi rangkaian waktu nilai dalam 'projectedVariables.temperature.value' harus ditentukan untuk jenis variabel 'numerik'. ValueExpressionShouldBeSpecified
400 InvalidInput Jenis variabel 'agregat' tidak valid untuk ekspresi 'min($value)' dalam 'projectedVariables.temperature.aggregation'. InvalidVariableKind
400 InvalidInput Rentang waktu '00.00:01' dalam 'interval' bukan format rentang waktu ISO8601 yang valid. InvalidTimeSpanFormat
400 InvalidInput Instans dengan timeSeriesId '["ABC123"]' tidak ditemukan. InstanceNotFound
400 InvalidInput Instans dengan nama 'timeSeriesName' tidak ditemukan. InstanceNotFound
400 InvalidInput Instans dengan timeSeriesId '["ABC321"]' tidak dapat dihapus. Sudah ada peristiwa yang diserap yang terkait dengan ID rangkaian waktu ini. CannotDeleteInstance
400 InvalidInput Lingkungan dengan ID '5e19f688-83fb-4aee-8321-5c123ed016b7' tidak mendukung API kueri rangkaian waktu. TimeSeriesQueryNotSupported
400 InvalidInput Variabel yang diproyeksikan dengan nama 'suhu' tidak ditemukan dalam definisi variabel jenis atau sebaris. ProjectedVariableNotFound
400 InvalidInput Tidak dapat melakukan upsert type dengan ID '7e19g688-83fb-4aee-8321-5c123ed016b7' dan nama 'ABC123'. Nama ini sudah digunakan berdasarkan jenis dengan ID '6e19g688-83fb-4aee-8321-5c123ed016b7'. NameAlreadyExists
400 InvalidInput Tidak dapat meningkatkan hierarki dengan ID '4e19g688-83fb-4aee-8321-7c123ed016b7' dan nama 'XYZ123'. Nama ini sudah digunakan oleh hierarki dengan ID '8e39g688-83fb-4aee-8321-5c123ed016b7'. HierarchyNotDefined
400 InvalidInput Jumlah instans melebihi batas '1.000.000'. NumberOfInstancesExceededLimit
400 InvalidInput Jumlah jenis melebihi batas '1000'. NumberOfTypesExceededLimit
400 InvalidInput Jumlah hierarki melebihi batas '32'. NumberOfHierarchiesExceededLimit
400 InvalidInput Ukuran entitas lebih dari ukuran maksimum yang diizinkan '16,384'. ObjectSizeExceededLimit
400 InvalidInput Nama objek 'ABC123' dengan panjang '6' melebihi batas karakter maksimum yang diizinkan '5'. NameExceededLimit
408 RequestTimeout Waktu permintaan habis setelah '30' detik. BatchRequestSizeExceededLimit
503 TooManyRequests Jumlah permintaan bersamaan '30' terlampaui untuk lingkungan '95880732-01b9-44ea-8d2d-4d764dfe1904'. EnvRequestLimitExceeded

Lihat juga

  • Untuk informasi selengkapnya tentang pendaftaran aplikasi dan model pemrograman Azure Active Directory, lihat Azure Active Directory untuk pengembang.

  • Untuk mempelajari tentang parameter permintaan dan autentikasi, baca Autentikasi dan otorisasi.

  • Alat yang membantu pengujian permintaan dan respons HTTP meliputi:

  • Fiddler. Proksi penelusuran kesalahan web gratis ini dapat mencegat permintaan REST Anda, sehingga Anda dapat mendiagnosis pesan permintaan dan respons HTTP.

  • JWT.io. Anda dapat menggunakan alat ini untuk mencadangkan klaim dengan cepat di token pembawa Anda lalu memvalidasi kontennya.

  • Postman. Ini adalah permintaan HTTP gratis dan alat pengujian respons untuk men-debug REST API.

  • Pelajari selengkapnya tentang Azure Time Series Insights Gen2 dengan meninjau dokumentasi Gen2.