Time Series Instances - Execute Batch

Usługa:

Time Series Insights

Wersja interfejsu API:

2020-07-31

Wykonuje operację pobierania wsadowego, tworzenia, aktualizowania i usuwania w wielu wystąpieniach szeregów czasowych.

POST https://{environmentFqdn}/timeseries/instances/$batch?api-version=2020-07-31

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
environmentFqdn	path	True	string	Na nazwę FQDN środowiska, na przykład 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tę nazwę domeny można uzyskać z odpowiedzi interfejsu API pobierania środowisk, Azure Portal lub usługi Azure Resource Manager.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Obecnie obsługiwana wersja to "2020-07-31".

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string	Opcjonalny identyfikator żądania klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie operacji między usługami i umożliwia klientowi kontaktowanie się z pomocą techniczną dotyczącą konkretnego żądania.
x-ms-client-session-id		string	Opcjonalny identyfikator sesji klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie grupy powiązanych operacji w usługach i umożliwia klientowi kontaktowanie się z pomocą techniczną w odniesieniu do określonej grupy żądań.

Treść żądania

Nazwa	Typ	Opis
delete	InstancesRequestBatchGetOrDelete	Wystąpienia szeregów czasowych do usunięcia. Można określić identyfikator lub nazwę szeregów czasowych.
get	InstancesRequestBatchGetOrDelete	Identyfikatory szeregów czasowych lub nazwy wystąpień szeregów czasowych do zwrócenia.
put	TimeSeriesInstance[]	Wystąpienia szeregów czasowych do utworzenia lub zaktualizowania.
update	TimeSeriesInstance[]	Wystąpienie szeregów czasowych do zaktualizowania. Jeśli wystąpienie nie istnieje, zwracany jest błąd.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	InstancesBatchResponse	Operacja zakończona powodzeniem. Nagłówki x-ms-request-id: string
Other Status Codes	TsiError	Nieoczekiwany błąd. Nagłówki x-ms-request-id: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

InstancesBatchDeleteByIds

InstancesBatchDeleteByNames

InstancesBatchGetByIds

InstancesBatchGetByNames

InstancesBatchPut

InstancesBatchUpdate

InstancesBatchDeleteByIds

