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

環境ごとの FQDN (たとえば、10000000-0000-0000-0000-100000000109.env.timeseries.azure.com)。 このドメイン名は、Get Environments API、Azure portal、または Azure Resource Managerの応答から取得できます。
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

操作は成功しました。

Headers

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

TsiError

予期しないエラー。

Headers

x-ms-request-id: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

AvailabilityGet
AvailabilityGetEmpty
ColdStoreAvailabilityGet
WarmStoreAvailabilityGet

AvailabilityGet

Sample Request

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

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

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

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 の期間形式で指定されます。 1 か月は常に 30 日に変換され、1 年は常に 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

エラーの人間が判読できる言語に依存しない表現。 これは開発者の支援を目的としており、エンド ユーザーへの公開には適していません。