Compartir a través de

Time Series Instances - Execute Batch

  • Referencia
Servicio:
Time Series Insights
Versión de la API:
2020-07-31

Ejecuta una operación get, create, update, delete por lotes en varias instancias de serie temporal.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
environmentFqdn
 path True

string

Por FQDN de entorno, por ejemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Puede obtener este nombre de dominio de la respuesta de Get Environments API, Azure Portal o Azure Resource Manager.
api-version
 query True

string

Versión de la API que se va a usar con la solicitud de cliente. La versión admitida actualmente es "2020-07-31".

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-request-id

string

Identificador de solicitud de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de la operación entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a una solicitud determinada.
x-ms-client-session-id

string

Identificador de sesión de cliente opcional. El servicio registra este valor. Permite al servicio realizar un seguimiento de un grupo de operaciones relacionadas entre servicios y permite al cliente ponerse en contacto con el soporte técnico con respecto a un grupo determinado de solicitudes.

Cuerpo de la solicitud

Nombre Tipo Description
delete

InstancesRequestBatchGetOrDelete

Instancias de serie temporal que se van a eliminar. Se puede especificar el identificador o el nombre de la serie temporal.
get

InstancesRequestBatchGetOrDelete

Identificadores de serie temporal o nombres de instancias de serie temporal que se van a devolver.
put

TimeSeriesInstance[]

Instancias de serie temporal que se van a crear o actualizar.
update

TimeSeriesInstance[]

Instancia de serie temporal que se va a actualizar. Si la instancia no existe, se devuelve un error.

Respuestas

Nombre Tipo Description
200 OK

InstancesBatchResponse

Operación correcta.

Encabezados

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

TsiError

error inesperado.

Encabezados

x-ms-request-id: string

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

InstancesBatchDeleteByIds
InstancesBatchDeleteByNames
InstancesBatchGetByIds
InstancesBatchGetByNames
InstancesBatchPut
InstancesBatchUpdate

InstancesBatchDeleteByIds

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "put": [
    {
      "error": null
    }
  ]
}

InstancesBatchUpdate

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "update": [
    {
      "error": null
    }
  ]
}

Definiciones

Nombre Description
InstanceOrError

Resultado de una operación por lotes en una instancia de serie temporal determinada. El objeto de instancia se establece cuando la operación es correcta (excepto la operación put) y el objeto de error se establece cuando la operación no se realiza correctamente.
InstancesBatchRequest

Solicite realizar una sola operación en un lote de instancias. Debe establecerse exactamente uno de los elementos "get", "put", "update" o "delete".
InstancesBatchResponse

Respuesta de una sola operación en un lote de instancias. Solo se establecerá "get", "put", "update" o "delete" en función de la solicitud.
InstancesRequestBatchGetOrDelete

Solicite obtener o eliminar instancias por identificadores de serie temporal o nombres de serie temporal. Debe establecerse exactamente uno de los "timeSeriesIds" o "names".
TimeSeriesInstance

Las instancias de serie temporal son las propias series temporales. En la mayoría de los casos, deviceId o assetId funcionan como el identificador único del recurso en el entorno. Las instancias tienen información descriptiva asociada a ellos denominados campos de instancia. Como mínimo, los campos de instancia incluyen información de jerarquía. También pueden incluir datos útiles y descriptivos como el fabricante, el operador o la última fecha de servicio.
TsiError

Información sobre un error de API.
TsiErrorBody

Un error de API determinado con un código de error y un mensaje.
TsiErrorDetails

Información adicional sobre errores.

InstanceOrError

Object

Resultado de una operación por lotes en una instancia de serie temporal determinada. El objeto de instancia se establece cuando la operación es correcta (excepto la operación put) y el objeto de error se establece cuando la operación no se realiza correctamente.

Nombre Tipo Description
error

TsiErrorBody

Objeto error: se establece cuando la operación no se realiza correctamente.
instance

TimeSeriesInstance

Objeto de instancia de serie temporal: se establece cuando la operación se realiza correctamente (excepto put operation).

InstancesBatchRequest

Object

Solicite realizar una sola operación en un lote de instancias. Debe establecerse exactamente uno de los elementos "get", "put", "update" o "delete".

Nombre Tipo Description
delete

InstancesRequestBatchGetOrDelete

Instancias de serie temporal que se van a eliminar. Se puede especificar el identificador o el nombre de la serie temporal.
get

InstancesRequestBatchGetOrDelete