Przykładowe żądanie

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "delete": {
    "timeSeriesIds": [
      [
        "2da181d7-8346-4cf2-bd94-a17742237429",
        "T1"
      ],
      [
        "18672e3d-2beb-4007-9846-042b09ef3c72",
        "T2"
      ]
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchDeleteByNames

Przykładowe żądanie

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "delete": {
    "names": [
      "F2W6.GF",
      "F1W7.GS1"
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchGetByIds

Przykładowe żądanie

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "get": {
    "timeSeriesIds": [
      [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ]
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchGetByNames

Przykładowe żądanie

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "get": {
    "names": [
      "F1W7.GS1"
    ]
  }
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchPut

Przykładowe żądanie

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "put": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "put": [
    {
      "error": null
    }
  ]
}

InstancesBatchUpdate

Przykładowe żądanie

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "update": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "update": [
    {
      "error": null
    }
  ]
}

Definicje

Nazwa	Opis
InstanceOrError	Wynik operacji wsadowej dla określonego wystąpienia szeregów czasowych. Obiekt wystąpienia jest ustawiany, gdy operacja zakończy się powodzeniem (z wyjątkiem operacji put), a obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.
InstancesBatchRequest	Żądanie wykonania pojedynczej operacji na partii wystąpień. Należy ustawić dokładnie jedną z wartości "get", "put", "update" lub "delete".
InstancesBatchResponse	Odpowiedź pojedynczej operacji na partii wystąpień. Tylko jeden z "get", "put", "update" lub "delete" zostanie ustawiony na podstawie żądania.
InstancesRequestBatchGetOrDelete	Żądanie pobrania lub usunięcia wystąpień według identyfikatorów szeregów czasowych lub nazw szeregów czasowych. Należy ustawić dokładnie jedną z wartości "timeSeriesIds" lub "names".
TimeSeriesInstance	Wystąpienia szeregów czasowych to same szeregi czasowe. W większości przypadków identyfikator deviceId lub assetId jest unikatowym identyfikatorem zasobu w środowisku. Wystąpienia zawierają opisowe informacje skojarzone z nimi nazywane polami wystąpień. Co najmniej pola wystąpienia zawierają informacje o hierarchii. Mogą również zawierać przydatne, opisowe dane, takie jak producent, operator lub data ostatniej usługi.
TsiError	Informacje o błędzie interfejsu API.
TsiErrorBody	Określony błąd interfejsu API z kodem błędu i komunikatem.
TsiErrorDetails	Dodatkowe informacje o błędzie.

InstanceOrError

Wynik operacji wsadowej dla określonego wystąpienia szeregów czasowych. Obiekt wystąpienia jest ustawiany, gdy operacja zakończy się powodzeniem (z wyjątkiem operacji put), a obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.

Nazwa	Typ	Opis
error	TsiErrorBody	Obiekt error — ustawiany, gdy operacja nie powiedzie się.
instance	TimeSeriesInstance	Obiekt wystąpienia szeregów czasowych — ustawiany, gdy operacja zakończy się pomyślnie (z wyjątkiem operacji put).

InstancesBatchRequest

Żądanie wykonania pojedynczej operacji na partii wystąpień. Należy ustawić dokładnie jedną z wartości "get", "put", "update" lub "delete".

Nazwa	Typ	Opis
delete	InstancesRequestBatchGetOrDelete	Wystąpienia szeregów czasowych do usunięcia. Można określić identyfikator lub nazwę szeregów czasowych.
get	InstancesRequestBatchGetOrDelete	Identyfikatory szeregów czasowych lub nazwy wystąpień szeregów czasowych do zwrócenia.
put	TimeSeriesInstance[]	Wystąpienia szeregów czasowych do utworzenia lub zaktualizowania.
update	TimeSeriesInstance[]	Wystąpienie szeregów czasowych do zaktualizowania. Jeśli wystąpienie nie istnieje, zwracany jest błąd.

InstancesBatchResponse

Odpowiedź pojedynczej operacji na partii wystąpień. Tylko jeden z "get", "put", "update" lub "delete" zostanie ustawiony na podstawie żądania.

Nazwa	Typ	Opis
delete	TsiErrorBody[]	Lista obiektów błędów odpowiadających pozycji tablicy "delete" w żądaniu. Null oznacza, że wystąpienie zostało usunięte lub nie istnieje. Obiekt błędu jest ustawiany, gdy operacja nie powiedzie się (np. gdy występują zdarzenia skojarzone z tym wystąpieniem szeregów czasowych).
get	InstanceOrError[]	Lista obiektów wystąpień lub błędów odpowiadających pozycji tablicy "get" w żądaniu. Obiekt wystąpienia jest ustawiany, gdy operacja zakończy się pomyślnie, a obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.
put	InstanceOrError[]	Lista obiektów błędów odpowiadających pozycji tablicy "put" w żądaniu. Obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.
update	InstanceOrError[]	Lista obiektów błędów odpowiadających pozycji tablicy "update" w żądaniu. Obiekt wystąpienia jest ustawiany, gdy operacja zakończy się pomyślnie, a obiekt błędu jest ustawiany, gdy operacja nie powiedzie się.

InstancesRequestBatchGetOrDelete

Żądanie pobrania lub usunięcia wystąpień według identyfikatorów szeregów czasowych lub nazw szeregów czasowych. Należy ustawić dokładnie jedną z wartości "timeSeriesIds" lub "names".

Nazwa	Typ	Opis
names	string[]	Lista nazw wystąpień szeregów czasowych do zwrócenia lub usunięcia.
timeSeriesIds	TimeSeriesId[]	Lista identyfikatorów szeregów czasowych wystąpień szeregów czasowych, które mają zostać zwrócone lub usunięte.

TimeSeriesInstance

Wystąpienia szeregów czasowych to same szeregi czasowe. W większości przypadków identyfikator deviceId lub assetId jest unikatowym identyfikatorem zasobu w środowisku. Wystąpienia zawierają opisowe informacje skojarzone z nimi nazywane polami wystąpień. Co najmniej pola wystąpienia zawierają informacje o hierarchii. Mogą również zawierać przydatne, opisowe dane, takie jak producent, operator lub data ostatniej usługi.

Nazwa	Typ	Opis
description	string	To pole opcjonalne zawiera opis wystąpienia.
hierarchyIds	string[]	Zestaw identyfikatorów hierarchii szeregów czasowych, do których należy wystąpienie. Może mieć wartość null.
instanceFields		Zestaw par klucz-wartość, które zawierają właściwości wystąpienia zdefiniowanego przez użytkownika. Może to być wartość null. Obsługiwane typy wartości właściwości to: wartość logiczna, ciąg, długi, podwójny i nie może być zagnieżdżona ani mieć wartości null.
name	string	Opcjonalna nazwa wystąpienia, które jest unikatowe w środowisku. Nazwy działają jako modyfikowalny alias lub nazwa wyświetlana wystąpienia szeregów czasowych. Modyfikowalne, może mieć wartość null.
timeSeriesId	TimeSeriesId[]	Identyfikator szeregów czasowych, który jednoznacznie identyfikuje wystąpienie. Pasuje do właściwości identyfikatora szeregów czasowych w środowisku. Niezmienne, nigdy nie ma wartości null.
typeId	string	Reprezentuje typ, do którego należy to wystąpienie. Nigdy nie ma wartości null.

TsiError

Informacje o błędzie interfejsu API.

Nazwa	Typ	Opis
error	TsiErrorBody	Określony błąd interfejsu API z kodem błędu i komunikatem.

TsiErrorBody

Określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa	Typ	Opis
code	string	Ciąg czytelny dla języka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik dla kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
details	TsiErrorDetails[]	Zawiera dodatkowe informacje o błędzie. Może mieć wartość null.
innerError	TsiErrorBody	Zawiera bardziej szczegółowy błąd, który zawęża przyczynę. Może mieć wartość null.
message	string	Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie jest odpowiednia dla użytkowników końcowych.
target	string	Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie). Może mieć wartość null.

TsiErrorDetails

Dodatkowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Ciąg czytelny dla języka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik dla kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
message	string	Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie jest odpowiednia dla użytkowników końcowych.