Query - Get Availability

Referencia

Service:: Time Series Insights

API Version:: 2020-07-31

Az eseményszám időtartományát és eloszlását adja vissza az esemény időbélyegével ($ts). Ez az API használható a környezetbe való navigáláshoz.

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

With optional parameters:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
environmentFqdn	path	True	string	Környezeti teljes tartománynévként, például 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Ezt a tartománynevet a Get Environments API, a Azure Portal vagy az Azure Resource Manager válaszából szerezheti be.
api-version	query	True	string	Az ügyfélkéréshez használni kívánt API verziója. Jelenleg a "2020-07-31" támogatott verzió.
storeType	query		string	A meleg tárolóval rendelkező környezetek esetében a lekérdezés végrehajtható a "WarmStore" vagy a "ColdStore" webhelyen. Ez a lekérdezési paraméter határozza meg, hogy a lekérdezés melyik tárolójában kell végrehajtani a lekérdezést. Ha nincs definiálva, a lekérdezés a hűtőházban lesz végrehajtva.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string	Nem kötelező ügyfélkérés azonosítója. A szolgáltatás ezt az értéket rögzíti. Lehetővé teszi, hogy a szolgáltatás nyomon kövesse a műveletet a szolgáltatások között, és lehetővé teszi, hogy az ügyfél kapcsolatba lépjen az ügyfélszolgálattal egy adott kéréssel kapcsolatban.
x-ms-client-session-id		string	Nem kötelező ügyfélmunkamenet-azonosító. A szolgáltatás ezt az értéket rögzíti. Lehetővé teszi, hogy a szolgáltatás nyomon kövesse a kapcsolódó műveletek egy csoportját a szolgáltatások között, és lehetővé teszi, hogy az ügyfél kapcsolatba lépjen az ügyfélszolgálattal egy adott kéréscsoporttal kapcsolatban.

Válaszok

Name	Típus	Description
200 OK	AvailabilityResponse	Sikeres művelet. Headers x-ms-request-id: string
Other Status Codes	TsiError	Váratlan hiba. Headers x-ms-request-id: string

Name

Típus

Description

200 OK

AvailabilityResponse

Sikeres művelet.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Váratlan hiba.

Headers

x-ms-request-id: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

AvailabilityGet

AvailabilityGetEmpty

ColdStoreAvailabilityGet

WarmStoreAvailabilityGet

AvailabilityGet

Sample Request

HTTP

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

Sample Response

Status code:: 200

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb

Response Body

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

Sample Request

HTTP

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

Sample Response

Status code:: 200

{}

ColdStoreAvailabilityGet

Sample Request

HTTP

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

Sample Response

Status code:: 200

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb

Response Body

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

Sample Request

HTTP

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

Sample Response

Status code:: 200

x-ms-request-id: 0d59d156-2807-4952-87bb-0e074417dbfb

Response Body

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

Definíciók

Name	Description
Availability	Esemény rendelkezésre állási információja, ha a környezet eseményeket tartalmaz. Az események időtartományát és az események időbeli eloszlásának hozzávetőleges eloszlását tartalmazza.
AvailabilityResponse	A Rendelkezésre állás lekérése művelet válasza. Ha a környezet nem rendelkezik adatokkal, a rendelkezésre állási tulajdonság null értékű.
DateTimeRange	Az időtartomány. Nem lehet null vagy negatív.
TsiError	Api-hibával kapcsolatos információk.
TsiErrorBody	Egy adott API-hiba hibakóddal és üzenettel.
TsiErrorDetails	További hibainformációk.

Availability

Esemény rendelkezésre állási információja, ha a környezet eseményeket tartalmaz. Az események időtartományát és az események időbeli eloszlásának hozzávetőleges eloszlását tartalmazza.

Name	Típus	Description
distribution	object
intervalSize	string	Az események visszaadott eloszlásának intervallummérete. A visszaadott időköz úgy van kiválasztva, hogy ésszerű számú pontot adjon vissza. Minden intervallum azonos méretű. A vezeték időköze ISO-8601 időtartam formátumban van megadva. Egy hónap mindig 30 napra változik, egy év pedig mindig 365 nap. Példák: 1 perc "PT1M", 1 ezredmásodperc a "PT0.001S". További információ: https://www.w3.org/TR/xmlschema-2/#duration
range	DateTimeRange	Az eseményidőbélyeg ($ts) tulajdonság minimális és maximális értékei.

AvailabilityResponse

A Rendelkezésre állás lekérése művelet válasza. Ha a környezet nem rendelkezik adatokkal, a rendelkezésre állási tulajdonság null értékű.

Name	Típus	Description
availability	Availability	Esemény rendelkezésre állási információja, ha a környezet eseményeket tartalmaz. Ha a környezet még nem rendelkezik adatokkal, ez a tulajdonság null értékű vagy nincs jelen.

DateTimeRange

Az időtartomány. Nem lehet null vagy negatív.

Name	Típus	Description
from	string	Az időtartomány kezdési időbélyege. A kezdési időbélyeg az idősoros lekérdezési kérelmekben való használat esetén használható. Az ilyen időbélyegzőt tartalmazó eseményeket a program tartalmazza.
to	string	Az időtartomány záró időbélyege. A befejezési időbélyeg kizárólagos, ha idősoros lekérdezési kérelmekben használják. Az időbélyegnek megfelelő események ki vannak zárva. Vegye figyelembe, hogy a végső időbélyeg a Rendelkezésre állás lekérése által visszaadott időbélyeget tartalmazza (ami azt jelenti, hogy van egy olyan esemény, amely pontosan a "to" időbélyeggel rendelkezik).

TsiError

Api-hibával kapcsolatos információk.

Name	Típus	Description
error	TsiErrorBody	Egy adott API-hiba hibakóddal és üzenettel.

TsiErrorBody

Egy adott API-hiba hibakóddal és üzenettel.

Name	Típus	Description
code	string	Nyelvfüggetlen, emberi olvasásra alkalmas sztring, amely szolgáltatásspecifikus hibakódot definiál. Ez a kód a válaszban megadott HTTP-hibakód pontosabb jelzőjeként szolgál. Adott hibaesetek programozott kezelésére használható.
details	TsiErrorDetails[]	További hibainformációkat tartalmaz. Lehet, hogy null értékű.
innerError	TsiErrorBody	Pontosabb hibát tartalmaz, amely szűkíti az okot. Lehet, hogy null értékű.
message	string	A hiba ember által olvasható, nyelvfüggetlen ábrázolása. A fejlesztőknek szánt támogatás, és nem alkalmas a végfelhasználóknak való kitettségre.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve). Lehet, hogy null értékű.

TsiErrorDetails

További hibainformációk.

Name	Típus	Description
code	string	Nyelvfüggetlen, emberi olvasásra alkalmas sztring, amely szolgáltatásspecifikus hibakódot definiál. Ez a kód a válaszban megadott HTTP-hibakód pontosabb jelzőjeként szolgál. Adott hibaesetek programozott kezelésére használható.
message	string	A hiba ember által olvasható, nyelvfüggetlen ábrázolása. A fejlesztőknek szánt támogatás, és nem alkalmas a végfelhasználóknak való kitettségre.

Query - Get Availability

URI-paraméterek

Kérelem fejléce

Válaszok

Biztonság

azure_auth

Scopes

Példák

AvailabilityGet

Sample Request

Sample Response

AvailabilityGetEmpty

Sample Request

Sample Response

ColdStoreAvailabilityGet

Sample Request

Sample Response

WarmStoreAvailabilityGet

Sample Request

Sample Response

Definíciók

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

További források