你当前正在访问 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。可以从获取环境 API、Azure 门户或 Azure 资源管理器的响应中获取此域名。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。当前支持的版本为“2020-07-31”。
storeType	query		string	对于启用了暖存储的环境，可以在“WarmStore”或“ColdStore”上执行查询。查询中的此参数定义应对哪个存储执行查询。如果未定义，将对 Cold 存储区执行查询。

请求头

名称	必需	类型	说明
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

名称

类型

说明

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

示例请求

HTTP

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

示例请求

HTTP

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

示例响应

状态代码:: 200

{}

ColdStoreAvailabilityGet

示例请求

HTTP

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

示例请求

HTTP

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

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

名称	类型	说明
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	时间范围的结束时间戳。在时序查询请求中使用时，结束时间戳是独占的。排除与此时间戳匹配的事件。请注意，当获取可用性 (返回时，结束时间戳是包含的，这意味着) 具有此确切的“到”时间戳的事件。

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

作用域

示例

AvailabilityGet

示例请求

示例响应

AvailabilityGetEmpty

示例请求

示例响应

ColdStoreAvailabilityGet

示例请求

示例响应

WarmStoreAvailabilityGet

示例请求

示例响应

定义

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

其他资源