Query - Get Availability

Referencia

Servicio:: Time Series Insights

Versión de la API:: 2020-07-31

Devuelve el intervalo de tiempo y la distribución del recuento de eventos en la marca de tiempo del evento ($ts). Esta API se puede usar para proporcionar experiencia de aterrizaje para navegar al entorno.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
environmentFqdn	path	True	string	Por FQDN de entorno, por ejemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Puede obtener este nombre de dominio de la respuesta de Get Environments API, Azure Portal o Azure Resource Manager.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión admitida actualmente es "2020-07-31".
storeType	query		string	Para los entornos con el almacenamiento intermedio habilitado, la consulta se puede ejecutar en "WarmStore" o "ColdStore". Este parámetro de la consulta define en qué almacén debe ejecutarse la consulta. Si no se define, la consulta se ejecutará en el almacén frío.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string	Identificador de solicitud de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de la operación entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a una solicitud determinada.
x-ms-client-session-id		string	Identificador de sesión de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de un grupo de operaciones relacionadas entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a un grupo determinado de solicitudes.

Respuestas

Nombre	Tipo	Description
200 OK	AvailabilityResponse	Operación correcta. Encabezados x-ms-request-id: string
Other Status Codes	TsiError	error inesperado. Encabezados x-ms-request-id: string

Nombre

Tipo

Description

200 OK

AvailabilityResponse

Operación correcta.

Encabezados

x-ms-request-id: string

Other Status Codes

TsiError

error inesperado.

Encabezados

x-ms-request-id: string

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

AvailabilityGet

AvailabilityGetEmpty

ColdStoreAvailabilityGet

WarmStoreAvailabilityGet

AvailabilityGet

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{}

ColdStoreAvailabilityGet

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
    }
  }
}

Definiciones

Nombre	Description
Availability	Información de disponibilidad de eventos cuando el entorno contiene eventos. Contiene el intervalo de tiempo de los eventos y la distribución aproximada de los eventos a lo largo del tiempo.
AvailabilityResponse	Respuesta de la operación Obtener disponibilidad. Cuando el entorno no tiene datos, la propiedad availability es null.
DateTimeRange	Intervalo de tiempo. No puede ser null o negativo.
TsiError	Información sobre un error de API.
TsiErrorBody	Un error de API determinado con un código de error y un mensaje.
TsiErrorDetails	Información adicional de error.

Availability

Información de disponibilidad de eventos cuando el entorno contiene eventos. Contiene el intervalo de tiempo de los eventos y la distribución aproximada de los eventos a lo largo del tiempo.

Nombre	Tipo	Description
distribution	object
intervalSize	string	Tamaño del intervalo para la distribución devuelta de los eventos. El intervalo devuelto se selecciona para devolver un número razonable de puntos. Todos los intervalos tienen el mismo tamaño. En el intervalo de alambre se especifica en formato de duración ISO-8601. Un mes siempre se convierte en 30 días y un año siempre es de 365 días. Ejemplos: 1 minuto es "PT1M", 1 milisegundos es "PT0.001S". Para obtener más información, vea https://www.w3.org/TR/xmlschema-2/#duration.
range	DateTimeRange	Valores mínimos y máximos de la propiedad timestamp ($ts).

AvailabilityResponse

Respuesta de la operación Obtener disponibilidad. Cuando el entorno no tiene datos, la propiedad availability es null.

Nombre	Tipo	Description
availability	Availability	Información de disponibilidad de eventos cuando el entorno contiene eventos. Cuando el entorno aún no tiene datos, esta propiedad es null o no está presente.

DateTimeRange

Intervalo de tiempo. No puede ser null o negativo.

Nombre	Tipo	Description
from	string	Marca de tiempo de inicio del intervalo de tiempo. La marca de tiempo de inicio es inclusiva cuando se usa en las solicitudes de consulta de serie temporal. Se incluyen eventos que tienen esta marca de tiempo.
to	string	Marca de tiempo de finalización del intervalo de tiempo. La marca de tiempo de finalización es exclusiva cuando se usa en las solicitudes de consulta de serie temporal. Los eventos que coinciden con esta marca de tiempo se excluyen. Tenga en cuenta que la marca de tiempo final es inclusiva cuando la devuelve Get Availability (lo que significa que hay un evento con esta marca de tiempo exacta de "a").

TsiError

Información sobre un error de API.

Nombre	Tipo	Description
error	TsiErrorBody	Un error de API determinado con un código de error y un mensaje.

TsiErrorBody

Un error de API determinado con un código de error y un mensaje.

Nombre	Tipo	Description
code	string	Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código actúa como un indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
details	TsiErrorDetails[]	Contiene información de error adicional. Su valor puede ser null.
innerError	TsiErrorBody	Contiene un error más específico que limita la causa. Su valor puede ser null.
message	string	Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.
target	string	Destino del error determinado (por ejemplo, el nombre de la propiedad en error). Su valor puede ser null.

TsiErrorDetails

Información adicional de error.

Nombre	Tipo	Description
code	string	Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código actúa como un indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
message	string	Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.

Compartir a través de

Query - Get Availability

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

AvailabilityGet

Solicitud de ejemplo

Respuesta de muestra

AvailabilityGetEmpty

Solicitud de ejemplo

Respuesta de muestra

ColdStoreAvailabilityGet

Solicitud de ejemplo

Respuesta de muestra

WarmStoreAvailabilityGet

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Recursos adicionales