Bagikan melalui


Query - Get Availability

Mengembalikan rentang waktu dan distribusi jumlah peristiwa selama tanda waktu peristiwa ($ts). API ini dapat digunakan untuk memberikan pengalaman pendaratan menavigasi ke lingkungan.

GET https://{environmentFqdn}/availability?api-version=2020-07-31
GET https://{environmentFqdn}/availability?api-version=2020-07-31&storeType={storeType}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
environmentFqdn
path True

string

Per lingkungan FQDN, misalnya 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Anda dapat memperoleh nama domain ini dari respons Get Environments API, portal Azure, atau Azure Resource Manager.

api-version
query True

string

Versi API yang akan digunakan dengan permintaan klien. Versi yang saat ini didukung adalah "2020-07-31".

storeType
query

string

Untuk lingkungan dengan penyimpanan hangat diaktifkan, kueri dapat dijalankan baik di 'WarmStore' atau 'ColdStore'. Parameter dalam kueri ini menentukan di penyimpanan mana kueri harus dijalankan. Jika tidak ditentukan, kueri akan dijalankan di penyimpanan dingin.

Header Permintaan

Nama Diperlukan Jenis Deskripsi
x-ms-client-request-id

string

ID permintaan klien opsional. Layanan merekam nilai ini. Memungkinkan layanan untuk melacak operasi di seluruh layanan, dan memungkinkan pelanggan untuk menghubungi dukungan mengenai permintaan tertentu.

x-ms-client-session-id

string

ID sesi klien opsional. Layanan merekam nilai ini. Memungkinkan layanan untuk melacak sekelompok operasi terkait di seluruh layanan, dan memungkinkan pelanggan untuk menghubungi dukungan mengenai sekelompok permintaan tertentu.

Respons

Nama Jenis Deskripsi
200 OK

AvailabilityResponse

Operasi berhasil.

Header

x-ms-request-id: string

Other Status Codes

TsiError

Kesalahan tak terduga.

Header

x-ms-request-id: string

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

AvailabilityGet
AvailabilityGetEmpty
ColdStoreAvailabilityGet
WarmStoreAvailabilityGet

AvailabilityGet

Permintaan sampel

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/availability?api-version=2020-07-31

Respon sampel

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb
{
  "availability": {
    "intervalSize": "PT1H",
    "distribution": {
      "2019-03-27T04:00:00Z": 432447,
      "2019-03-27T05:00:00Z": 432340,
      "2019-03-27T06:00:00Z": 432451,
      "2019-03-27T07:00:00Z": 432436,
      "2019-03-26T13:00:00Z": 386247,
      "2019-03-27T00:00:00Z": 436968,
      "2019-03-27T01:00:00Z": 432509,
      "2019-03-27T02:00:00Z": 432487
    },
    "range": {
      "from": "2019-03-14T06:38:27.153Z",
      "to": "2019-03-27T03:57:11.697Z"
    }
  }
}

AvailabilityGetEmpty

Permintaan sampel

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/availability?api-version=2020-07-31

Respon sampel

{}

ColdStoreAvailabilityGet

Permintaan sampel

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/availability?api-version=2020-07-31&storeType=coldstore

Respon sampel

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb
{
  "availability": {
    "intervalSize": "PT1H",
    "distribution": {
      "2019-03-27T04:00:00Z": 432447,
      "2019-03-27T05:00:00Z": 432340,
      "2019-03-27T06:00:00Z": 432451,
      "2019-03-27T07:00:00Z": 432436,
      "2019-03-26T13:00:00Z": 386247,
      "2019-03-27T00:00:00Z": 436968,
      "2019-03-27T01:00:00Z": 432509,
      "2019-03-27T02:00:00Z": 432487
    },
    "range": {
      "from": "2019-03-14T06:38:27.153Z",
      "to": "2019-03-27T03:57:11.697Z"
    }
  }
}

WarmStoreAvailabilityGet

Permintaan sampel

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/availability?api-version=2020-07-31&storeType=warmstore

Respon sampel

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb
{
  "availability": {
    "intervalSize": "PT1H",
    "distribution": {
      "2019-03-27T04:00:00Z": 432447,
      "2019-03-27T05:00:00Z": 432340,
      "2019-03-27T06:00:00Z": 432451,
      "2019-03-27T07:00:00Z": 432436,
      "2019-03-26T13:00:00Z": 386247,
      "2019-03-27T00:00:00Z": 436968,
      "2019-03-27T01:00:00Z": 432509,
      "2019-03-27T02:00:00Z": 432487
    },
    "range": {
      "from": "2019-03-14T06:38:27.153Z",
      "to": "2019-03-27T03:57:11.697Z"
    }
  }
}

