Query - Get Event Schema
Egy adott keresési tartomány környezeti eseménysémát ad vissza. Az eseményséma tulajdonságdefiníciók halmaza. Előfordulhat, hogy az eseményséma nem tartalmazza az összes megőrzött tulajdonságot, ha túl sok tulajdonság van.
POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31
POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31&storeType={storeType}
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
environment
|
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ó. |
store
|
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. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
searchSpan | True |
A lekérdezés végrehajtásának időtartama. Nem lehet null értékű. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Sikeres művelet. Headers x-ms-request-id: string |
|
Other Status Codes |
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
Cold |
Event |
Event |
Warm |
ColdStoreEventSchemaGet
Sample Request
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=coldstore
{
"searchSpan": {
"from": "2018-08-01T00:00:00.000Z",
"to": "2018-08-31T00:00:00.000Z"
}
}
Sample Response
{
"properties": [
{
"name": "Building",
"type": "String"
},
{
"name": "Room",
"type": "String"
},
{
"name": "DeviceId",
"type": "Double"
},
{
"name": "Temperature",
"type": "Double"
},
{
"name": "Pressure",
"type": "Double"
},
{
"name": "Status",
"type": "String"
}
]
}
EventSchemaGet
Sample Request
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31
{
"searchSpan": {
"from": "2018-08-01T00:00:00.000Z",
"to": "2018-08-31T00:00:00.000Z"
}
}
Sample Response
{
"properties": [
{
"name": "Building",
"type": "String"
},
{
"name": "Room",
"type": "String"
},
{
"name": "DeviceId",
"type": "Double"
},
{
"name": "Temperature",
"type": "Double"
},
{
"name": "Pressure",
"type": "Double"
},
{
"name": "Status",
"type": "String"
}
]
}
EventSchemaGetEmpty
Sample Request
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31
{
"searchSpan": {
"from": "2016-08-01T00:00:00.000Z",
"to": "2016-08-31T00:00:00.000Z"
}
}
Sample Response
{
"properties": []
}
WarmStoreEventSchemaGet
Sample Request
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/eventSchema?api-version=2020-07-31&storeType=warmstore
{
"searchSpan": {
"from": "2018-08-01T00:00:00.000Z",
"to": "2018-08-31T00:00:00.000Z"
}
}
Sample Response
{
"properties": [
{
"name": "Building",
"type": "String"
},
{
"name": "Room",
"type": "String"
},
{
"name": "DeviceId",
"type": "Double"
},
{
"name": "Temperature",
"type": "Double"
},
{
"name": "Pressure",
"type": "Double"
},
{
"name": "Status",
"type": "String"
}
]
}
Definíciók
Name | Description |
---|---|
Date |
Az időtartomány. Nem lehet null vagy negatív. |
Event |
Egy tárolt vagy kiszámított esemény tulajdonsága. A tulajdonságokat a rendszer név és típus alapján is azonosítja. A különböző események azonos nevű, de eltérő típusú tulajdonságokkal rendelkezhetnek. |
Event |
Az adott keresési tartományon belüli összes esemény eseményséma. Az eseményséma tulajdonságdefiníciók halmaza. A tulajdonságokat a rendszer név és típus alapján is azonosítja. A különböző események azonos nevű, de eltérő típusú tulajdonságokkal rendelkezhetnek. Előfordulhat, hogy az eseményséma nem tartalmazza az összes megőrzött tulajdonságot, ha túl sok tulajdonság van. |
Get |
Kérje meg az adott keresési tartományon belüli összes esemény eseményséma lekérését. |
Property |
A tulajdonság típusa. |
Tsi |
Api-hibával kapcsolatos információk. |
Tsi |
Egy adott API-hiba hibakóddal és üzenettel. |
Tsi |
További hibainformációk. |
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). |
EventProperty
Egy tárolt vagy kiszámított esemény tulajdonsága. A tulajdonságokat a rendszer név és típus alapján is azonosítja. A különböző események azonos nevű, de eltérő típusú tulajdonságokkal rendelkezhetnek.
Name | Típus | Description |
---|---|---|
name |
string |
A tulajdonság neve. |
type |
A tulajdonság típusa. |
EventSchema
Az adott keresési tartományon belüli összes esemény eseményséma. Az eseményséma tulajdonságdefiníciók halmaza. A tulajdonságokat a rendszer név és típus alapján is azonosítja. A különböző események azonos nevű, de eltérő típusú tulajdonságokkal rendelkezhetnek. Előfordulhat, hogy az eseményséma nem tartalmazza az összes megőrzött tulajdonságot, ha túl sok tulajdonság van.
Name | Típus | Description |
---|---|---|
properties |
Tulajdonságdefiníciók halmaza. Ha a környezet nem rendelkezik adatokkal, a visszaadott tömb üres. |
GetEventSchemaRequest
Kérje meg az adott keresési tartományon belüli összes esemény eseményséma lekérését.
Name | Típus | Description |
---|---|---|
searchSpan |
A lekérdezés végrehajtásának időtartama. Nem lehet null értékű. |
PropertyTypes
A tulajdonság típusa.
Name | Típus | Description |
---|---|---|
Bool |
string |
|
DateTime |
string |
|
Double |
string |
|
Long |
string |
|
String |
string |
|
TimeSpan |
string |
TsiError
Api-hibával kapcsolatos információk.
Name | Típus | Description |
---|---|---|
error |
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 |
További hibainformációkat tartalmaz. Lehet, hogy null értékű. |
|
innerError |
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. |