Query - Get Availability

Riferimento

Service:: Time Series Insights

API Version:: 2020-07-31

Restituisce l'intervallo di tempo e la distribuzione del numero di eventi nel timestamp dell'evento ($ts). Questa API può essere usata per offrire un'esperienza di destinazione per passare all'ambiente.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
environmentFqdn	path	True	string	Per FQDN dell'ambiente, ad esempio 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. È possibile ottenere questo nome di dominio dalla risposta dell'API Get Environment, portale di Azure o Azure Resource Manager.
api-version	query	True	string	Versione dell'API da usare con la richiesta client. La versione attualmente supportata è "2020-07-31".
storeType	query		string	Per gli ambienti con l'archivio ad accesso frequente abilitato, la query può essere eseguita in 'WarmStore' o 'ColdStore'. Questo parametro nella query definisce l'archivio in cui quest'ultima deve essere eseguita. Se non è definito, la query verrà eseguita nell'archivio ad accesso sporadico.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string	ID richiesta client facoltativo. Il servizio registra questo valore. Consente al servizio di tracciare l'operazione tra i servizi e consente al cliente di contattare il supporto tecnico per una richiesta specifica.
x-ms-client-session-id		string	ID sessione client facoltativo. Il servizio registra questo valore. Consente al servizio di tracciare un gruppo di operazioni correlate tra i servizi e consente al cliente di contattare il supporto tecnico per un determinato gruppo di richieste.

Risposte

Nome	Tipo	Descrizione
200 OK	AvailabilityResponse	Operazione riuscita. Headers x-ms-request-id: string
Other Status Codes	TsiError	Errore imprevisto. Headers x-ms-request-id: string

Nome

Tipo

Descrizione

200 OK

AvailabilityResponse

Operazione riuscita.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Errore imprevisto.

Headers

x-ms-request-id: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
Availability	Informazioni sulla disponibilità degli eventi quando l'ambiente contiene eventi. Contiene l'intervallo di tempo degli eventi e la distribuzione approssimativa degli eventi nel tempo.
AvailabilityResponse	Risposta dell'operazione Recupera disponibilità. Quando l'ambiente non dispone di dati, la proprietà di disponibilità è Null.
DateTimeRange	Intervallo di tempo. Non può essere null o negativo.
TsiError	Informazioni su un errore dell'API.
TsiErrorBody	Errore dell'API specifico con un codice di errore e un messaggio.
TsiErrorDetails	Informazioni aggiuntive sugli errori.

Availability

Informazioni sulla disponibilità degli eventi quando l'ambiente contiene eventi. Contiene l'intervallo di tempo degli eventi e la distribuzione approssimativa degli eventi nel tempo.

Nome	Tipo	Descrizione
distribution	object
intervalSize	string	Dimensioni dell'intervallo per la distribuzione restituita degli eventi. L'intervallo restituito viene selezionato per restituire un numero ragionevole di punti. Tutti gli intervalli sono le stesse dimensioni. Nell'intervallo di fili viene specificato in formato di durata ISO-8601. Un mese viene sempre convertito in 30 giorni e un anno è sempre 365 giorni. Esempi: 1 minuto è "PT1M", 1 millisecondo è "PT0.001S". Per altre informazioni, vedere https://www.w3.org/TR/xmlschema-2/#duration.
range	DateTimeRange	Valori minimi e massimi della proprietà timestamp dell'evento ($ts).

AvailabilityResponse

Risposta dell'operazione Recupera disponibilità. Quando l'ambiente non dispone di dati, la proprietà di disponibilità è Null.

Nome	Tipo	Descrizione
availability	Availability	Informazioni sulla disponibilità degli eventi quando l'ambiente contiene eventi. Quando l'ambiente non ha ancora dati, questa proprietà è null o non è presente.

DateTimeRange

Intervallo di tempo. Non può essere null o negativo.

Nome	Tipo	Descrizione
from	string	Timestamp di inizio dell'intervallo di tempo. Il timestamp di inizio è inclusivo quando viene usato nelle richieste di query della serie temporale. Gli eventi con questo timestamp sono inclusi.
to	string	Timestamp di fine dell'intervallo di tempo. Il timestamp di fine è esclusivo quando viene usato nelle richieste di query della serie temporale. Gli eventi corrispondenti a questo timestamp sono esclusi. Si noti che il timestamp di fine è inclusivo quando restituito da Get Availability (ovvero è presente un evento con questo timestamp esatto "to").

TsiError

Informazioni su un errore dell'API.

Nome	Tipo	Descrizione
error	TsiErrorBody	Errore dell'API specifico con un codice di errore e un messaggio.

TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.

Nome	Tipo	Descrizione
code	string	Stringa di errore indipendente dal linguaggio e leggibile che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
details	TsiErrorDetails[]	Contiene informazioni aggiuntive sugli errori. Può essere Null.
innerError	TsiErrorBody	Contiene un errore più specifico che restringe la causa. Può essere Null.
message	string	Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.
target	string	Destinazione del particolare errore (ad esempio, il nome della proprietà in errore). Può essere Null.

TsiErrorDetails

Informazioni aggiuntive sugli errori.

Nome	Tipo	Descrizione
code	string	Stringa di errore indipendente dal linguaggio e leggibile che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
message	string	Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.

Condividi tramite

Query - Get Availability

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

AvailabilityGet

Sample Request

Sample Response

AvailabilityGetEmpty

Sample Request

Sample Response

ColdStoreAvailabilityGet

Sample Request

Sample Response

WarmStoreAvailabilityGet

Sample Request

Sample Response

Definizioni

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Risorse aggiuntive