Query - Get Availability

Ссылка

Service:: Time Series Insights

API Version:: 2020-07-31

Возвращает диапазон времени и распределение количества событий по метке времени события ($ts). Этот API можно использовать для предоставления целевого интерфейса при переходе в среду.

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

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
environmentFqdn	path	True	string	Полное доменное имя среды, например 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Это доменное имя можно получить из ответа API получения сред, портал Azure или azure Resource Manager.
api-version	query	True	string	Версия API для использования с клиентским запросом. В настоящее время поддерживается версия 2020-07-31.
storeType	query		string	Для сред с включенным теплым хранилищем запрос можно выполнить в WarmStore или ColdStore. Этот параметр в запросе определяет, в каком хранилище должен выполняться запрос. Если этот параметр не определен, запрос будет выполнен в холодном хранилище.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-request-id		string	Необязательный идентификатор запроса клиента. Служба записывает это значение. Позволяет службе отслеживать операции между службами и позволяет клиенту обращаться в службу поддержки по конкретному запросу.
x-ms-client-session-id		string	Необязательный идентификатор сеанса клиента. Служба записывает это значение. Позволяет службе отслеживать группу связанных операций между службами и позволяет клиенту обращаться в службу поддержки по поводу определенной группы запросов.

Ответы

Имя	Тип	Описание
200 OK	AvailabilityResponse	Успешная операция. Headers x-ms-request-id: string
Other Status Codes	TsiError	Непредвиденная ошибка. Headers x-ms-request-id: string

Имя

Тип

Описание

200 OK

AvailabilityResponse

Успешная операция.

Headers

x-ms-request-id: string

Other Status Codes

TsiError

Непредвиденная ошибка.

Headers

x-ms-request-id: string

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
Availability	Сведения о доступности событий, если среда содержит события. Содержит диапазон времени событий и приблизительное распределение событий по времени.
AvailabilityResponse	Ответ на операцию получения доступности. Если в среде нет данных, свойство доступности имеет значение NULL.
DateTimeRange	Диапазон времени. Не может иметь значение NULL или отрицательное значение.
TsiError	Сведения об ошибке API.
TsiErrorBody	Определенная ошибка API с кодом ошибки и сообщением.
TsiErrorDetails	Дополнительные сведения об ошибке.

Availability

Сведения о доступности событий, если среда содержит события. Содержит диапазон времени событий и приблизительное распределение событий по времени.

Имя	Тип	Описание
distribution	object
intervalSize	string	Размер интервала для возвращаемого распределения событий. Возвращаемый интервал выбирается для возврата разумного количества точек. Все интервалы имеют одинаковый размер. Интервал передачи указан в формате длительности ISO-8601. Один месяц всегда преобразуется в 30 дней, а один год — 365 дней. Примеры: 1 минута — PT1M, 1 миллисекунда — PT0.001S. Дополнительные сведения см. в разделе https://www.w3.org/TR/xmlschema-2/#duration.
range	DateTimeRange	Минимальное и максимальное значения свойства метки времени события ($ts).

AvailabilityResponse

Ответ на операцию получения доступности. Если в среде нет данных, свойство доступности имеет значение NULL.

Имя	Тип	Описание
availability	Availability	Сведения о доступности событий, если среда содержит события. Если в среде еще нет данных, это свойство имеет значение NULL или отсутствует.

DateTimeRange

Диапазон времени. Не может иметь значение NULL или отрицательное значение.

Имя	Тип	Описание
from	string	Начальная метка времени диапазона времени. Метка времени запуска включается при использовании в запросах временных рядов. Включаются события с этой меткой времени.
to	string	Метка времени окончания диапазона времени. Конечная метка времени является монопольной при использовании в запросах временных рядов. События, соответствующие этой метке времени, исключаются. Обратите внимание, что метка времени окончания является инклюзивной, если она возвращается параметром Get Availability (это означает, что существует событие с точной меткой времени "to").

TsiError

Сведения об ошибке API.

Имя	Тип	Описание
error	TsiErrorBody	Определенная ошибка API с кодом ошибки и сообщением.

TsiErrorBody

Определенная ошибка API с кодом ошибки и сообщением.

Имя	Тип	Описание
code	string	Независимая от языка, читаемая человеком строка, определяющая код ошибки для конкретной службы. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Может использоваться для программной обработки конкретных случаев ошибок.
details	TsiErrorDetails[]	Содержит дополнительные сведения об ошибке. Может принимать значение NULL.
innerError	TsiErrorBody	Содержит более конкретную ошибку, которая сужает причину. Может принимать значение NULL.
message	string	Удобочитаемое, независимое от языка представление ошибки. Он предназначен для разработчиков и не подходит для воздействия на конечных пользователей.
target	string	Целевой объект конкретной ошибки (например, имя свойства в ошибке). Может принимать значение NULL.

TsiErrorDetails

Дополнительные сведения об ошибке.

Имя	Тип	Описание
code	string	Независимая от языка, читаемая человеком строка, определяющая код ошибки для конкретной службы. Этот код служит более конкретным индикатором для кода ошибки HTTP, указанного в ответе. Может использоваться для программной обработки конкретных случаев ошибок.
message	string	Удобочитаемое, независимое от языка представление ошибки. Он предназначен для разработчиков и не подходит для воздействия на конечных пользователей.

Query - Get Availability

Параметры URI

Заголовок запроса

Ответы

Безопасность

azure_auth

Scopes

Примеры

AvailabilityGet

Sample Request

Sample Response

AvailabilityGetEmpty

Sample Request

Sample Response

ColdStoreAvailabilityGet

Sample Request

Sample Response

WarmStoreAvailabilityGet

Sample Request

Sample Response

Определения

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

Дополнительные ресурсы