Query - Get Event Schema

Référence

Service:: Time Series Insights

Version d'API:: 2020-07-31

Retourne le schéma d’événement d’environnement pour une étendue de recherche donnée. Le schéma d’événements est un ensemble de définitions de propriétés. Le schéma d’événements peut ne pas contenir toutes les propriétés persistantes lorsqu’il y a trop de propriétés.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentFqdn	path	True	string	Par nom de domaine complet de l’environnement, par exemple 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Vous pouvez obtenir ce nom de domaine à partir de la réponse de l’API Get Environments, Portail Azure ou azure Resource Manager.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente. La version actuellement prise en charge est « 31/07/2020 ».
storeType	query		string	Pour les environnements où le magasin chaud est activé, la requête peut être exécutée sur « WarmStore » ou « ColdStore ». Ce paramètre dans la requête définit le magasin sur lequel la requête doit être exécutée. S’il n’est pas défini, la requête est exécutée sur le magasin Cold.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string	ID de demande client facultative. Le service enregistre cette valeur. Permet au service de suivre l’opération entre les services et permet au client de contacter le support technique pour une demande particulière.
x-ms-client-session-id		string	ID de session client facultatif. Le service enregistre cette valeur. Permet au service de suivre un groupe d’opérations associées entre les services et permet au client de contacter le support technique concernant un groupe particulier de demandes.

Corps de la demande

Nom	Obligatoire	Type	Description
searchSpan	True	DateTimeRange	Intervalle de temps pendant lequel la requête est exécutée. Ne peut pas être null.

Réponses

Nom	Type	Description
200 OK	EventSchema	Opération réussie. En-têtes x-ms-request-id: string
Other Status Codes	TsiError	Erreur inattendue. En-têtes x-ms-request-id: string

Nom

Type

Description

200 OK

EventSchema

Opération réussie.

En-têtes

x-ms-request-id: string

Other Status Codes

TsiError

Erreur inattendue.

En-têtes

x-ms-request-id: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ColdStoreEventSchemaGet

EventSchemaGet

EventSchemaGetEmpty

WarmStoreEventSchemaGet

ColdStoreEventSchemaGet

Exemple de requête

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 200

{
  "properties": []
}

WarmStoreEventSchemaGet

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
DateTimeRange	Intervalle de temps. Ne peut pas être null ou négatif.
EventProperty	Propriété d’un événement stocké ou calculé. Les propriétés sont identifiées par leur nom et leur type. Différents événements peuvent avoir des propriétés avec le même nom, mais un type différent.
EventSchema	Schéma d’événements de tous les événements au sein d’une étendue de recherche donnée. Le schéma d’événements est un ensemble de définitions de propriétés. Les propriétés sont identifiées par leur nom et leur type. Différents événements peuvent avoir des propriétés avec le même nom, mais un type différent. Le schéma d’événements peut ne pas contenir toutes les propriétés persistantes lorsqu’il y a trop de propriétés.
GetEventSchemaRequest	Demande d’obtenir le schéma d’événements de tous les événements au sein d’une étendue de recherche donnée.
PropertyTypes	Type de la propriété.
TsiError	Informations sur une erreur d’API.
TsiErrorBody	Erreur d’API particulière avec un code d’erreur et un message.
TsiErrorDetails	Informations supplémentaires sur l’erreur.

DateTimeRange

Intervalle de temps. Ne peut pas être null ou négatif.

Nom	Type	Description
from	string	Horodatage de début de l’intervalle de temps. L’horodatage de début est inclusif lorsqu’il est utilisé dans les requêtes de série chronologique. Les événements qui ont cet horodatage sont inclus.
to	string	Horodatage de fin de l’intervalle de temps. L’horodatage de fin est exclusif lorsqu’il est utilisé dans les requêtes de série chronologique. Les événements qui correspondent à ce timestamp sont exclus. Notez que l’horodatage de fin est inclusif lorsqu’il est retourné par Get Availability (ce qui signifie qu’il existe un événement avec cet horodatage « à » exact).

EventProperty

Propriété d’un événement stocké ou calculé. Les propriétés sont identifiées par leur nom et leur type. Différents événements peuvent avoir des propriétés avec le même nom, mais un type différent.

Nom	Type	Description
name	string	Nom de la propriété.
type	PropertyTypes	Type de la propriété.

EventSchema

Schéma d’événements de tous les événements au sein d’une étendue de recherche donnée. Le schéma d’événements est un ensemble de définitions de propriétés. Les propriétés sont identifiées par leur nom et leur type. Différents événements peuvent avoir des propriétés avec le même nom, mais un type différent. Le schéma d’événements peut ne pas contenir toutes les propriétés persistantes lorsqu’il y a trop de propriétés.

Nom	Type	Description
properties	EventProperty[]	Ensemble de définitions de propriétés. Lorsque l’environnement n’a pas de données, le tableau retourné est vide.

GetEventSchemaRequest

Demande d’obtenir le schéma d’événements de tous les événements au sein d’une étendue de recherche donnée.

Nom	Type	Description
searchSpan	DateTimeRange	Intervalle de temps pendant lequel la requête est exécutée. Ne peut pas être null.

PropertyTypes

Type de la propriété.

Nom	Type	Description
Bool	string
DateTime	string
Double	string
Long	string
String	string
TimeSpan	string

TsiError

Informations sur une erreur d’API.

Nom	Type	Description
error	TsiErrorBody	Erreur d’API particulière avec un code d’erreur et un message.

TsiErrorBody

Erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	TsiErrorDetails[]	Contient des informations supplémentaires sur les erreurs. Ce paramètre peut être null.
innerError	TsiErrorBody	Contient une erreur plus spécifique qui limite la cause. Ce paramètre peut être null.
message	string	Représentation de l’erreur, lisible et indépendante de la langue. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition aux utilisateurs finaux.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur). Ce paramètre peut être null.

TsiErrorDetails

Informations supplémentaires sur l’erreur.

Nom	Type	Description
code	string	Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
message	string	Représentation de l’erreur, lisible et indépendante de la langue. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition aux utilisateurs finaux.

Partager via

Query - Get Event Schema

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

ColdStoreEventSchemaGet

Exemple de requête

Exemple de réponse

EventSchemaGet

Exemple de requête

Exemple de réponse

EventSchemaGetEmpty

Exemple de requête

Exemple de réponse

WarmStoreEventSchemaGet

Exemple de requête

Exemple de réponse

Définitions

DateTimeRange

EventProperty

EventSchema

GetEventSchemaRequest

PropertyTypes

TsiError

TsiErrorBody

TsiErrorDetails

Ressources supplémentaires