Identificadores de serie temporal o nombres de instancias de serie temporal que se van a devolver.
put

TimeSeriesInstance[]

Instancias de serie temporal que se van a crear o actualizar.
update

TimeSeriesInstance[]

Instancia de serie temporal que se va a actualizar. Si la instancia no existe, se devuelve un error.

InstancesBatchResponse

Object

Respuesta de una sola operación en un lote de instancias. Solo se establecerá "get", "put", "update" o "delete" en función de la solicitud.

Nombre Tipo Description
delete

TsiErrorBody[]

Lista de objetos de error correspondientes por posición a la matriz "delete" de la solicitud. Null significa que la instancia se ha eliminado o no existe. El objeto Error se establece cuando la operación no se realiza correctamente (por ejemplo, cuando hay eventos asociados a esta instancia de serie temporal).
get

InstanceOrError[]

Lista de objetos de instancia o error correspondientes por posición a la matriz "get" de la solicitud. El objeto de instancia se establece cuando la operación es correcta y el objeto de error se establece cuando la operación no se realiza correctamente.
put

InstanceOrError[]

Lista de objetos de error correspondientes por posición a la matriz "put" en la solicitud. El objeto Error se establece cuando la operación no se realiza correctamente.
update

InstanceOrError[]

Lista de objetos de error correspondientes por posición a la matriz "update" de la solicitud. El objeto de instancia se establece cuando la operación es correcta y el objeto de error se establece cuando la operación no se realiza correctamente.

InstancesRequestBatchGetOrDelete

Object

Solicite obtener o eliminar instancias por identificadores de serie temporal o nombres de serie temporal. Debe establecerse exactamente uno de los "timeSeriesIds" o "names".

Nombre Tipo Description
names

string[]

Lista de nombres de las instancias de serie temporal que se van a devolver o eliminar.
timeSeriesIds

TimeSeriesId[]

Lista de identificadores de serie temporal de las instancias de serie temporal que se van a devolver o eliminar.

TimeSeriesInstance

Object

Las instancias de serie temporal son las propias series temporales. En la mayoría de los casos, deviceId o assetId funcionan como el identificador único del recurso en el entorno. Las instancias tienen información descriptiva asociada a ellos denominados campos de instancia. Como mínimo, los campos de instancia incluyen información de jerarquía. También pueden incluir datos útiles y descriptivos como el fabricante, el operador o la última fecha de servicio.

Nombre Tipo Description
description

string

Este campo opcional contiene la descripción de la instancia.
hierarchyIds

string[]

Conjunto de identificadores de jerarquía de series temporales a los que pertenece la instancia. Su valor puede ser null.
instanceFields

Conjunto de pares clave-valor que contienen propiedades de instancia definidas por el usuario. Podría ser null. Los tipos de valor de propiedad admitidos son: bool, string, long, double y no se puede anidar o null.
name

string

Nombre opcional de la instancia que es única en un entorno. Los nombres actúan como alias mutable o nombre para mostrar de la instancia de serie temporal. Mutable, puede ser NULL.
timeSeriesId

TimeSeriesId[]

Identificador de serie temporal que identifica de forma única la instancia. Coincide con las propiedades de id. de serie temporal en un entorno. Inmutable, nunca null.
typeId

string

Representa el tipo al que pertenece esta instancia. Nunca es null.

TsiError

Object

Información sobre un error de API.

Nombre Tipo Description
error

TsiErrorBody

Un error de API determinado con un código de error y un mensaje.

TsiErrorBody

Object

Un error de API determinado con un código de error y un mensaje.

Nombre Tipo Description
code

string

Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código sirve como indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
details

TsiErrorDetails[]

Contiene información de error adicional. Su valor puede ser null.
innerError

TsiErrorBody

Contiene un error más específico que limita la causa. Su valor puede ser null.
message

string

Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.
target

string

Destino del error concreto (por ejemplo, el nombre de la propiedad en error). Su valor puede ser null.

TsiErrorDetails

Object

Información adicional sobre errores.

Nombre Tipo Description
code

string

Cadena legible e independiente del lenguaje que define un código de error específico del servicio. Este código sirve como indicador más específico para el código de error HTTP especificado en la respuesta. Se puede usar para controlar mediante programación casos de error específicos.
message

string

Representación independiente del idioma y legible del error. Está pensado como ayuda para los desarrolladores y no es adecuado para la exposición a los usuarios finales.