Aracılığıyla paylaş

Query - Get Availability

  • Başvuru
Service:
Time Series Insights
API Version:
2020-07-31

Olay sayısının zaman aralığını ve olay zaman damgası ($ts) üzerinden dağılımını döndürür. Bu API, ortama gitmek için giriş deneyimi sağlamak için kullanılabilir.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
environmentFqdn
 path True

string

Ortam başına FQDN, örneğin 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Bu etki alanı adını Get Environments API, Azure portal veya Azure Resource Manager yanıtından alabilirsiniz.
api-version
 query True

string

İstemci isteğiyle kullanılacak API sürümü. Şu anda desteklenen sürüm :"2020-07-31".
storeType
 query

string

Sıcak deponun etkinleştirildiği ortamlar için sorgu 'WarmStore' veya 'ColdStore' üzerinde yürütülebilir. Sorgudaki bu parametre, sorgunun hangi depoda yürütülmesi gerektiğini tanımlar. Tanımlanmamışsa sorgu soğuk depoda yürütülür.

İstek Başlığı

Name Gerekli Tür Description
x-ms-client-request-id

string

İsteğe bağlı istemci isteği kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında işlemi izlemesine ve müşterinin belirli bir istekle ilgili desteğe başvurmasına olanak tanır.
x-ms-client-session-id

string

İsteğe bağlı istemci oturum kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında bir grup ilgili işlemi izlemesine ve müşterinin belirli bir istek grubuyla ilgili desteğe başvurmasına olanak tanır.

Yanıtlar

Name Tür Description
200 OK

AvailabilityResponse

İşlem başarılı.

Headers

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

TsiError

Beklenmeyen hata.

Headers

x-ms-request-id: string

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name Description
Availability

Ortam olaylar içerdiğinde olay kullanılabilirliği bilgileri. Olayların zaman aralığını ve olayların zaman içindeki yaklaşık dağıtımını içerir.
AvailabilityResponse

Kullanılabilirliği Al işleminin yanıtı. Ortamda veri olmadığında kullanılabilirlik özelliği null olarak ayarlanır.
DateTimeRange

Zaman aralığı. Null veya negatif olamaz.
TsiError

API hatası hakkında bilgi.
TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.
TsiErrorDetails

Ek hata bilgileri.

Availability

Ortam olaylar içerdiğinde olay kullanılabilirliği bilgileri. Olayların zaman aralığını ve olayların zaman içindeki yaklaşık dağıtımını içerir.

Name Tür Description
distribution

object

intervalSize

string

Olayların döndürülen dağılımı için aralık boyutu. Makul sayıda puan döndürmek için döndürülen aralık seçilir. Tüm aralıklar aynı boyuttadır. Telde aralık ISO-8601 süre biçiminde belirtilir. Bir ay her zaman 30 güne dönüştürülür ve bir yıl her zaman 365 gündür. Örnekler: 1 dakika "PT1M", 1 milisaniye "PT0.001S" olur. Daha fazla bilgi için bkz. https://www.w3.org/TR/xmlschema-2/#duration.
range

DateTimeRange

Olay zaman damgası ($ts) özelliğinin en düşük ve en büyük değerleri.

AvailabilityResponse

Kullanılabilirliği Al işleminin yanıtı. Ortamda veri olmadığında kullanılabilirlik özelliği null olarak ayarlanır.

Name Tür Description
availability

Availability

Ortam olaylar içerdiğinde olay kullanılabilirliği bilgileri. Ortamda henüz veri olmadığında, bu özellik null veya mevcut değildir.

DateTimeRange

Zaman aralığı. Null veya negatif olamaz.

Name Tür Description
from

string

Zaman aralığının başlangıç zaman damgası. Başlangıç zaman damgası, zaman serisi sorgu isteklerinde kullanıldığında dahil edilir. Bu zaman damgasına sahip olaylar dahil edilir.
to

string

Zaman aralığının bitiş zaman damgası. Zaman serisi sorgu isteklerinde kullanıldığında bitiş zaman damgası özeldir. Bu zaman damgasıyla eşleşen olaylar dışlanır. Bitiş zaman damgasının Get Availability tarafından döndürülenler dahil olduğunu unutmayın (tam olarak "bitiş" zaman damgasına sahip bir olay olduğu anlamına gelir).

TsiError

API hatası hakkında bilgi.

Name Tür Description
error

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

Name Tür Description
code

string

Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details

TsiErrorDetails[]

Ek hata bilgileri içerir. Null olabilir.
innerError

TsiErrorBody

Nedeni daraltan daha belirli bir hata içerir. Null olabilir.
message

string

Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.
target

string

Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı). Null olabilir.

TsiErrorDetails

Ek hata bilgileri.

Name Tür Description
code

string

Hizmete özgü hata kodunu tanımlayan dilden bağımsız, okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha özel bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
message

string

Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardım amaçlıdır ve son kullanıcılara açıklanma için uygun değildir.