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 參數

名稱	位於	必要	類型	Description
environmentFqdn	path	True	string	每個環境 FQDN，例如 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' 上執行查詢。這個查詢中參數會定義應執行查詢的存放區。如果未定義，則會在冷存放區上執行查詢。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string	選擇性用戶端要求識別碼。服務會記錄此值。允許服務追蹤服務之間的作業，並允許客戶連絡有關特定要求的支持人員。
x-ms-client-session-id		string	選擇性用戶端會話識別碼。服務會記錄此值。允許服務追蹤跨服務的相關作業群組，並允許客戶連絡支持人員，以取得特定要求群組的相關信息。

回應

名稱	類型	Description
200 OK	AvailabilityResponse	成功的作業。標題 x-ms-request-id: string
Other Status Codes	TsiError	非預期的錯誤。標題 x-ms-request-id: string

名稱

類型

Description

200 OK

AvailabilityResponse

成功的作業。

標題

x-ms-request-id: string

Other Status Codes

TsiError

非預期的錯誤。

標題

x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
    }
  }
}

定義

名稱	Description
Availability	環境包含事件時的事件可用性資訊。包含事件的時間範圍，以及一段時間內事件的近似分佈。
AvailabilityResponse	取得可用性作業的回應。當環境沒有數據時，可用性屬性為 null。
DateTimeRange	時間範圍。不可以是 Null 或負數。
TsiError	API 錯誤的相關信息。
TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。
TsiErrorDetails	其他錯誤資訊。

Availability

環境包含事件時的事件可用性資訊。包含事件的時間範圍，以及一段時間內事件的近似分佈。

名稱	類型	Description
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。

名稱	類型	Description
availability	Availability	環境包含事件時的事件可用性資訊。當環境還沒有數據時，此屬性為 Null 或不存在。

DateTimeRange

時間範圍。不可以是 Null 或負數。

名稱	類型	Description
from	string	時間範圍的開始時間戳。在時間序列查詢要求中使用時，開始時間戳是包含的。包含具有此時間戳的事件。
to	string	時間範圍的結束時間戳。在時間序列查詢要求中使用結束時間戳是獨佔的。排除符合此時間戳的事件。請注意，Get Availability (傳回結束時間戳時會包含結束時間戳，這表示有一個事件具有這個確切的“to” 時間戳) 。

TsiError

API 錯誤的相關信息。

名稱	類型	Description
error	TsiErrorBody	具有錯誤碼和訊息的特定 API 錯誤。

TsiErrorBody

具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	與語言無關且人類可讀取的字串，可定義服務特定的錯誤碼。此程式代碼可作為回應中所指定 HTTP 錯誤碼的更特定指標。可用來以程式設計方式處理特定錯誤案例。
details	TsiErrorDetails[]	包含其他錯誤資訊。可能是 Null。
innerError	TsiErrorBody	包含更明確的錯誤，可縮小原因範圍。可能是 Null。
message	string	人類看得懂且與語言無關的錯誤表示法。它是開發人員的協助，不適合暴露給終端使用者。
target	string	例如，特定錯誤 (的目標為錯誤) 中的屬性名稱。可能是 Null。

TsiErrorDetails

其他錯誤資訊。

名稱	類型	Description
code	string	與語言無關且人類可讀取的字串，可定義服務特定的錯誤碼。此程式代碼可作為回應中所指定 HTTP 錯誤碼的更特定指標。可用來以程式設計方式處理特定錯誤案例。
message	string	人類看得懂且與語言無關的錯誤表示法。它是開發人員的協助，不適合暴露給終端使用者。

共用方式為

Query - Get Availability

URI 參數

要求標頭

回應

安全性

azure_auth

範圍

範例

AvailabilityGet

範例要求

範例回覆

AvailabilityGetEmpty

範例要求

範例回覆

ColdStoreAvailabilityGet

範例要求

範例回覆

WarmStoreAvailabilityGet

範例要求

範例回覆

定義

Availability

AvailabilityResponse

DateTimeRange

TsiError

TsiErrorBody

TsiErrorDetails

其他資源