Query - Get Event Schema

Başvuru

Service:: Time Series Insights

API Version:: 2020-07-31

Belirli bir arama aralığı için ortam olay şemasını döndürür. Olay şeması bir özellik tanımları kümesidir. Çok fazla özellik olduğunda olay şeması tüm kalıcı özellikleri içermeyebilir.

POST https://{environmentFqdn}/eventSchema?api-version=2020-07-31

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
environmentFqdn	path	True	string	Ortam başına FQDN, örneğin 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Bu etki alanı adını Get Environments API, Azure portal veya Azure Resource Manager yanıtından alabilirsiniz.
api-version	query	True	string	İstemci isteğiyle kullanılacak API sürümü. Şu anda desteklenen sürüm :"2020-07-31".
storeType	query		string	Sıcak deponun etkinleştirildiği ortamlar için sorgu 'WarmStore' veya 'ColdStore' üzerinde yürütülebilir. Sorgudaki bu parametre, sorgunun hangi depoda yürütülmesi gerektiğini tanımlar. Tanımlanmamışsa sorgu soğuk depoda yürütülür.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string	İsteğe bağlı istemci isteği kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında işlemi izlemesine ve müşterinin belirli bir istekle ilgili desteğe başvurmasına olanak tanır.
x-ms-client-session-id		string	İsteğe bağlı istemci oturum kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında bir grup ilgili işlemi izlemesine ve müşterinin belirli bir istek grubuyla ilgili desteğe başvurmasına olanak tanır.

İstek Gövdesi

Name	Gerekli	Tür	Description
searchSpan	True	DateTimeRange	Sorgunun yürütüldiği zaman aralığı. Null olamaz.

Yanıtlar

Name	Tür	Description
200 OK	EventSchema	İşlem başarılı. Headers x-ms-request-id: string
Other Status Codes	TsiError	Beklenmeyen hata. Headers x-ms-request-id: string

Name

Tür

Description

200 OK

EventSchema

İşlem başarılı.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Beklenmeyen hata.

Headers

x-ms-request-id: string

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Sample Request

HTTP

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

Status code:: 200

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

HTTP

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

Status code:: 200

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

HTTP

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

Status code:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Sample Request

HTTP

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

Status code:: 200

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

Tanımlar

Name	Description
DateTimeRange	Zaman aralığı. Null veya negatif olamaz.
EventProperty	Depolanan veya hesaplanan bir olayın özelliği. Özellikler hem ada hem de türe göre tanımlanır. Farklı olaylar aynı ada ancak farklı türe sahip özelliklere sahip olabilir.
EventSchema	Belirli bir arama aralığı içindeki tüm olayların olay şeması. Olay şeması bir özellik tanımları kümesidir. Özellikler hem ada hem de türe göre tanımlanır. Farklı olaylar aynı ada ancak farklı türe sahip özelliklere sahip olabilir. Çok fazla özellik olduğunda olay şeması tüm kalıcı özellikleri içermeyebilir.
GetEventSchemaRequest	Belirli bir arama aralığındaki tüm olayların olay şemasını alma isteği.
PropertyTypes	Özelliğin türü.
TsiError	API hatası hakkında bilgi.
TsiErrorBody	Hata kodu ve ileti içeren belirli bir API hatası.
TsiErrorDetails	Ek hata bilgileri.

DateTimeRange

Zaman aralığı. Null veya negatif olamaz.

Name	Tür	Description
from	string	Zaman aralığının başlangıç zaman damgası. Başlangıç zaman damgası, zaman serisi sorgu isteklerinde kullanıldığında dahil edilir. Bu zaman damgasına sahip olaylar dahil edilir.
to	string	Zaman aralığının bitiş zaman damgası. Zaman serisi sorgu isteklerinde kullanıldığında bitiş zaman damgası özeldir. Bu zaman damgasıyla eşleşen olaylar dışlanır. Bitiş zaman damgasının Get Availability tarafından döndürülenler dahil olduğunu unutmayın (tam olarak "bitiş" zaman damgasına sahip bir olay olduğu anlamına gelir).

EventProperty

Depolanan veya hesaplanan bir olayın özelliği. Özellikler hem ada hem de türe göre tanımlanır. Farklı olaylar aynı ada ancak farklı türe sahip özelliklere sahip olabilir.

Name	Tür	Description
name	string	Özelliğin adı.
type	PropertyTypes	Özelliğin türü.

EventSchema

Belirli bir arama aralığı içindeki tüm olayların olay şeması. Olay şeması bir özellik tanımları kümesidir. Özellikler hem ada hem de türe göre tanımlanır. Farklı olaylar aynı ada ancak farklı türe sahip özelliklere sahip olabilir. Çok fazla özellik olduğunda olay şeması tüm kalıcı özellikleri içermeyebilir.

Name	Tür	Description
properties	EventProperty[]	Özellik tanımları kümesi. Ortamda veri olmadığında, döndürülen dizi boş olur.

GetEventSchemaRequest

Belirli bir arama aralığındaki tüm olayların olay şemasını alma isteği.

Name	Tür	Description
searchSpan	DateTimeRange	Sorgunun yürütüldiği zaman aralığı. Null olamaz.

PropertyTypes

Özelliğin türü.

Name	Tür	Description
Bool	string
DateTime	string
Double	string
Long	string
String	string
TimeSpan	string

TsiError

API hatası hakkında bilgi.

Name	Tür	Description
error	TsiErrorBody	Hata kodu ve ileti içeren belirli bir API hatası.

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

Name	Tür	Description
code	string	Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details	TsiErrorDetails[]	Ek hata bilgileri içerir. Null olabilir.
innerError	TsiErrorBody	Nedeni daraltan daha belirli bir hata içerir. Null olabilir.
message	string	Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.
target	string	Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı). Null olabilir.

TsiErrorDetails

Ek hata bilgileri.

Name	Tür	Description
code	string	Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
message	string	Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.

Aracılığıyla paylaş

Query - Get Event Schema

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

ColdStoreEventSchemaGet

Sample Request

Sample Response

EventSchemaGet

Sample Request

Sample Response

EventSchemaGetEmpty

Sample Request

Sample Response

WarmStoreEventSchemaGet

Sample Request

Sample Response

Tanımlar

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Ek kaynaklar