Definisi

Nama Deskripsi
Availability

Informasi ketersediaan peristiwa saat lingkungan berisi peristiwa. Berisi rentang waktu peristiwa dan perkiraan distribusi peristiwa dari waktu ke waktu.

AvailabilityResponse

Respons operasi Dapatkan Ketersediaan. Ketika lingkungan tidak memiliki data, properti ketersediaan null.

DateTimeRange

Rentang waktu. Tidak boleh null atau negatif.

TsiError

Informasi tentang kesalahan API.

TsiErrorBody

Kesalahan API tertentu dengan kode kesalahan dan pesan.

TsiErrorDetails

Informasi kesalahan tambahan.

Availability

Informasi ketersediaan peristiwa saat lingkungan berisi peristiwa. Berisi rentang waktu peristiwa dan perkiraan distribusi peristiwa dari waktu ke waktu.

Nama Jenis Deskripsi
distribution

object

intervalSize

string

Ukuran interval untuk distribusi peristiwa yang dikembalikan. Interval yang dikembalikan dipilih untuk mengembalikan jumlah titik yang wajar. Semua interval berukuran sama. Pada interval kawat ditentukan dalam format durasi ISO-8601. Satu bulan selalu dikonversi menjadi 30 hari, dan satu tahun selalu 365 hari. Contoh: 1 menit adalah "PT1M", 1 milidetik adalah "PT0.001S". Untuk informasi selengkapnya, lihat https://www.w3.org/TR/xmlschema-2/#duration

range

DateTimeRange

Nilai minimum dan maksimum properti tanda waktu peristiwa ($ts).

AvailabilityResponse

Respons operasi Dapatkan Ketersediaan. Ketika lingkungan tidak memiliki data, properti ketersediaan null.

Nama Jenis Deskripsi
availability

Availability

Informasi ketersediaan peristiwa saat lingkungan berisi peristiwa. Ketika lingkungan belum memiliki data, properti ini null atau tidak ada.

DateTimeRange

Rentang waktu. Tidak boleh null atau negatif.

Nama Jenis Deskripsi
from

string

Mulai tanda waktu rentang waktu. Tanda waktu mulai inklusif saat digunakan dalam permintaan kueri rangkaian waktu. Peristiwa yang memiliki tanda waktu ini disertakan.

to

string

Tanda waktu akhir rentang waktu. Tanda waktu akhir eksklusif saat digunakan dalam permintaan kueri rangkaian waktu. Peristiwa yang cocok dengan tanda waktu ini dikecualikan. Perhatikan bahwa tanda waktu akhir inklusif ketika dikembalikan oleh Dapatkan Ketersediaan (yang berarti bahwa ada peristiwa dengan tanda waktu "ke" yang tepat ini).

TsiError

Informasi tentang kesalahan API.

Nama Jenis Deskripsi
error

TsiErrorBody

Kesalahan API tertentu dengan kode kesalahan dan pesan.

TsiErrorBody

Kesalahan API tertentu dengan kode kesalahan dan pesan.

Nama Jenis Deskripsi
code

string

String independen bahasa, dapat dibaca manusia yang mendefinisikan kode kesalahan khusus layanan. Kode ini berfungsi sebagai indikator yang lebih spesifik untuk kode kesalahan HTTP yang ditentukan dalam respons. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.

details

TsiErrorDetails[]

Berisi informasi kesalahan tambahan. Mungkin null.

innerError

TsiErrorBody

Berisi kesalahan yang lebih spesifik yang mempersempit penyebabnya. Mungkin null.

message

string

Representasi kesalahan yang dapat dibaca manusia dan independen bahasa. Ini dimaksudkan sebagai bantuan kepada pengembang dan tidak cocok untuk paparan pengguna akhir.

target

string

Target kesalahan tertentu (misalnya, nama properti dalam kesalahan). Mungkin null.

TsiErrorDetails

Informasi kesalahan tambahan.

Nama Jenis Deskripsi
code

string

String independen bahasa, dapat dibaca manusia yang mendefinisikan kode kesalahan khusus layanan. Kode ini berfungsi sebagai indikator yang lebih spesifik untuk kode kesalahan HTTP yang ditentukan dalam respons. Dapat digunakan untuk menangani kasus kesalahan tertentu secara terprogram.

message

string

Representasi kesalahan yang dapat dibaca manusia dan independen bahasa. Ini dimaksudkan sebagai bantuan kepada pengembang dan tidak cocok untuk paparan pengguna akhir.