通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Query - Get Availability

服务:
Time Series Insights
API 版本:
2020-07-31

返回事件时间戳（$ts）的事件计数的时间范围和分布。 此 API 可用于提供导航到环境的登陆体验。

GET https://{environmentFqdn}/availability?api-version=2020-07-31
具有可选参数: 
GET https://{environmentFqdn}/availability?api-version=2020-07-31&storeType={storeType}

URI 参数

名称 在 必需 类型 说明
environmentFqdn
 path True

string

每个环境 FQDN，例如 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com。 可以从 Get Environments API、Azure 门户或 Azure 资源管理器的响应中获取此域名。
api-version
 query True

string

要用于客户端请求的 API 的版本。 当前支持的版本为“2020-07-31”。
storeType
 query

string

对于启用了暖存储的环境，可以在“WarmStore”或“ColdStore”上执行查询。 查询中的此参数定义应对其执行查询的存储。 如果未定义，查询将在冷存储上执行。

请求头

名称 必需 类型 说明
x-ms-client-request-id

string

可选的客户端请求 ID。 服务记录此值。 允许服务跨服务跟踪操作，并允许客户联系有关特定请求的支持人员。
x-ms-client-session-id

string

可选的客户端会话 ID。 服务记录此值。 允许服务跨服务跟踪一组相关操作，并允许客户联系有关特定请求组的支持人员。

响应

名称 类型 说明
200 OK

AvailabilityResponse

操作成功。

标头

x-ms-request-id: string
Other Status Codes

TsiError

意外错误。

标头

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

AvailabilityGet
AvailabilityGetEmpty
ColdStoreAvailabilityGet
WarmStoreAvailabilityGet

AvailabilityGet

示例请求

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

示例响应

状态代码:
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

示例请求

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

示例响应

状态代码:
200 
{}

ColdStoreAvailabilityGet

示例请求

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

示例响应

状态代码:
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

示例请求

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

示例响应

状态代码:
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"
    }
  }
}

定义

名称 说明
Availability

当环境包含事件时的事件可用性信息。 包含事件的时间范围和随时间推移事件的近似分布。
AvailabilityResponse

获取可用性操作的响应。 当环境没有数据时，可用性属性为 null。
DateTimeRange

时间范围。 不能为 null 或负值。
TsiError

有关 API 错误的信息。
TsiErrorBody

具有错误代码和消息的特定 API 错误。
TsiErrorDetails

其他错误信息。

Availability

Object

当环境包含事件时的事件可用性信息。 包含事件的时间范围和随时间推移事件的近似分布。

名称 类型 说明
distribution

object

intervalSize

string (duration)

事件的返回分布的间隔大小。 选择返回的间隔可返回合理的点数。 所有间隔的大小都相同。 以 ISO-8601 持续时间格式指定线路间隔。 一个月始终转换为 30 天，一年始终为 365 天。 示例：1 分钟为“PT1M”，1 毫秒为“PT0.001S”。 有关详细信息，请参阅 https://www.w3.org/TR/xmlschema-2/#duration
range

DateTimeRange

事件时间戳（$ts）属性的最小值和最大值。

AvailabilityResponse

Object

获取可用性操作的响应。 当环境没有数据时，可用性属性为 null。

名称 类型 说明
availability

Availability

当环境包含事件时的事件可用性信息。 当环境尚没有数据时，此属性为 null 或不存在。

DateTimeRange

Object

时间范围。 不能为 null 或负值。

名称 类型 说明
from

string (date-time)

时间范围的开始时间戳。 在时序查询请求中使用开始时间戳是非独占的。 包含此时间戳的事件。
to

string (date-time)

时间范围的结束时间戳。 在时序查询请求中使用结束时间戳是独占的。 排除与此时间戳匹配的事件。 请注意，Get Availability 返回时结束时间戳是非独占的（这意味着存在具有此确切“to”时间戳的事件）。

TsiError

Object

有关 API 错误的信息。

名称 类型 说明
error

TsiErrorBody

具有错误代码和消息的特定 API 错误。

TsiErrorBody

Object

具有错误代码和消息的特定 API 错误。

名称 类型 说明
code

string

独立于语言且可读的字符串，用于定义特定于服务的错误代码。 此代码用作响应中指定的 HTTP 错误代码的更具体的指示器。 可用于以编程方式处理特定错误案例。
details

TsiErrorDetails[]

包含其他错误信息。 可以为 null。
innerError

TsiErrorBody

包含更具体的错误，可缩小原因范围。 可以为 null。
message

string

人为可读的、与语言无关的错误表示形式。 它旨在帮助开发人员，不适合向最终用户公开。
target

string

特定错误的目标（例如，错误中属性的名称）。 可以为 null。

TsiErrorDetails

Object

其他错误信息。

名称 类型 说明
code

string

独立于语言且可读的字符串，用于定义特定于服务的错误代码。 此代码用作响应中指定的 HTTP 错误代码的更具体的指示器。 可用于以编程方式处理特定错误案例。
message

string

人为可读的、与语言无关的错误表示形式。 它旨在帮助开发人员，不适合向最终用户公开。