Query - Get Availability

Référence

Service:: Time Series Insights

Version d'API:: 2020-07-31

Retourne l’intervalle de temps et la distribution du nombre d’événements sur l’horodatage de l’événement ($ts). Cette API peut être utilisée pour fournir une expérience d’atterrissage de navigation vers l’environnement.

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

Avec des paramètres facultatifs:

GET https://{environmentFqdn}/availability?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.

Réponses

Nom	Type	Description
200 OK	AvailabilityResponse	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

AvailabilityResponse

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

AvailabilityGet

AvailabilityGetEmpty

ColdStoreAvailabilityGet

WarmStoreAvailabilityGet

AvailabilityGet

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{}

ColdStoreAvailabilityGet

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Définitions

Nom	Description
Availability	Informations sur la disponibilité des événements lorsque l’environnement contient des événements. Contient l’intervalle de temps des événements et la distribution approximative des événements dans le temps.
AvailabilityResponse	Réponse de l’opération Obtenir la disponibilité. Lorsque l’environnement n’a pas de données, la propriété de disponibilité est null.
DateTimeRange	Intervalle de temps. Ne peut pas être null ou négatif.
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.

Availability

Informations sur la disponibilité des événements lorsque l’environnement contient des événements. Contient l’intervalle de temps des événements et la distribution approximative des événements dans le temps.

Nom	Type	Description
distribution	object
intervalSize	string	Taille de l’intervalle pour la distribution retournée des événements. L’intervalle retourné est sélectionné pour renvoyer un nombre raisonnable de points. Tous les intervalles ont la même taille. Sur l’intervalle de fil est spécifié au format de durée ISO-8601. Un mois est toujours converti en 30 jours, et un an est toujours de 365 jours. Exemples : 1 minute est « PT1M », 1 milliseconde est « PT0.001S ». Pour plus d'informations, consultez https://www.w3.org/TR/xmlschema-2/#duration
range	DateTimeRange	Valeurs minimales et maximales de la propriété d’horodatage d’événement ($ts).

AvailabilityResponse

Réponse de l’opération Obtenir la disponibilité. Lorsque l’environnement n’a pas de données, la propriété de disponibilité est null.

Nom	Type	Description
availability	Availability	Informations sur la disponibilité des événements lorsque l’environnement contient des événements. Lorsque l’environnement n’a pas encore de données, cette propriété a la valeur Null ou n’est pas présente.

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).

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 Availability

Paramètres URI

En-tête de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

AvailabilityGet

Exemple de requête

Exemple de réponse

AvailabilityGetEmpty

Exemple de requête

Exemple de réponse

ColdStoreAvailabilityGet

Exemple de requête

Exemple de réponse

WarmStoreAvailabilityGet

Exemple de requête

Exemple de réponse

Définitions

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Ressources supplémentaires